MCP
Overview
Model Context Protocol (MCP) is a standardization of how AI assistants interact with APIs, and ReadMe is bringing this capability to your developer hub. With MCP servers, you can convert your API documentation into a structured, resource that AI assistants can understand and interact with programmatically.
Key Features
- OpenAPI Integration: Generate an MCP server from your existing OpenAPI specification.
- AI assistants can connect to your MCP server to:
- Read and understand your OpenAPI spec.
- Execute API calls.
- Search docs with Owlbot.
- AI Tools Included:
- OpenAPI Tools:
Execute_request_body
- Make API calls directly from your specificationGet_endpoint
- Pull in detailed endpoint information on demandGet_request_body
- Access structured request parametersGet_response_schema
- Understand what your API returnsList_endpoints
- Browse all available API endpointsList_security_schemes
- Access authentication requirementsSearch_schema
- Find exactly what you need in your API spec
- Documentation Search:
search_documentation
- Leverage Owlbot to search your entire knowledge base
- OpenAPI Tools:
How It Works
We create a dedicated MCP server that connects to your OpenAPI specification and Owlbot search functionality. This creates a bridge between your API documentation and AI assistants, making your API instantly more accessible and understandable to AI tools.
Getting Started
You can share your MCP URL with your developers, and they can connect their AI assistants and tools directly to your API.
ReadMe hosts a remote MCP server at https://docs.readme.com/mcp
. Configure your AI development tools to connect to this server using your ReadMe API key.
Supported Versions 1.1
- Open Cursor Settings
- Navigate to "Tools & Integrations"
- Click "New MCP Server"
- Add the following to the config file.
{
"mcpServers": {
"ReadMeAPI": {
"url": "https://docs.readme.com/mcp"
}
}
}
- Save and close file.
If you want to execute API requests you will need to pass in an api key. You can use mcp-remote to do this. Update your mcp config to look like this
{ "mcpServers": { "readmeAPI": { "command": "npx", "args": [ "mcp-remote", "https://docs.readme.com/mcp", "--header", "Authorization: Bearer ${AUTH_TOKEN}" ], "env": { "AUTH_TOKEN": "rdme_xn..." } } } }
Alternatively (not recommended) you can add
?authorization=Bearer [YOUR_API_KEY]
to the URL. Replace[YOUR_API_KEY]
with your ReadMe API key encoded in base64.
Testing Your MCP Setup
Once configured, you can test your MCP server connection:
- Open your AI editor (Cursor, VS Code, etc.)
- Start a new chat with the AI assistant
- Ask about ReadMe - try questions like:
- "How do I [common use case]?"
- "Show me an example of [API functionality]"
- "Create a [integration type] using ReadMe"
The AI should now have access to your ReadMe account data and documentation through the MCP server.
Updated about 13 hours ago