How to Use the Apiary MCP in LlamaIndex

Q: Can LlamaIndex agents update my Apiary blueprints?

Yes, the agent can call publishblueprint when it detects schema inconsistencies in your indexed documents. This keeps your design and code in lockstep.

Q: Can I restrict which Apiary MCP tools LlamaIndex can access?

Yes, you can specify allowed tools like listapis or getdocurl during client initialization to limit your agent's capabilities.

Index live Apiary blueprints directly into your LlamaIndex vector store to ground your agent in real API designs.

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 LlamaIndex

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

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Index live Apiary schemas into LlamaIndex

This integration uses `get_api` to pull the latest API Blueprint Markdown directly from your project into LlamaIndex documents. Forget relying on outdated static files for your RAG applications. Your agent queries these indexed blueprints during conversational search. Because the data comes straight from the source, your RAG pipeline avoids generating stale code examples.

Query team workspaces using semantic search

This MCP Server uses `list_team_apis` and `get_doc_url` to build a searchable catalog of your entire team's work. Finding the right API endpoint in a massive organization is always painful. When a developer asks where a specific user service is, the LlamaIndex agent scans the indexed workspace metadata. It returns the correct mock server URL instantly without manual searching.

Validate and index API test outcomes

By running `run_tests`, your agent fetches real-time Dredd validation results and indexes them into your vector store. Keep your knowledge base updated with the actual health of your endpoints. When your team queries the system about API reliability, LlamaIndex pulls the latest test runs to prove which endpoints are fully operational. This eliminates the guesswork from your API integration workflows.

Setup guide

Set up Apiary MCP in LlamaIndex

Prerequisites

Python 3.10+ installed
llama-index-tools-mcp package
Active Vinkius subscription with a valid endpoint token

1

Install dependencies
Run pip install llama-index-tools-mcp llama-index-llms-openai. The MCP tools package provides BasicMCPClient and McpToolSpec.
2

Connect with BasicMCPClient
Point BasicMCPClient to your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. Supports SSE and Streamable HTTP transports.
3

Convert to LlamaIndex tools
Call mcp_tool_spec.to_tool_list_async() to convert all Apiary MCP tools into native FunctionTool objects that any LlamaIndex agent can use.
4

Run with any LLM
Create a FunctionAgent with the tools and your preferred LLM. Swap OpenAI for Anthropic, Gemini, or any LlamaIndex-supported provider.

agent.py

from llama_index.tools.mcp import BasicMCPClient, McpToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

# Connect to the MCP
mcp_client = BasicMCPClient(
    "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
)
mcp_tool_spec = McpToolSpec(client=mcp_client)

# Convert MCP tools to LlamaIndex tools
tools = await mcp_tool_spec.to_tool_list_async()

# Create and run the agent
agent = FunctionAgent(
    tools=tools,
    llm=OpenAI(model="gpt-4o"),
    system_prompt="You have access to Apiary tools.",
)
response = await agent.run("List recent Apiary data")

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 LlamaIndex

You use the McpToolSpec to fetch the raw blueprint text using `get_api`. LlamaIndex then parses and embeds this markdown directly into your vector store.

Yes, the agent can call `publish_blueprint` when it detects schema inconsistencies in your indexed documents. This keeps your design and code in lockstep.

Vinkius manages the API connection pool to prevent rate limiting. Your LlamaIndex agent can safely fetch team lists and API metadata without hitting platform blocks.

Yes, you can specify allowed tools like `list_apis` or `get_doc_url` during client initialization to limit your agent's capabilities.

Your API tokens are encrypted at rest on Vinkius and only decrypted inside isolated MCP runtimes when executing tool calls.

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