ReadMe MCP Server for Windsurf 10 tools — connect in under 2 minutes
Windsurf brings agentic AI coding to a purpose-built IDE. Connect ReadMe through Vinkius and Cascade will auto-discover every tool. ask questions, generate code, and act on live data without leaving your editor.
ASK AI ABOUT THIS MCP SERVER
Vinkius supports streamable HTTP and SSE.
Vinkius Desktop App
The modern way to manage MCP Servers — no config files, no terminal commands. Install ReadMe and 2,500+ MCP Servers from a single visual interface.
{
"mcpServers": {
"readme": {
"url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
}
}
}
* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure
About 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.
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.
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.
The ReadMe MCP Server exposes 10 tools through the Vinkius. Connect it to Windsurf in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.
How to Connect ReadMe to Windsurf via MCP
Follow these steps to integrate the ReadMe MCP Server with Windsurf.
Open MCP Settings
Go to Settings → MCP Configuration or press Cmd+Shift+P and search "MCP"
Add the server
Paste the JSON configuration above into mcp_config.json
Save and reload
Windsurf will detect the new server automatically
Start using ReadMe
Open Cascade and ask: "Using ReadMe, help me...". 10 tools available
Why Use Windsurf with the ReadMe MCP Server
Windsurf provides unique advantages when paired with ReadMe through the Model Context Protocol.
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 + Windsurf Use Cases
Practical scenarios where Windsurf combined with the ReadMe MCP Server delivers measurable value.
Automated code generation: ask Cascade to fetch data from ReadMe and generate models, types, or handlers based on real API responses
Live debugging: query ReadMe tools mid-session to inspect production data while debugging without leaving the editor
Documentation generation: pull schema information from ReadMe and have Cascade generate comprehensive API docs automatically
Rapid prototyping: combine ReadMe data with Cascade's code generation to scaffold entire features in minutes
ReadMe MCP Tools for Windsurf (10)
These 10 tools become available when you connect ReadMe to Windsurf via MCP:
get_category
Retrieves details for a specific documentation category
get_category_docs
Lists all documentation pages under a specific category
get_changelog
Retrieves the full content of a specific changelog post
get_custom_page
Retrieves the full content of a custom page
get_doc
Retrieves the full content of a documentation page
get_project
Retrieves details about the ReadMe project
list_categories
Lists all documentation categories on ReadMe
list_changelogs
Lists all changelog posts
list_custom_pages
Lists all custom standalone pages
search_docs
Performs a full-text search across all documentation pages
Example Prompts for ReadMe in Windsurf
Ready-to-use prompts you can give your Windsurf agent to start working with ReadMe immediately.
"Search the documentation for instructions on configuring webhooks."
"Get the contents of the changelog titled 'v2-api-release'."
"List all main documentation categories."
Troubleshooting ReadMe MCP Server with Windsurf
Common issues when connecting ReadMe to Windsurf through the Vinkius, and how to resolve them.
Server not connecting
ReadMe + Windsurf FAQ
Common questions about integrating ReadMe MCP Server with Windsurf.
How does Windsurf discover MCP tools?
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?
Does Windsurf support multiple MCP servers?
mcp_config.json. Each server's tools appear in the MCP panel and Cascade can use tools from different servers in a single flow.Connect ReadMe with your favorite client
Step-by-step setup guides for every MCP-compatible client and framework:
Anthropic's native desktop app for Claude with built-in MCP support.
AI-first code editor with integrated LLM-powered coding assistance.
GitHub Copilot in VS Code with Agent mode and MCP support.
Purpose-built IDE for agentic AI coding workflows.
Autonomous AI coding agent that runs inside VS Code.
Anthropic's agentic CLI for terminal-first development.
Python SDK for building production-grade OpenAI agent workflows.
Google's framework for building production AI agents.
Type-safe agent development for Python with first-class MCP support.
TypeScript toolkit for building AI-powered web applications.
TypeScript-native agent framework for modern web stacks.
Python framework for orchestrating collaborative AI agent crews.
Leading Python framework for composable LLM applications.
Data-aware AI agent framework for structured and unstructured sources.
Microsoft's framework for multi-agent collaborative conversations.
Connect ReadMe to Windsurf
Get your token, paste the configuration, and start using 10 tools in under 2 minutes. No API key management needed.