--- title: "ReadMe: agent-ready recipes | Agent Ready Checklist" description: "Every agent-ready recipe for ReadMe: 31 rows of the checklist, the version read, the date and the vendor documentation each step came from." canonical: https://agentreadychecklist.com/platforms/readme site: "Agent Ready Checklist" last_updated: 2026-11-05 section: "Platforms" --- # ReadMe: agent-ready recipes | Agent Ready Checklist > Every agent-ready recipe for ReadMe: 31 rows of the checklist, the version read, the date and the vendor documentation each step came from. Source: https://agentreadychecklist.com/platforms/readme Site: Agent Ready Checklist Last reviewed: 2026-11-05 Agent endpoints: https://agentreadychecklist.com/llms.txt (index), https://agentreadychecklist.com/openapi.json (API), https://agentreadychecklist.com/mcp (MCP server), https://agentreadychecklist.com/ask (search) Access: https://agentreadychecklist.com/auth.md (no key). Pricing: https://agentreadychecklist.com/pricing.md (free). # ReadMe: agent-ready recipes ReadMe: 31 recipes against the 31 checklist rows, read on 2026-11-04. ReadMe: 24 are direct, 7 are workarounds. ReadMe recipes cite the page they were derived from, or the specification when the step is generic. Version read for ReadMe: Hosted SaaS, docs read 2026-11-04. ## Version and documentation read Version Hosted SaaS, docs read 2026-11-04 Read on 2026-11-04 Recipes 24 direct, 7 workaround, 0 not possible on the platform robots.txt [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability). Content Signals toggles (training, search indexing, prompt context) in AI > AI Discoverability. Live docs.readme.com/robots.txt (2026-11-04) has User-agent: \*, Allow: /, Sitemap and Content-Signal lines. Sitemap No first-party doc: No sitemap page found in the ReadMe docs index on 2026-11-04; docs.readme.com/robots.txt references https://docs.readme.com/sitemap.xml, so one is generated. Structured data No first-party doc: No JSON-LD setting documented; one application/ld+json block was present on a live docs.readme.com page on 2026-11-04. Status codes [docs.readme.com/main/docs/error-pages](https://docs.readme.com/main/docs/error-pages). Default or custom 404 page and regex redirects (Pro and Enterprise). A missing path returned 404 on 2026-11-04; rapid fetches returned 429 on 2026-11-04 (Retry-After not checked). Headers and redirects [docs.readme.com/main/docs/error-pages](https://docs.readme.com/main/docs/error-pages). Redirects under Settings > Errors & Redirects with JavaScript-style regexes; Link headers toggle under AI Discoverability. Content negotiation [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability). Markdown for Agents toggle: Accept: text/markdown returns Markdown. Live 2026-11-04: text/markdown; charset=utf-8 and vary: Accept, Accept-Encoding. llms.txt [docs.readme.com/main/docs/llmstxt](https://docs.readme.com/main/docs/llmstxt). llms.txt on by default, generated from navigation; custom llms.txt from the repo root; Summarize Index option; markdown 404s for agents. OpenAPI [docs.readme.com/main/docs/openapi](https://docs.readme.com/main/docs/openapi). Upload OpenAPI to build the API Reference; API Catalog toggle publishes RFC 9727 /.well-known/api-catalog linking each spec. [The checklist table for ReadMe](https://agentreadychecklist.com/platform/readme/checklist/) shows every row with its first step. ## Verify with Ora ReadMe has a direct recipe for 24 rows, and Ora's catalogue (read 2026-11-05) names a matching check for 20 of them, among them AR-FIND-01, AR-FIND-03, AR-READ-01. After the steps are live, one audit shows which of those fixes the score picks up. ```bash npx ax@0.10 audit https://example.com --min-score 70 ``` 6 rows that Ora checks are a workaround or not possible on ReadMe: [AR-FIND-04](https://agentreadychecklist.com/checklist/ar-find-04/) (ai-catalog-published, workaround); [AR-READ-08](https://agentreadychecklist.com/checklist/ar-read-08/) (json-ld, workaround); [AR-READ-09](https://agentreadychecklist.com/checklist/ar-read-09/) (markdown-link-alternate, workaround); [AR-ACT-05](https://agentreadychecklist.com/checklist/ar-act-05/) (mcp-app-registry, workaround); [AR-ACT-08](https://agentreadychecklist.com/checklist/ar-act-08/) (x402-support, workaround); [AR-ACT-09](https://agentreadychecklist.com/checklist/ar-act-09/) (nlweb-ask, workaround). Ora scores the site as it stands, so a row the platform cannot satisfy stays open until the workaround is in place. Run it again with `--force` after a deploy, so the audit skips Ora's cache. [Gate deploys on it in CI](https://agentreadychecklist.com/guides/gate-deploys-on-agent-readiness-in-ci/), [why this site recommends Ora](https://agentreadychecklist.com/verify-with-ora/), [the crosswalk of rows and checks](https://agentreadychecklist.com/checklist/ora-checks/). ## Recipes, row by row ### [AR-FIND-01](https://agentreadychecklist.com/checklist/ar-find-01/): Do not block agentsrecipe Leave the generated robots.txt open. In AI > AI Discoverability set Content Signals instead of blocking crawlers. If you add a reverse proxy, do not add bot challenges in front of it. Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [AR-FIND-02](https://agentreadychecklist.com/checklist/ar-find-02/): Answers on one first-party pagerecipe Publish each answer once, as a page on your own domain. Put the fact (price, limit, version) in the page text, give the page one stable address, and link it from the home page and from llms.txt. Keep the page current: a second, older copy elsewhere on the site is the usual way an agent cites the wrong figure. Generic step from the AgentReady specification; not platform-specific. [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-FIND-03](https://agentreadychecklist.com/checklist/ar-find-03/): Sitemap listed in robots.txtrecipe Nothing to do: the generated robots.txt references /sitemap.xml (seen live on docs.readme.com, 2026-11-04). Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [AR-FIND-04](https://agentreadychecklist.com/checklist/ar-find-04/): AI Catalog at .well-knownworkaround No ai-catalog.json toggle. Turn on API Catalog (/.well-known/api-catalog) and MCP Server Card; serve ai-catalog.json from your main domain or a proxy. Read 2026-11-04. [docs.readme.com/main/docs/using-a-reverse-proxy](https://docs.readme.com/main/docs/using-a-reverse-proxy) ### [AR-READ-01](https://agentreadychecklist.com/checklist/ar-read-01/): Answer in the initial HTMLrecipe Guides render server-side; a plain curl returned page text in the HTML on 2026-11-04. Keep answers in Markdown blocks rather than custom JS widgets. Read 2026-11-04. [docs.readme.com/main/docs/editor-blocks](https://docs.readme.com/main/docs/editor-blocks) ### [AR-READ-02](https://agentreadychecklist.com/checklist/ar-read-02/): Real HTTP status codesrecipe Keep the default 404 (real 404 status) or pick a custom 404 page in Settings > Errors & Redirects; add regex redirects such as /old(/\\S\*)? -> /new$1 for moved pages. Read 2026-11-04. [docs.readme.com/main/docs/error-pages](https://docs.readme.com/main/docs/error-pages) ### [AR-READ-03](https://agentreadychecklist.com/checklist/ar-read-03/): Home page with real linksrecipe Build the hub landing page with real links to guides, the API Reference and pricing in the header and body sections. Read 2026-11-04. [docs.readme.com/main/docs/landing-page](https://docs.readme.com/main/docs/landing-page) ### [AR-READ-04](https://agentreadychecklist.com/checklist/ar-read-04/): Docs that answer agent tasksrecipe For each of your top five agent tasks, write a page that holds the steps as text, in order, with the exact names of the buttons, fields and settings. Steps that exist only in an image, a video or a script-built widget are not in the response a plain fetch receives. Fetch the page with curl and grep for the step. Generic step from the AgentReady specification; not platform-specific. [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-READ-05](https://agentreadychecklist.com/checklist/ar-read-05/): Fenced, language-tagged coderecipe Use the code block in the editor (or fenced Markdown in Raw Mode) and set the language for each tab. Read 2026-11-04. [docs.readme.com/main/docs/editor-blocks](https://docs.readme.com/main/docs/editor-blocks) ### [AR-READ-06](https://agentreadychecklist.com/checklist/ar-read-06/): Link the discovery filesrecipe Turn on Link Headers and Agent Hint Banner in AI > AI Discoverability; responses carry Link headers to api-catalog, agent-skills and the MCP server card (seen live 2026-11-04). Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [AR-READ-07](https://agentreadychecklist.com/checklist/ar-read-07/): Ship llms.txtrecipe llms.txt is on by default at /llms.txt. Optionally turn on Custom LLMs.txt and commit llms.txt at the repo root, or Summarize Index for large projects. Read 2026-11-04. [docs.readme.com/main/docs/llmstxt](https://docs.readme.com/main/docs/llmstxt) ### [AR-READ-08](https://agentreadychecklist.com/checklist/ar-read-08/): JSON-LD on key pagesworkaround No JSON-LD setting documented. Add a script in custom HTML (Custom Code) or inject it at a reverse proxy. Read 2026-11-04. [docs.readme.com/main/docs/using-a-reverse-proxy](https://docs.readme.com/main/docs/using-a-reverse-proxy) ### [AR-READ-09](https://agentreadychecklist.com/checklist/ar-read-09/): Advertise a markdown mirrorworkaround Pages answer Accept: text/markdown and .md URLs, but a tag is not documented; rely on Link headers and the Agent Hint Banner. Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [AR-READ-11](https://agentreadychecklist.com/checklist/ar-read-11/): Pricing as first-party HTMLrecipe Publish pricing as a guide page with plans and limits in text or a table block. Read 2026-11-04. [docs.readme.com/main/docs/editor-blocks](https://docs.readme.com/main/docs/editor-blocks) ### [AR-ACT-01](https://agentreadychecklist.com/checklist/ar-act-01/): Auth an agent can finishrecipe For docs behind sign-in, the platform's own OAuth route applies: For docs behind OAuth sign-in, set Discovery Type under Authentication and Access; keep None for public docs (endpoints then return 404). Derived from ReadMe's documentation read on 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) and [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-ACT-02](https://agentreadychecklist.com/checklist/ar-act-02/): OpenAPI contractrecipe Upload openapi.json (rdme CLI or GitHub Action) and turn on API Catalog so /.well-known/api-catalog links each spec. Read 2026-11-04. [docs.readme.com/main/docs/openapi](https://docs.readme.com/main/docs/openapi) ### [AR-ACT-03](https://agentreadychecklist.com/checklist/ar-act-03/): MCP over Streamable HTTPrecipe AI > MCP: toggle MCP Server on; share https://your-project.readme.io/mcp. Tools: list-endpoints, get-endpoint, search-endpoints, execute-request, search, fetch. Read 2026-11-04. [docs.readme.com/main/docs/mcp](https://docs.readme.com/main/docs/mcp) ### [AR-ACT-04](https://agentreadychecklist.com/checklist/ar-act-04/): MCP server cardrecipe Turn on the MCP Server Card setting; ReadMe publishes the card for its MCP server (its AR-FIND-04 recipe). Derived from ReadMe's documentation read on 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) and [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-ACT-05](https://agentreadychecklist.com/checklist/ar-act-05/): MCP Apps viewworkaround ReadMe generates its MCP server and server card from its AI discoverability settings. The documentation read lists no built-in feature for this row. Workaround: serve the ui:// resource from an MCP server you run on a subdomain or API domain you control (the AR-ACT-03 recipe, /platforms/readme/#ar-act-03). Derived from ReadMe's documentation read on 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) and [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-ACT-06](https://agentreadychecklist.com/checklist/ar-act-06/): SDKs and a CLIrecipe Publish the SDK and the CLI from the product's own repository to npm or PyPI; the website platform is not involved. Then show the install command and a first call on a page of your own site so that agents reading the site find them. Verify with curl -s https://registry.npmjs.org//latest. Generic step from the AgentReady specification; not platform-specific. [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-ACT-07](https://agentreadychecklist.com/checklist/ar-act-07/): WebMCP toolsrecipe Turn on WebMCP Tools in AI Discoverability; four tools (search, navigate, read current page, try an API endpoint) are exposed via navigator.modelContext. Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [AR-ACT-08](https://agentreadychecklist.com/checklist/ar-act-08/): Agent paymentsworkaround The documentation read lists no built-in feature for this row. Not possible on this platform without outside help. Workaround: run the paid endpoint on a subdomain or API domain you control, returning HTTP 402 with a payment payload on the paid path only (x402 or MPP), or a checkout handler, and link it from the docs. Put no CAPTCHA in front of a verified agent. Generic step from the AgentReady specification; not platform-specific. [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-ACT-09](https://agentreadychecklist.com/checklist/ar-act-09/): NLWeb /ask endpointworkaround The documentation read lists no built-in feature for this row. The documentation read lists no built-in feature for this row. Workaround: run the /ask endpoint on a subdomain or API domain you control, returning schema.org-shaped JSON for the query parameter, and link it from the docs. Mirror the same ask tool over MCP. Generic step from the AgentReady specification; not platform-specific. [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [AR-ACT-10](https://agentreadychecklist.com/checklist/ar-act-10/): An MCP server or a CLIrecipe A CLI meets AR-ACT-10 on any platform: publish it as described in the AR-ACT-06 recipe (/platforms/readme/#ar-act-06). An MCP server also meets it; how ReadMe hosts one is in the AR-ACT-03 recipe (/platforms/readme/#ar-act-03). Do not ship an empty surface to tick the box. Generic step from the AgentReady specification; not platform-specific. [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md) ### [CF-CONTENT-SIGNALS](https://agentreadychecklist.com/checklist/cf-content-signals/): Content-Signal linerecipe Set Model training, Search indexing and Prompt context under Content Signals; robots.txt gets a Content-Signal line. Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [CF-MARKDOWN-NEGOTIATION](https://agentreadychecklist.com/checklist/cf-markdown-negotiation/): Markdown by Acceptrecipe Turn on Markdown for Agents in AI > AI Discoverability; Accept: text/markdown then returns Markdown. Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [CF-PAY-PER-CRAWL](https://agentreadychecklist.com/checklist/cf-pay-per-crawl/): Pay per crawl, HTTP 402workaround Pay per crawl is a feature of Cloudflare AI Crawl Control, set per Cloudflare zone and in closed beta on 2026-11-04, so ReadMe does not set it, and a crawler is answered 402 only on a zone that has it. Not possible on this platform without outside help. Workaround: put the domain on a Cloudflare zone, where ReadMe allows a proxy or custom DNS in front, and set the price there. Test with curl -A "GPTBot/1.0". Derived from Cloudflare's pay per crawl documentation read on 2026-11-04. [developers.cloudflare.com/ai-crawl-control/features/pay-per-crawl/what-is-pay-per-crawl/](https://developers.cloudflare.com/ai-crawl-control/features/pay-per-crawl/what-is-pay-per-crawl/) and [developers.cloudflare.com/ai-crawl-control/features/pay-per-crawl/what-is-pay-per-crawl/](https://developers.cloudflare.com/ai-crawl-control/features/pay-per-crawl/what-is-pay-per-crawl/) ### [CF-OAUTH-DISCOVERY](https://agentreadychecklist.com/checklist/cf-oauth-discovery/): OAuth discovery filesrecipe For docs behind OAuth sign-in, set Discovery Type under Authentication and Access; keep None for public docs (endpoints then return 404). Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [CF-AGENT-SKILLS](https://agentreadychecklist.com/checklist/cf-agent-skills/): Agent Skills indexrecipe Turn on Agent Skills Index; ReadMe publishes /.well-known/agent-skills/index.json (Agent Skills Discovery v0.2.0). Read 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) ### [VERCEL-NEGOTIATION-HEADERS](https://agentreadychecklist.com/checklist/vercel-negotiation-headers/): Markdown headersrecipe Automatic with Markdown for Agents: live responses on 2026-11-04 carried text/markdown; charset=utf-8 and Vary: Accept. Read 2026-11-04. [docs.readme.com/main/docs/ai-ready-docs](https://docs.readme.com/main/docs/ai-ready-docs) ### [VERCEL-ROBOTS-EXCLUSIONS](https://agentreadychecklist.com/checklist/vercel-robots-exclusions/): Robots exclusionsrecipe Open the robots.txt that ReadMe serves for your site and read every Disallow; each one must have a reason you can state. How the file is produced here: Content Signals toggles (training, search indexing, prompt context) in AI > AI Discoverability. Live docs.readme.com/robots.txt (2026-11-04) has User-agent: \*, Allow: /, Sitemap and Content-Signal lines. Derived from ReadMe's documentation read on 2026-11-04. [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability) and [vercel.com/kb/guide/make-your-site-readable-by-ai-agents](https://vercel.com/kb/guide/make-your-site-readable-by-ai-agents) ## Vendors on this platform - [ReadMe](https://agentreadychecklist.com/vendors/readme/)Docs tool, 4 of 10 checklist rows read met by default ## Sources - [ora.ai/api/checks, contract 1.38.0](https://ora.ai/api/checks?utm_source=agentreadychecklist.com&utm_medium=referral&utm_campaign=platform)read 2026-11-05 - [registry.npmjs.org/ax, the ax README](https://registry.npmjs.org/ax)read 2026-11-05 - [docs.readme.com/main/docs/ai-discoverability](https://docs.readme.com/main/docs/ai-discoverability)read 2026-11-04 - [docs.readme.com/main/docs/error-pages](https://docs.readme.com/main/docs/error-pages)read 2026-11-04 - [docs.readme.com/main/docs/llmstxt](https://docs.readme.com/main/docs/llmstxt)read 2026-11-04 - [docs.readme.com/main/docs/openapi](https://docs.readme.com/main/docs/openapi)read 2026-11-04 - [github.com/agentready-org/standard/blob/main/spec/spec.md](https://github.com/agentready-org/standard/blob/main/spec/spec.md)read 2026-11-04 - [docs.readme.com/main/docs/using-a-reverse-proxy](https://docs.readme.com/main/docs/using-a-reverse-proxy)read 2026-11-04 - [docs.readme.com/main/docs/editor-blocks](https://docs.readme.com/main/docs/editor-blocks)read 2026-11-04 - [docs.readme.com/main/docs/landing-page](https://docs.readme.com/main/docs/landing-page)read 2026-11-04 - [docs.readme.com/main/docs/mcp](https://docs.readme.com/main/docs/mcp)read 2026-11-04 - [developers.cloudflare.com/ai-crawl-control/features/pay-per-crawl/what-is-pay-per-crawl/](https://developers.cloudflare.com/ai-crawl-control/features/pay-per-crawl/what-is-pay-per-crawl/)read 2026-11-04 - [docs.readme.com/main/docs/ai-ready-docs](https://docs.readme.com/main/docs/ai-ready-docs)read 2026-11-04 - [vercel.com/kb/guide/make-your-site-readable-by-ai-agents](https://vercel.com/kb/guide/make-your-site-readable-by-ai-agents)read 2026-11-04 Edition Data 2026-11-04 Reviewed 2026-11-05 Spec AgentReady v2.0, 273d2d7 Crawl 13,071 rows, 2026-11-04 Ora 132 checks, contract 1.38.0, 2026-11-05 Verify with Ora The scanner this site recommends for the whole checklist. 132 checks, a score out of 100, no account. `npx ax@0.10 audit --min-score ` [Why Ora, and its limits](https://agentreadychecklist.com/verify-with-ora/) Method - [How rows, commands and rates are made](https://agentreadychecklist.com/method/) - [How an Ora check is matched to a row](https://agentreadychecklist.com/checklist/ora-checks/) - [Pass rates by rank band](https://agentreadychecklist.com/data/by-rank/) Sources and read dates sit at the foot of the page. Last reviewed 2026-11-05. AgentReady v2.0, read 2026-11-04.