How to Use the Apiary MCP in Cursor

Sync your Apiary blueprints into Cursor to build code that actually matches your API design.

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 Cursor

Create your Vinkius account to connect Apiary to Cursor 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 Cursor

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Inject live Apiary blueprints into your Cursor agent

Stop working from outdated stubs. Use `get_api` to feed your current source code into the agent so the code it writes matches your design spec perfectly. When you need to update the source of truth, `publish_blueprint` lets you ship your latest changes to Apiary without switching windows.

Validate your API changes within the Cursor editor

Run your test suite without leaving your flow. The `run_tests` tool triggers your Dredd-style checks and reports the outcome directly to your editor chat. Keep your documentation links handy by using `get_doc_url`. It provides the exact mock server addresses you need while you are actively writing your implementation.

Query your Apiary team structure from Cursor

Need to know which team owns a project? Call `list_teams` to see your workspace list, then drill down into specific projects using `list_team_apis`. Managing your contributors is just as easy. Call `list_team_members` to see who is on your team and ensure everyone has the correct access for your current sprint.

Setup guide

Set up Apiary MCP in Cursor

Prerequisites

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

1

Open MCP Settings

Go to Cursor Settings → MCP or open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and search for "MCP: Add Server".
2

Add the Apiary MCP

Cursor will create or open .cursor/mcp.json in your project root. Paste the JSON snippet on the right. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Enable Agent mode

Open Composer (Cmd+I / Ctrl+I) and switch to Agent mode using the dropdown at the top. MCP tools are only available in Agent mode.
4

Verify the connection

Ask Cursor something like "List my recent Apiary transactions." If the MCP tools are loaded correctly, Cursor will call the Apiary tools automatically. You can also check Settings → MCP for a green status indicator.

.cursor/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 Cursor

Create an mcp.json file in your project root or your global settings folder. Define the server path there, and enable Agent mode to start using the tools.

It does. Once configured, your agent can call tools to fetch blueprints or run tests, allowing it to write code based on real API data.

You can. Use the listing tools to switch between different team projects and pull the relevant blueprint data into your current coding session.

Vinkius handles your authentication via a single endpoint token. This keeps your credentials out of your local project files and away from your repository.

Your blueprints are processed in an ephemeral, isolated environment. We strip your sensitive API source data from logs immediately after the request finishes.

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