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
MCP server endpoint
Streamable-HTTP MCP endpoint. Same Bearer token as REST; exposes scan_site, get_scan, ask tools.
MCP server card (SEP-1649)
Discovery JSON for one-click MCP install in Claude Desktop, Cursor, Cline, Continue, Goose.
Agent Ready MCP server — GitHub↗
MIT-licensed stdio MCP wrapper for the Agent Ready REST API. npm: agent-ready-mcp.
agent-ready-mcp on npm↗
Install via npx -y agent-ready-mcp@latest. Works with any MCP client that speaks stdio.
CLI
agent-ready-scanner on npm↗
Standalone CLI over the REST API — scan, get, list, ask. Installs the `agent-ready` command. npx agent-ready-scanner scan <url>.
Agent Ready CLI — GitHub↗
MIT-licensed, zero-dependency command-line client. Human-readable by default, --json for scripting; same ar_live_ key as REST.
Client SDKs
agent-ready-client on npm↗
Official JavaScript/TypeScript client SDK. npm install agent-ready-client, then import { AgentReady } and call scan/getScan/listScans/ask. Zero deps; Node 18+, Deno, Bun, edge, browser.
agent-ready-client on PyPI↗
Official Python client SDK. pip install agent-ready-client, then from agent_ready import AgentReady. Pure standard library, type-hinted, Python 3.8+.
Agent Ready SDKs — GitHub↗
MIT-licensed monorepo for the official client SDKs (JS/TS + Python). Same AgentReady client shape across languages, generated against the OpenAPI spec.
Agent Skills
Agent Ready Skills — GitHub↗
Installable Agent Skills repo. Two skills: agent-ready-api (REST workflow) and agent-ready-mcp (MCP setup + tool usage).
agent-ready-api skill (skills.sh)↗
Self-contained skill for using the REST API. Install: npx skills add mlava/agent-ready-skills/skills/agent-ready-api.
agent-ready-mcp skill (skills.sh)↗
Self-contained skill for installing and using the MCP server. Install: npx skills add mlava/agent-ready-skills/skills/agent-ready-mcp.
agent-ready-cli skill (skills.sh)↗
Self-contained skill for one-command terminal scans via the agent-ready CLI. Install: npx skills add mlava/agent-ready-skills/skills/agent-ready-cli.
Editor plugins and agent configs
Agent Ready Cursor plugin — GitHub↗
Agent Ready as a Cursor plugin — a Cursor rule (rules/agent-ready.mdc), an MCP server config (mcp.json), and a skill that wire scanning into Cursor. Public, MIT-licensed; install from the Cursor Marketplace.
Agent Ready Gemini extension — GitHub↗
Agent Ready as a Gemini CLI extension / Antigravity plugin — a GEMINI.md agent config plus /agent-ready:* slash commands over the published MCP server and CLI. Public, MIT-licensed.
Agent Ready Gemini extension — Gemini CLI directory↗
The extension's official listing in Google's Gemini CLI extensions directory — browse and install Agent Ready straight from the Gemini CLI catalog.
Discovery and well-known files
OAuth Protected Resource Metadata
RFC 9728 discovery document for the Bearer-token resource.
OAuth Authorization Server Metadata
RFC 8414 + WorkOS auth.md agent_auth block (register_uri, identity types, credential types).
api-catalog
RFC 9727 linkset of every public API resource.
agents.json
Wildcard agents.json manifest — OpenAPI-backed action list.
Reference
Methodology
Every one of the ~68 checks Agent Ready runs, with weights, rating bands, and rationale.
Glossary
Plain-language definitions of llms.txt, AGENTS.md, MCP, A2A, content negotiation, and the rest of the vocabulary.
Complete guide to agent readability
Definitive hub guide — how AI agents discover, parse, and cite your site across discovery, structure, and protocol layers.
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 68 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.