Bring Api Documentation
to Windsurf
Create your Vinkius account to connect ReadMe to Windsurf 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 Windsurf?
Windsurf's Cascade agent chains multiple ReadMe tool calls autonomously. query data, analyze results, and generate code in a single agentic session. Paste Vinkius Edge URL, reload, and all 10 tools are immediately available. Real-time tool feedback appears inline, so you see API responses directly in your editor.
- —
Windsurf's Cascade agent autonomously chains multiple tool calls in sequence, solving complex multi-step tasks without manual intervention
- —
Purpose-built for agentic workflows. Cascade understands context across your entire codebase and integrates MCP tools natively
- —
JSON-based configuration means zero code changes: paste a URL, reload, and all 10 tools are immediately available
- —
Real-time tool feedback is displayed inline, so you see API responses directly in your editor without switching contexts
ReadMe in Windsurf
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 Windsurf 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 Windsurf
Every request between Windsurf 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.
How does Windsurf discover MCP tools?
Windsurf reads the mcp_config.json file on startup and connects to each configured server via Streamable HTTP. Tools are listed in the MCP panel and available to Cascade automatically.
Can Cascade chain multiple MCP tool calls?
Yes. Cascade is an agentic system. it can plan and execute multi-step workflows, calling several tools in sequence to accomplish complex tasks without manual prompting between steps.
Does Windsurf support multiple MCP servers?
Yes. Add as many servers as needed in mcp_config.json. Each server's tools appear in the MCP panel and Cascade can use tools from different servers in a single flow.
Server not connecting
Check Settings → MCP for the server status. Try toggling it off and on.
Explore More MCP Servers
View all →
Open Data Euskadi
2 toolsAccess the official open data portal of the Basque Government — search grants, contracts, news, and execute complex SPARQL queries on Linked Open Data.
CoinPaprika API
10 toolsAccess cryptocurrency data — audit coins, markets, and exchanges via AI.
EPA Envirofacts (Environmental Data)
6 toolsAccess US environmental data including UV forecasts, facility information, and toxic release inventories directly from the EPA.
Alegra Alternative
14 toolsAutomate cloud accounting via Alegra — issue invoices, manage contacts, track inventory, and monitor bank accounts from any AI agent.