Bring Api Documentation
to Cursor
Create your Vinkius account to connect ReadMe to Cursor and start using all 10 AI tools in minutes. Fully managed, enterprise secure, and ready to use without writing a single line of code. No hosting, no server setup — just connect and start using.
GDPR Free for SubscribersCompatible with every major AI agent and IDE
Gemini
What is the ReadMe MCP Server?
Connect your ReadMe documentation hub directly to your AI agent. Enabling this integration turns your AI into an expert technical writer and reader, capable of instantly scanning your entire developer documentation, changelogs, and custom pages without context switching.
What you can do
- Documentation Search — Perform full-text searches across all your published guides and API references.
- Content Retrieval — Fetch the exact Markdown content of any specific documentation page, changelog, or category.
- Project Analysis — Understand how your documentation is categorized and structure new content accordingly.
- Changelog Tracking — Pull recent product updates and announcements formally published to your users.
How it works
- Authorize the ReadMe MCP server in your environment.
- Provide your ReadMe API Key (found under your project's Configuration settings).
- Ask your AI to summarize a specific API endpoint's documentation or list recent changelogs directly from your chat.
Who is this for?
- Developer Advocates — Verify the accuracy of published guides and quickly draft new content referencing existing structures.
- Technical Writers — Search and audit current documentation for outdated references without leaving your code editor.
- Software Engineers — Instantly pull your company's official API documentation into your IDE to ensure your code aligns with published standards.
Built-in capabilities (10)
Retrieves details for a specific documentation category
Lists all documentation pages under a specific category
Retrieves the full content of a specific changelog post
Retrieves the full content of a custom page
Retrieves the full content of a documentation page
Retrieves details about the ReadMe project
Lists all documentation categories on ReadMe
Lists all changelog posts
Lists all custom standalone pages
Performs a full-text search across all documentation pages
Why Cursor?
Cursor's Agent mode turns ReadMe into an in-editor superpower. Ask Cursor to generate code using live data from ReadMe and it fetches, processes, and writes. all in a single agentic loop. 10 tools appear alongside file editing and terminal access, creating a unified development environment grounded in real-time information.
- —
Agent mode turns Cursor into an autonomous coding assistant that can read files, run commands, and call MCP tools without switching context
- —
Cursor's Composer feature can generate entire files using real-time data fetched through MCP. no copy-pasting from external dashboards
- —
MCP tools appear alongside built-in tools like file reading and terminal access, creating a unified agentic environment
- —
VS Code extension compatibility means your existing workflow, keybindings, and extensions all work alongside MCP tools
ReadMe in Cursor
Why run ReadMe with Vinkius?
The ReadMe connection runs on our fully managed, secure cloud infrastructure. We handle the hosting, maintenance, and security so you don't have to deal with servers or code. All 10 tools are ready to work instantly without any complex setup.
You stay in complete control of your data. Your AI only accesses the information you approve, keeping your sensitive passwords and private details completely safe. Plus, with automatic optimizations, your AI works faster and more efficiently.
* Every connection is hosted and maintained by Vinkius. We handle the security, updates, and infrastructure so you don't have to write code or manage servers. See our infrastructure
Over 4,000 integrations ready for AI agents
Explore a vast library of pre-built integrations, optimized and ready to deploy.
Connect securely in under 30 seconds
Generate tokens to authenticate and link external services in a single step.
Complete visibility into every agent action
Audit live requests, latency, success rates, and active security compliance policies.
Optimize spending and track token ROI
Analyze real-time token consumption and cost metrics detailed by connection.
Explore our live AI Agents Analytics dashboard to see it all working
This dashboard is included when you connect ReadMe using Vinkius. You will never be left in the dark about what your AI agents are doing with your tools.
ReadMe and 4,000+ other AI tools. No hosting, no code, ready to use.
Professionals who connect ReadMe to Cursor through Vinkius don't need to write code, manage servers, or worry about security. Everything is pre-configured, secure, and runs automatically in the background.
Raw MCP | Vinkius | |
|---|---|---|
| Ready-to-use MCPs | Find and configure each manually | 4,000+ MCPs ready to use |
| Connection Setup | Manual coding & server setup | 1-click instant connection |
| Server Hosting | You host it yourself (needs 24/7 uptime) | 100% hosted & managed by Vinkius |
| Security & Privacy | Stored in plaintext config files | Bank-grade encrypted vault |
| Activity Visibility | Blind execution (no logs or tracking) | Live dashboard with real-time logs |
| Cost Control | Runaway AI token spend risk | Automatic budget limits |
| Revoking Access | Must delete files or code to stop | 1-click disconnect button |
How Vinkius secures
ReadMe for Cursor
Every request between Cursor and ReadMe is protected by our secure gateway. We automatically keep your sensitive data private, prevent unauthorized access, and let you disconnect instantly at any time.
Frequently asked questions
Where do I obtain my ReadMe API Key?
Log into your ReadMe dashboard. Navigate to your specific project, then open 'Configuration' and click on 'API Key'. You will use this key as the authentication parameter (our integration handles it natively as a Basic Auth username).
Does the server allow me to write or edit documentation?
Currently, the MCP server is focused on read-only operations. It can query, retrieve, and search changelogs, custom pages, and standard documentation categories, bringing context to the AI securely without risking accidental overwrites.
In what format is the document content returned?
All text and page content uses native Markdown format directly fetched from ReadMe's engine. This makes it perfect for the AI to interpret, syntax-highlight, and display naturally within chat or code comments.
What is Agent mode and why does it matter for MCP?
Agent mode is Cursor's autonomous execution mode where the AI can perform multi-step tasks: reading files, editing code, running terminal commands, and calling MCP tools. Without Agent mode, Cursor operates in a simpler ask-and-answer mode that doesn't support tool calling. Always ensure you're in Agent mode when working with MCP servers.
Where does Cursor store MCP configuration?
Cursor looks for MCP server configurations in a mcp.json file. You can configure servers at the project level (.cursor/mcp.json in your project root) or globally (~/.cursor/mcp.json). Project-level configs take precedence.
Can Cursor use MCP tools in inline edits?
No. MCP tools are only available in Agent mode through the chat panel. Inline completions and Tab suggestions do not trigger MCP tool calls. This is by design. tool calls require user visibility and approval.
How do I verify MCP tools are loaded?
Open Settings → Features → MCP and look for your server name. A green indicator means the server is connected. You can also check Agent mode's available tools by clicking the tools dropdown in the chat panel.
Tools not appearing in Cursor
Ensure you are in Agent mode (not Ask mode). MCP tools only work in Agent mode.
Server shows as disconnected
Check Settings → Features → MCP and verify the server status. Try clicking the refresh button.
Explore More MCP Servers
View all →
News
3 toolsSearch millions of articles and track breaking headlines from over 150,000 global news sources in real-time.
BLS Labor Force — National Unemployment & CPS
2 toolsAccess Current Population Survey (CPS) data. Easily query national unemployment rates, labor force participation, and detailed demographic breakdowns at the push of a button.
Miro (Visual Collaboration & Whiteboarding)
8 toolsManage collaborative boards via Miro — create sticky notes, list visual items, and audit team members.
Gusto
10 toolsManage employees, run payroll, view benefits and time-off policies — HR automation for AI agents.