AgentReady developer documentation

Use the public interfaces to scan a website, retrieve an evidence-backed Fix Pack, implement selected changes, and verify stable findings after deployment.

Versioned scan API

Canonical v1 endpoint for public website scans.

/api/v1/scan

Optional public reports

Explicitly publish an unlisted, expiring report and retrieve it with its opaque id.

/openapi.json

OpenAPI specification

Typed contract for the public REST API.

/openapi.json

API catalog

RFC 9727 machine-readable catalog of public interfaces.

/.well-known/api-catalog

MCP server

Scan URLs, retrieve Fix Packs, and verify fixes.

/api/mcp

Agent instructions

Safe actions, consent boundaries, and when to use AgentReady.

/agents.md

Agent index

Canonical product and machine-readable resource map.

/llms.txt

Audit skill

Installable workflow for evidence-backed agent-readiness audits.

/skills/agentready-audit/SKILL.md

Methodology

What the score measures, its limits, and how to interpret results.

/methodology

Deprecation policy

Version retirement notice and compatibility guarantees.

/deprecation-policy.md

CLI source package

Release-ready dependency-free CLI source; npm publication is pending.

https://github.com/msanchezgrice/agentready/tree/main/packages/cli

Authentication boundary

Public URL scans and MCP tools read public web content and require no authentication. Scans are not published by default. A user may explicitly create an unlisted report link containing public evidence; the link expires after 30 days. Private projects, repository connections, billing, and account changes stay in the authenticated web application and require the user.

Versioning and deprecation

New integrations should use /api/v1/scan. The unversioned /api/scan route remains a compatibility alias. If an API version is retired, AgentReady will announce it at least 180 days ahead and return standard Deprecation and Sunset headers during that window.