ReadMe
PlatformPublish developer guides and interactive API references from OpenAPI
- Access
- ReadMe API key for API and CLI
About
ReadMe hosts developer documentation with guides, interactive API references and Git sync. Its API and rdme CLI can publish pages and OpenAPI definitions. ReadMe also offers a hosted MCP server for authors to search and update their own documentation.
What you can do with it
- Publish an interactive API reference from an OpenAPI definition
- Keep Markdown guides in sync with a docs repository or CI pipeline
- Let an AI assistant search and update ReadMe pages through the author MCP server
Get started
- Create a ReadMe project and generate an API key in its dashboard
- Write guides or an OpenAPI definition, or connect a repository for Git sync
- Use rdme for one-way uploads when your project does not use Git sync
Example
npx rdme@10 openapi upload ./openapi.yaml --key="$README_API_KEY"Details
- Hosting
- Hosted service
- Available in
- Worldwide
- MCP server
- Remote