ReadMe's MCP Server
With ReadMe's MCP server, you can do everything you normally would in ReadMe, like adding and editing pages, directly through our API.
Setting Up ReadMe's MCP Server
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: ${AUTH_HEADER}" ], "env": { "AUTH_HEADER": "Bearer rdme_xn..." } } } }
Note: Cursor and Claude Desktop (Windows) have a bug where spaces inside args aren't escaped when it invokes
npx
, simply remove the whitespace after 'Authorization:
' to work around this bug.
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"
Updated about 6 hours ago