--- title: Developer documentation — Agent Ready description: Agent Ready developer documentation — REST API, MCP server, authentication, OpenAPI spec, skills.sh skills, GitHub repos, and the methodology behind every check. last_updated: 2026-09-02 canonical_url: https://agent-ready.dev/docs --- # Agent Ready developer documentation > Agent Ready developer documentation — REST API, MCP server, CLI, authentication, OpenAPI spec, installable Agent Skills, GitHub repos, and the methodology behind every check. Start here. ## Start here - [Quickstart](https://agent-ready.dev/quickstart) — first scan in under 60 seconds. Get an API key, POST to /api/v1/scans, poll the result. Worked examples in curl, Node, Python, and MCP JSON. - [Authentication](https://agent-ready.dev/auth) — how autonomous agents discover, register, use, and revoke credentials. Bearer tokens, OAuth Protected Resource Metadata (RFC 9728), WorkOS auth.md aligned. - [Pricing](https://agent-ready.dev/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](https://agent-ready.dev/docs/api) — 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](https://agent-ready.dev/docs/api/reference) — interactive OpenAPI 3.1 reference. Every endpoint, request schema, response schema, authentication requirement. - [OpenAPI 3.1 spec (raw)](https://agent-ready.dev/api/v1/openapi.json) — machine-readable schema for codegen (openapi-typescript, openapi-generator, swagger-codegen). Aliased at . Base URL: `https://agent-ready.dev/api/v1`. Auth: `Authorization: Bearer ar_live_...`. Endpoints: - `POST /api/v1/scans` — start a scan - `GET /api/v1/scans/{id}` — fetch scan status / result - `GET /api/v1/scans` — list past scans - `POST /api/v1/ask` — NLWeb-style search over Agent Ready docs (public, no key) - `POST /api/v1/mcp` — MCP streamable-HTTP endpoint ## MCP server - [MCP server setup](https://agent-ready.dev/mcp) — install guide for Claude Desktop, Claude Code, Cursor, Cline, VS Code, Windsurf. The hosted endpoint is `POST https://agent-ready.dev/api/v1/mcp` (POST only — a GET answers 405 `Allow: POST`, per the Streamable HTTP spec). Same Bearer key as REST. Exposes `scan_site`, `get_scan`, `ask` tools and `scan`, `interpret_scan`, `remediation_plan` prompts. - [MCP server card (SEP-2127)](https://agent-ready.dev/.well-known/mcp/server-card.json) — discovery JSON for one-click MCP install in Claude Desktop, Cursor, Cline, Continue, Goose. - [Agent Ready MCP server — GitHub](https://github.com/mlava/agent-ready-mcp) — MIT-licensed stdio MCP wrapper for the Agent Ready REST API. - [agent-ready-mcp on npm](https://www.npmjs.com/package/agent-ready-mcp) — install via `npx -y agent-ready-mcp@latest`. Works with any MCP client that speaks stdio. ## CLI - [agent-ready-scanner on npm](https://www.npmjs.com/package/agent-ready-scanner) — standalone, zero-dependency command-line client over the REST API. Installs the `agent-ready` command: `npx agent-ready-scanner scan ` or `npm i -g agent-ready-scanner`. - [Agent Ready CLI — GitHub](https://github.com/mlava/agent-ready-cli) — MIT-licensed source. Commands: `scan` (start + poll), `get`, `list`, and the public `ask`. Human-readable by default; `--json` for scripting. Same `ar_live_...` key as REST. ## Client SDKs Importable libraries for calling the REST API from your own code (vs the CLI, which you run from a terminal). Same `AgentReady` client shape across languages. - [agent-ready-client on npm](https://www.npmjs.com/package/agent-ready-client) — official JavaScript/TypeScript SDK. `npm install agent-ready-client`, then `import { AgentReady } from "agent-ready-client"`; methods `scan`/`getScan`/`listScans`/`ask`. Zero deps (Node 18+, Deno, Bun, edge, browser). - [agent-ready-client on PyPI](https://pypi.org/project/agent-ready-client/) — official Python SDK. `pip install agent-ready-client`, then `from agent_ready import AgentReady`. Pure standard library, type-hinted, Python 3.8+. - [Agent Ready SDKs — GitHub](https://github.com/mlava/agent-ready-sdk) — MIT-licensed monorepo (`js/` + `python/`). ## Agent Skills - [Agent Ready Skills — GitHub](https://github.com/mlava/agent-ready-skills) — installable Agent Skills repo. Two skills: `agent-ready-api` (REST workflow) and `agent-ready-mcp` (MCP setup + tool usage). - [Agent Ready Skills — skills.sh](https://www.skills.sh/mlava/agent-ready-skills) — canonical skills.sh listing; install both with `npx skills add mlava/agent-ready-skills`. - [agent-ready-api skill (skills.sh)](https://www.skills.sh/mlava/agent-ready-skills) — install with `npx skills add mlava/agent-ready-skills/skills/agent-ready-api`. - [agent-ready-mcp skill (skills.sh)](https://www.skills.sh/mlava/agent-ready-skills) — install with `npx skills add mlava/agent-ready-skills/skills/agent-ready-mcp`. - [agent-ready-cli skill (skills.sh)](https://www.skills.sh/mlava/agent-ready-skills) — one-command terminal scans via the `agent-ready` CLI; install with `npx skills add mlava/agent-ready-skills/skills/agent-ready-cli`. ## Editor plugins and agent configs Public, MIT-licensed repos that carry Agent Ready's agent configs and rules — editor and coding-agent integrations you can read and install. - [Agent Ready Cursor plugin — GitHub](https://github.com/mlava/agent-ready-cursor-plugin) — 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. Install from the Cursor Marketplace. - [Agent Ready Gemini extension — GitHub](https://github.com/mlava/agent-ready-gemini) — 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. - [Agent Ready Gemini extension — Gemini CLI directory](https://geminicli.com/extensions/?name=mlavaagent-ready-gemini) — 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](https://agent-ready.dev/.well-known/oauth-protected-resource) — RFC 9728 discovery document for the Bearer-token resource. Cross-links to the AS metadata document below. - [OAuth Authorization Server Metadata](https://agent-ready.dev/.well-known/oauth-authorization-server) — RFC 8414 + WorkOS auth.md `agent_auth` block (`register_uri`, identity types, credential types). - [api-catalog](https://agent-ready.dev/.well-known/api-catalog) — RFC 9727 linkset of every public API resource. - [agents.json](https://agent-ready.dev/.well-known/agents.json) — Wildcard agents.json manifest, OpenAPI-backed action list. - [agent-permissions.json](https://agent-ready.dev/.well-known/agent-permissions.json) — declared agent action permissions. - [A2A agent card](https://agent-ready.dev/.well-known/agent-card.json) — A2A v1.0.0 capability and skill discovery. ## Reference - [Methodology](https://agent-ready.dev/methodology) — every one of the ~72 checks Agent Ready runs, with weights, rating bands, and rationale. - [Glossary](https://agent-ready.dev/glossary) — plain-language definitions of llms.txt, AGENTS.md, MCP, A2A, content negotiation, and the rest of the vocabulary. - [The complete guide to agent readability](https://agent-ready.dev/complete-guide-to-agent-readability) — definitive hub guide on how AI agents discover, parse, and cite your site. ## 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 72 checks across the Vercel Agent Readability Spec, the llmstxt.org standard, and the agent-protocol manifests — MCP server cards (SEP-2127), A2A agent cards, agents.json, agent-permissions.json, UCP, x402, and NLWeb — plus a separate accessibility sub-score from 23 WCAG 2.2 and layout-stability checks over the homepage. 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. --- Run a scan: Source for these skills and the MCP wrapper: ## Sitemap See the full [sitemap](https://agent-ready.dev/sitemap.md) for all pages on agent-ready.dev.