How to Use the Apiary MCP in Windsurf

Q: Does Windsurf support Apiary team workflows?

Yes, you can use listteams and listteamapis to view shared project data. Windsurf lets you pull blueprints from any team you belong to.

Use the Apiary MCP Server in Windsurf to manage API blueprints, run Dredd tests, and sync team documentation without leaving Cascade.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Apiary MCP to Windsurf

Create your Vinkius account to connect Apiary to Windsurf and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Apiary with Windsurf

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Sync API designs inside Windsurf

Cascade pulls your API Blueprint source code directly from Apiary using `get_api`. It interprets the structure immediately so you can refine endpoints without switching tabs. You avoid manual copy-pasting. The agent reads the raw blueprint and suggests updates based on your current codebase changes.

Automate documentation in Windsurf

Cascade fetches live mock server URLs via `get_doc_url` while you write your implementation. It maps the documentation to your local project files. This keeps your mocks synced with your code. You stop hunting for links in the browser because the agent knows exactly where your design lives.

Trigger tests via Windsurf

Run your Dredd-style test suites straight from the IDE using `run_tests`. Cascade executes the test cycle and presents the pass/fail results in the chat panel. You catch contract violations before they break production. The agent handles the execution while you focus on fixing the logic.

Setup guide

Set up Apiary MCP in Windsurf

Prerequisites

Windsurf IDE installed (macOS, Windows, or Linux)
Active Vinkius subscription with a valid endpoint token

1

Open MCP configuration

Click the Cascade assistant icon in the sidebar, then click the hammer icon (🔨) at the top of the panel. Select "Configure" to open ~/.codeium/windsurf/mcp_config.json.
2

Add the Apiary MCP

Paste the JSON snippet shown on the right into the mcpServers object. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Refresh MCPs

Go back to the hammer icon (🔨) in Cascade and click "Refresh". Windsurf will detect the new server. No full restart is needed — the connection is hot-reloaded.
4

Verify in Cascade

Start a new Cascade conversation and ask something like "Show my Apiary payment history." If connected, Cascade will call the Apiary tools directly. You will see a green dot next to the server name in the MCP panel.

mcp_config.json

{
  "mcpServers": {
    "apiary-mcp": {
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Apiary. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Apiary now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Apiary MCP in Windsurf

Open your Windsurf settings and go to the Cascade configuration. Add the server details under the mcpServers key to link your Apiary account.

Yes, you can use `list_teams` and `list_team_apis` to view shared project data. Windsurf lets you pull blueprints from any team you belong to.

You can push your local Markdown changes to the server using `publish_blueprint`. Windsurf handles the update request as soon as you confirm the action.

Vinkius runs this MCP Server in an ephemeral sandbox. Your API blueprints and test results never persist on our servers after the session ends.

We store your Apiary access token in an encrypted vault. Only this specific MCP server instance can access your private API project metadata.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python