Where do I start as a developer?

Open the Quickstart — it walks you from API-key issuance to your first scan in under 60 seconds, with worked examples in curl, Node, Python, and MCP. From there, the Authentication guide covers how agents discover and use credentials, and the API & integrations page covers the full REST surface.

Should I use the REST API or the MCP server?

Both are first-class. Use the REST API directly from CI, scripts, or any HTTP client — install the `agent-ready-api` skill for a self-contained Agent Skill that wraps the workflow. Use the MCP server inside MCP-capable clients (Claude Desktop, Cursor, Cline, Continue, Goose) for tool-native invocation — install the `agent-ready-mcp` skill or run `npx -y agent-ready-mcp@latest`. The same Bearer key works for both surfaces.

Where is the OpenAPI spec?

OpenAPI 3.1 at https://agent-ready.dev/api/v1/openapi.json (aliased at /openapi.json). Use it with openapi-typescript, openapi-generator, or swagger-codegen to produce a typed client.

What does Agent Ready check?

Around 60 checks across the Vercel Agent Readability Spec, the llmstxt.org standard, and the agent-protocol manifests — MCP server cards (SEP-1649), A2A agent cards, agents.json, agent-permissions.json, UCP, x402, and NLWeb. See the Methodology page for every check, weight, and rating band.

The /api/v1/ask endpoint (NLWeb search over Agent Ready's docs) is public — no key required. Every other endpoint requires an Agent Ready Pro account. Free-tier users can run scans from the homepage (3 per IP per 30 days anonymous, 10 per 30 days signed in) but can't mint API keys.

Agent Ready developer documentation

Start here

Quickstart
First scan in under 60 seconds — curl, Node, Python, MCP. Get an API key, run POST /api/v1/scans, poll the result.
Authentication
How autonomous agents discover, register, use, and revoke credentials. Bearer tokens, OAuth Protected Resource Metadata (RFC 9728), WorkOS auth.md aligned.
Pricing
Free ($0) and Pro ($19/month) plans. REST API and MCP access ship with Pro — 10 req/min, 200 req/day, 50 scans/month.

REST API

Agent Ready API & integrations
REST API, MCP server, and GitHub Action reference. End-to-end examples for scan, poll, fetch, and CI/CD gating.
Agent Ready REST API reference
Interactive OpenAPI 3.1 reference — every endpoint, request and response schema, authentication requirement.
OpenAPI 3.1 spec (raw)
Machine-readable schema for codegen — openapi-typescript, openapi-generator, swagger-codegen.

MCP server

Agent Skills

Discovery and well-known files

Reference

Frequently asked questions

Where do I start as a developer?: Open the Quickstart — it walks you from API-key issuance to your first scan in under 60 seconds, with worked examples in curl, Node, Python, and MCP. From there, the Authentication guide covers how agents discover and use credentials, and the API & integrations page covers the full REST surface.
Should I use the REST API or the MCP server?: Both are first-class. Use the REST API directly from CI, scripts, or any HTTP client — install the `agent-ready-api` skill for a self-contained Agent Skill that wraps the workflow. Use the MCP server inside MCP-capable clients (Claude Desktop, Cursor, Cline, Continue, Goose) for tool-native invocation — install the `agent-ready-mcp` skill or run `npx -y agent-ready-mcp@latest`. The same Bearer key works for both surfaces.
Where is the OpenAPI spec?: OpenAPI 3.1 at https://agent-ready.dev/api/v1/openapi.json (aliased at /openapi.json). Use it with openapi-typescript, openapi-generator, or swagger-codegen to produce a typed client.
What does Agent Ready check?: Around 60 checks across the Vercel Agent Readability Spec, the llmstxt.org standard, and the agent-protocol manifests — MCP server cards (SEP-1649), A2A agent cards, agents.json, agent-permissions.json, UCP, x402, and NLWeb. See the Methodology page for every check, weight, and rating band.
Is API access free?: The /api/v1/ask endpoint (NLWeb search over Agent Ready's docs) is public — no key required. Every other endpoint requires an Agent Ready Pro account. Free-tier users can run scans from the homepage (3 per IP per 30 days anonymous, 10 per 30 days signed in) but can't mint API keys.