readme.io
ReadMe is a platform for building and hosting product and API documentation, including API reference, changelogs, guides, and developer experience features. It also offers AI-related documentation features such as MCP access to docs and API specs.
ReadMe exposes two documented HTTP API surfaces for project/docs management (legacy v1 with OpenAPI and newer v2) plus documentation for an MCP server; no public GraphQL API or CLI was found.
- ReadMe MCP Serverdiscovered
- ReadMe APIdiscovered
- ReadMe API v2discovered
In your ReadMe project, create an API key from the API Keys endpoints/docs. ReadMe's auth docs state API keys are used for integrations with the ReadMe API, and the v2 upgrade guide shows requests using Authorization: Bearer {your-api-key}. Start from Authentication or Intro to the ReadMe API.
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