readme.com
ReadMe is a platform for building and hosting API documentation, reference content, and developer hubs. It also provides tooling for syncing docs, exposing docs to AI tools, and collecting developer experience metrics.
ReadMe exposes a REST API at https://api.readme.com/v2, a project MCP server surface, and two CLIs (`rdme` and `@readme/cli`); the REST API and `rdme` use a ReadMe project API key, while MCP and the newer CLI have unclear public auth mechanics in the retrieved docs.
- Project MCP Serverdiscovered
- ReadMe APIdiscovered
- rdme CLIdiscovered
- ReadMe CLIdiscovered
In your ReadMe project, create an API key from the API Reference area documented at Create an API key. The authentication guide at Authentication describes using this key with the ReadMe API. For CLI automation, the rdme docs and support thread indicate you can supply the same project API key to the CLI with --key alongside your project --id.
conventions · 0/8 published
- integrations.json✗
/.well-known/integrations.json - llms.txt✗
/llms.txt - API catalog✗
/.well-known/api-catalog - OpenAPI document✗
/api/schema/, /openapi.json, /swagger.json, /api/openapi.json, or /v1/openapi.json - MCP server card✗
/.well-known/mcp/server-card.json - OAuth protected resource✗
/.well-known/oauth-protected-resource - Agent card✗
/.well-known/agent-card.json - Agent skills✗
/.well-known/agent-skills/index.json
Publish these signals → /publishing