hytale-mcp
v1.0.0
Published
The unofficial Hytale Model Context Protocol (MCP) server. Provides AI assistants with game lore, API documentation, and modding tools.
Maintainers
Readme
Hytale MCP Server 🎮
The ultimate AI companion for Hytale Modding.
This is a Model Context Protocol (MCP) server that gives your AI Assistant (Claude Desktop, Cursor, Windsurf, etc.) deep knowledge about Hytale.
Features ✨
- 📚 Lore Database: Ask about Mobs (Kweebec, Trork), Items (Void Scythe), and Recipes.
- 🛠️ Modding API Docs: Full simulated documentation for the Hytale API (Plugins, ECS, WorldGen).
- 🏗️ Project Scaffolding: Instantly generate
build.gradleandhytale.jsonfor new mods. - 🐛 Error Analysis: Paste a crash log, and the AI will tell you how to fix it.
- 🎨 Asset Templates: Generate JSON for Models and Textures.
Installation 📦
Method 1: Using npx (Recommended)
You can run this directly without installing it globally.
Claude Desktop Configuration:
Add this to your claude_desktop_config.json:
{
"mcpServers": {
"hytale": {
"command": "npx",
"args": ["-y", "hytale-mcp"]
}
}
}Method 2: Install Globally
npm install -g hytale-mcpThen configure your editor to run:
hytale-mcp
Capabilities 🤖
Tools
search_wiki: Search the entire knowledge base.get_api_reference: Get code examples for specific topics (e.g.,spawning_entities,custom_ui).scaffold_project: Generate a new mod project structure.analyze_error: Diagnose Hytale-specific exceptions.generate_asset: Create JSON templates for models/textures.
Resources
hytale://lore/mobs/listhytale://api/docs/listhytale://advanced/docs/list(WorldGen & ECS)
Development
- Clone repo
npm installnpm run buildnode build/index.js
