How to Use the Hyrule Compendium MCP in OpenAI Agents SDK

Q: How does caching work with this setup?

You can set cacheToolsList=True in your connection parameters. This tells your OpenAI agent to cache the tool definitions, which speeds up startup times and reduces initialization latency.

Give your OpenAI Agents SDK production agents instant access to Breath of the Wild and Tears of the Kingdom data.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Hyrule Compendium MCP to OpenAI Agents SDK

Create your Vinkius account to connect Hyrule Compendium to OpenAI Agents SDK 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 Hyrule Compendium with OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Direct taxonomy queries via MCP Server

The `get_category` tool lets your agent query the Hylian wilderness on demand. This targeted lookup keeps your token usage low. Your agent can pinpoint exactly what it needs, whether that is a silver lynel's drops or the location of a silent princess.

Run safe game data lookups in OpenAI Agents SDK

The `get_entry` tool provides validated lookups for specific game items. If an agent tries to fetch a non-existent item ID, your system catches it early. The built-in tracing on the OpenAI dashboard shows you exactly when and why a tool call was initiated.

Full database exports for offline analysis

The `get_all_entries` tool pulls the entire ledger of Hylian creatures, equipment, and treasure in one go. We recommend setting `cacheToolsList=True` during setup. It prevents redundant network round-trips when your specialized agents hand off tasks to one another.

Setup guide

Set up Hyrule Compendium MCP in OpenAI Agents SDK

Prerequisites

Python 3.10+ installed
openai-agents package (pip install openai-agents)
Active Vinkius subscription with a valid endpoint token

1

Install the SDK

Run pip install openai-agents to install the OpenAI Agents SDK. The MCP integration is built-in — no extra dependencies needed.
2

Connect via SSE transport

Use MCPServerSse with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. The SDK auto-discovers all Hyrule Compendium tools at runtime.
3

Create your Agent

Pass the MCP to Agent(mcp_servers=[server]). The agent receives Hyrule Compendium tools as native definitions — JSON schemas resolve automatically.
4

Run the agent

Call Runner.run(agent, prompt) to execute. The agent invokes the appropriate Hyrule Compendium tools and returns structured results. Copy the full example on the right to get started.

agent.py

import asyncio
from agents import Agent, Runner
from agents.mcp import MCPServerSse

async def main():
    async with MCPServerSse(
        url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    ) as server:
        agent = Agent(
            name="Hyrule Compendium Agent",
            instructions="You have access to Hyrule Compendium tools.",
            mcp_servers=[server],
        )
        result = await Runner.run(agent, "List recent transactions")
        print(result.final_output)

asyncio.run(main())

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 Hyrule Compendium. 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 Hyrule Compendium 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 Hyrule Compendium MCP in OpenAI Agents SDK

Install the package using pip, then initialize the server streamable HTTP class with your endpoint URL. Pass this server object directly into your Agent constructor's mcp_servers list. The agent will discover the tools immediately.

Yes. The database contains entries from both Breath of the Wild and Tears of the Kingdom. Your agent can find creatures, equipment, materials, monsters, and treasure from both titles.

You can control tool exposure at the agent level. While the server exposes all three tools by default, you can configure your agent's tool definitions to only permit `get_entry` if you want to block full database dumps.

You can set `cacheToolsList=True` in your connection parameters. This tells your OpenAI agent to cache the tool definitions, which speeds up startup times and reduces initialization latency.

All requests for Zelda item records run through a secure V8 isolate sandbox on Vinkius. Your connection credentials are encrypted at rest, and this MCP Server never writes query parameters to disk.

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