How to Use the Apiary MCP in VS Code Copilot

Share your Apiary design tools across the whole team with VS Code Copilot.

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 VS Code Copilot

Create your Vinkius account to connect Apiary to VS Code Copilot 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 VS Code Copilot

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Standardize Apiary workflows across your VS Code Copilot team

Commit your configuration to the repo so everyone sees the same tools. The agent can use `get_api` to pull the exact blueprint everyone is working against. Pushing updates is just as consistent. Every team member uses `publish_blueprint` to keep the remote documentation in sync with the shared codebase.

Execute team-wide API tests from VS Code Copilot

Get immediate feedback on your design changes. Use `run_tests` to verify that your current implementation still passes the Dredd-style test suite defined in Apiary. Check your documentation status with `get_doc_url`. It ensures that every developer on your team is hitting the right mock servers during local development.

Coordinate your Apiary team tasks in VS Code Copilot

Keep your team organized without leaving the IDE. Call `list_teams` to see your organization's workspaces and `list_team_apis` to find the project you are currently building. Verify your team roster with `list_team_members`. It helps you confirm who is responsible for specific API endpoints when you run into a design question.

Setup guide

Set up Apiary MCP in VS Code Copilot

Prerequisites

VS Code 1.99 or later with GitHub Copilot extension
Active Vinkius subscription with a valid endpoint token

1

Open MCP configuration

Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and run "MCP: Add Server". Select HTTP (Streamable) as the server type. VS Code will create .vscode/mcp.json in your workspace.
2

Add the Apiary MCP

Paste the JSON snippet shown on the right into your .vscode/mcp.json. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Switch to Agent mode

Open Copilot Chat (Cmd+Shift+I / Ctrl+Shift+I) and switch to Agent mode using the dropdown. MCP tools are only available in Agent mode — they do not appear in Edit or Ask modes.
4

Verify the connection

In the Copilot Chat input, type # to list available tools. You should see the Apiary tools listed. Try asking: "List my recent Apiary transactions" and Copilot will invoke them automatically.

.vscode/mcp.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 VS Code Copilot

Add the server to your .vscode/mcp.json file and commit it to your repository. This ensures every developer on your team has access to the same tools.

Yes. Enable agent mode in your chat window to allow the assistant to call your Apiary tools and pull live data into your development process.

You can list teams and members to see who has access to your projects. While you cannot change permissions, you can track them easily within your IDE.

Vinkius manages the auth layer. You provide one token to the server, and it handles the rest, ensuring your team doesn't need to share individual API keys.

Your API design blueprints are never stored on disk by the server. We use a zero-trust architecture where data is held only in memory during the operation.

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

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript