AgentsReady
Readiness index · #410 of 1846

readme.com

Run the agent liveReport a change
57Readiness score / 100
L2 Agent-documentedBeats 77% of 1,846 companies
Access20/20
Context11/20
Interfaces20/32
Onboarding3/19
Trust3/9
llms.txt · root
MCP · https://docs.readme.com/mcp

Biggest gains

  1. +8 Machine-readable API spec. Publish an OpenAPI spec at a stable URL like /openapi.json and link it from llms.txt.
  2. +6 Docs available as markdown. Serve every docs page as .md, or honour Accept: text/markdown.
  3. +6 Agents can self-register OAuth clients. Support dynamic client registration (RFC 7591) or client ID metadata documents so MCP clients connect in one click.
All 20 checks
  • PASSAgents get the real page, not a bot wall10
  • PASSrobots.txt lets user-triggered agents in6
  • PASSContent is server-rendered4
  • PASSllms.txt exists8
  • FAILllms-full.txt exists3
  • FAILDocs available as markdown6
  • PASSSitemap2
  • PASSStructured metadata1
  • FAILPublic developer docs4
  • FAILMachine-readable API spec8
  • PASSRemote MCP server for the product12
  • PASSDocs MCP or searchable docs4
  • PASSSDKs and a CLI4
  • FAILOAuth discovery metadata5
  • FAILAgents can self-register OAuth clients6
  • FAILSelf-serve API keys5
  • PASSFree tier or test mode3
  • FAILAgent manifests4
  • FAILsecurity.txt2
  • PASSPublic status page3

Your fix pack: 10 changes, up to +43 points

Each change is ready to paste, filled in for readme.com, with a command to check it worked. Or hand the whole list to your coding agent.

An OpenAPI spec is the contract agents and SDK generators build against. Without it they guess from prose.

Where: https://readme.com/openapi.json, linked from llms.txt and the API reference
// Serve the spec your API framework already generates (FastAPI: /openapi.json is built in).
// Next.js: app/openapi.json/route.ts
import spec from "@/openapi/openapi.json";
export const GET = () => Response.json(spec, { headers: { "Access-Control-Allow-Origin": "*" } });

// Every operation needs: operationId, summary, description, request/response examples,
// and the auth scheme (components.securitySchemes) so agents know how to send the key.
Check it worked:curl -s https://readme.com/openapi.json | head -c 200

Add the badge to your README

AgentsReady badge for readme.com
[![AgentsReady](https://agentsready.dev/badge/readme.com)](https://agentsready.dev/c/readme.com)