Auto-Generate Your MCP Server

With ReadMe, every project automatically includes a fully configured MCP server. Simply enable MCP to connect your API documentation to AI tools.

How to Generate Your Own MCP Server

In Edit Mode, in the top left-hand corner, click ✨AI to open up the side panel. Select MCP and toggle MCP Server to activate your MCP server. Your MCP URL will be: https://your-project.readme.io/mcp. You can share your MCP URL with your developers, and they can connect their AI assistants and tools directly to your API.

The AI should now have access to your ReadMe account data and documentation through the MCP server.

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 your API & docs. Try these questions:
- "How do I [common use case]?"
- "Show me an example of [API functionality]"
- "Create a [integration type] using [your API]

How to Generate Access Instructions For Your Users

Once you have activated your MCP server, can automatically generate access instructions for your end-users by clicking the "Generate MCP Template" button. This creates a new unpublished doc called "MCP" in your Guides showing how to connect to your MCP server in tools such as Cursor and Claude Desktop. You can find the doc at the bottom of your Guides or API Reference in a new category called "MCP SERVER."