# Hyrule Compendium MCP > The Hyrule Compendium MCP provides instant access to a full database of Zelda: Breath of the Wild and Tears of the Kingdom data. Use your agent to search creature details, find specific materials for crafting, or list all known monster types from across Hyrule's ecosystem. ## Overview - **Category:** knowledge-management - **Price:** Free - **Tags:** zelda, hyrule, botw, totk, gaming-data ## Description This MCP connects your AI client directly to an encyclopedia built around the world of Hyrule. You can talk naturally about the game and get precise facts back—whether you need to know a rare material’s source or want a full list of all known enemies. Instead of sifting through wikis, you ask your agent for details on any creature, monster, or piece of equipment by its name or ID. If you're working with data like this regularly, check out the Vinkius catalog; it hosts thousands of other specialized databases just like this one. It’s built to handle everything from basic lookups—like finding what a 'Big Hearty Truffle' does—to getting every single entry in the database for a complete overview. ## Tools ### get_all_entries Retrieves every single entry in the entire Hyrule Compendium database. ### get_category Filters and retrieves all entries belonging to a specific group, such as materials or monsters. ### get_entry Gets detailed information for one item, monster, or creature using its unique name or ID. ## Prompt Examples **Prompt:** ``` Show me the details for entry number 100 in the compendium. ``` **Response:** ``` I've retrieved entry #100. It is the 'Blue Sparrow', a small bird found in the Lanayru Great Spring and Hyrule Ridge areas. It drops Chickloo Tree Nuts when startled. ``` **Prompt:** ``` List all monsters found in Hyrule. ``` **Response:** ``` Fetching the monster category... I've found various entries including Bokoblins, Moblins, and Lynels. Would you like details on a specific monster or a list of the most dangerous ones? ``` **Prompt:** ``` Get all materials used for cooking or upgrades. ``` **Response:** ``` Accessing the materials category... I've found entries like 'Silent Princess', 'Big Hearty Truffle', and 'Voltfin Trout'. Which material would you like to know more about? ``` ## Capabilities ### List all game entries Retrieves every record available in the compendium, allowing you to get a full inventory of everything cataloged. ### Filter by data type Narrows down results to specific groups like monsters, materials, or equipment for focused research. ### Fetch specific item details Looks up detailed metadata, common locations, and dropped items using the name or unique ID of an entry. ## Use Cases ### Checking rare monster drops A player needs to know if the Lynel parts found in Hyrule Ridge are worth gathering. They ask their agent, and it uses `get_entry` to confirm drop items and common locations immediately. ### Building a materials guide A researcher wants to compile every type of plant material used in cooking. They ask the agent to filter using `get_category`, focusing only on 'materials' for an organized list. ### Reviewing entire game lore An enthusiast wants a complete, un-filtered look at all entries—creatures, items, and monsters alike. They ask the agent to run `get_all_entries` to get the full scope of the world. ### Developing data pipelines A developer needs a stable dataset for testing new features. They use all three tools—first `get_category`, then refine with `get_entry`—to validate their retrieval logic across multiple endpoints. ## Benefits - Stop manually searching wikis. Use your agent to ask for specific stats or locations, getting the exact facts instantly. - Need a full overview? Running `get_all_entries` gives you access to every piece of lore in one go, perfect for compiling massive data sheets. - Focus your search immediately with `get_category`. You can narrow down results by 'materials' or 'monsters' without sifting through irrelevant entries. - Use `get_entry` when you know exactly what you need. Just give the name, and it pulls up location, drop items, and full descriptions. - The data is clean and structured. This makes it ideal for developers who need a predictable dataset to test their client-side logic. ## How It Works The bottom line is that you talk to your agent like you're talking to a friend, and it handles the database queries for you. 1. Subscribe to this MCP on Vinkius. No complex API keys are needed since this is a public data source. 2. Connect your agent (Claude, Cursor, etc.) to the catalog via its compatible client app. 3. Ask anything about Hyrule's wildlife, weapons, or materials using natural language prompts. ## Frequently Asked Questions **How do I use the get_all_entries tool?** Just ask your agent to retrieve all entries in the compendium. It will pull a comprehensive list of everything available, from creatures to materials. **What should I use if I only want to see monsters?** You need to run `get_category` and specify 'monsters' as the group. This keeps your search focused and prevents getting flooded with unrelated item data. **Can get_entry look up a creature by name?** Yes, you can use `get_entry` to find details for any monster or creature if you know its name or unique ID. It provides full metadata and drop lists. **Is this MCP good for developers?** It’s great for developers because it gives a clean, predictable dataset. You can use the three tools to test your client's ability to handle scoped versus global data retrieval. **When I call get_all_entries, what structure does the returned Hylian lore use?** It returns structured JSON objects containing metadata for every entry. This includes common locations, specific types, and dropped items, making it easy for your agent to parse into a database or spreadsheet. **If I want to narrow my search using get_category, what are the available filters?** You can filter by major groups like 'monsters,' 'materials,' and 'equipment.' Using this function keeps your results focused, preventing you from wading through irrelevant data. **What happens if I try to use get_entry with an ID or name that is invalid?** The tool returns a clear error message stating the entry was not found. This prevents confusion and allows your agent to prompt you for clarification or suggest related entries. **When get_entry fetches a specific item, what key details beyond the description do I receive?** It provides actionable metadata points, including common locations within Hyrule and items that drop when the creature is defeated. This turns lore into useful game data. **How can I find the stats for a specific creature like a 'Golden Horse'?** Use the `get_entry` tool and provide 'golden_horse' as the id_or_name. The agent will return its common locations, drops, and description in seconds. **Can I list only the weapons and armor available in the game?** Yes. Use the `get_category` tool with the category_name set to 'equipment' to see all gear recorded in the compendium. **Is it possible to browse the entire compendium at once?** Absolutely. The `get_all_entries` tool fetches the complete database, organized by category, allowing your AI to act as a full Hylian encyclopedia.