Apiary MCP Server for Windsurf 10 tools — connect in under 2 minutes
Windsurf brings agentic AI coding to a purpose-built IDE. Connect Apiary 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 Apiary and 2,500+ MCP Servers from a single visual interface.
{
"mcpServers": {
"apiary": {
"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 Apiary MCP Server
Connect your Apiary workspace to your AI agent and take full control of your API design, specification, and validation processes through natural conversation.
Windsurf's Cascade agent chains multiple Apiary 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
- Read API Blueprints — Fetch raw Markdown-based API Blueprints or Swagger files defining endpoints, methods, and parameters without leaving your editor
- Publish Documentation — Instantly update your Apiary projects with new markdown code. Mock servers and public documentation sync automatically
- Run Dredd Tests — Validate your backend implementation against the blueprint specifications using integrated tests
- Team Management — Query team API projects, list team members, and manage your engineering ecosystem intuitively
The Apiary 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 Apiary to Windsurf via MCP
Follow these steps to integrate the Apiary 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 Apiary
Open Cascade and ask: "Using Apiary, help me...". 10 tools available
Why Use Windsurf with the Apiary MCP Server
Windsurf provides unique advantages when paired with Apiary 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
Apiary + Windsurf Use Cases
Practical scenarios where Windsurf combined with the Apiary MCP Server delivers measurable value.
Automated code generation: ask Cascade to fetch data from Apiary and generate models, types, or handlers based on real API responses
Live debugging: query Apiary tools mid-session to inspect production data while debugging without leaving the editor
Documentation generation: pull schema information from Apiary and have Cascade generate comprehensive API docs automatically
Rapid prototyping: combine Apiary data with Cascade's code generation to scaffold entire features in minutes
Apiary MCP Tools for Windsurf (10)
These 10 tools become available when you connect Apiary to Windsurf via MCP:
get_api
Get the full API Blueprint source code of an Apiary API project
get_doc_url
Get the documentation and mock server URLs for an Apiary API project
get_me
Get the authenticated Apiary user profile
get_team
Get details of a specific Apiary team
list_apis
Apiary is an API design-first platform. List all API projects on Apiary
list_team_apis
List all API projects belonging to a specific Apiary team
list_team_members
List all members of an Apiary team
list_teams
List all teams the authenticated user belongs to on Apiary
publish_blueprint
Use with valid Markdown blueprint/Swagger. Publish (update) the API Blueprint of an Apiary API project
run_tests
Get or run Dredd-style API tests against an Apiary project
Example Prompts for Apiary in Windsurf
Ready-to-use prompts you can give your Windsurf agent to start working with Apiary immediately.
"Get the API Blueprint code for my project named 'payments-gateway'."
"List all team members of the 'frontend-team' in Apiary."
"Update my 'users-api' with this new blueprint code..."
Troubleshooting Apiary MCP Server with Windsurf
Common issues when connecting Apiary to Windsurf through the Vinkius, and how to resolve them.
Server not connecting
Apiary + Windsurf FAQ
Common questions about integrating Apiary 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 Apiary 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 Apiary to Windsurf
Get your token, paste the configuration, and start using 10 tools in under 2 minutes. No API key management needed.