hytaledocs-mcp-server
v1.0.1
Published
MCP Server for HytaleDocs - Exposes hytale-docs.com content to Claude
Maintainers
Readme
HytaleDocs MCP Server
A Model Context Protocol (MCP) server that exposes HytaleDocs to Claude and other MCP-compatible AI assistants.
Features
- GitHub-Based Cache: Reads documentation downloaded from GitHub by the IntelliJ plugin
- Full-Text Search: TF-IDF based search across all documentation
- MCP Tools: Three tools for interacting with documentation:
search_docs- Search documentation by keywordlist_docs- List available documentationget_doc- Get full content of a document
- MCP Resources: Direct access via
docs://URIs - Offline Support: Works completely offline once docs are downloaded
Installation
npm install -g hytaledocs-mcp-serverOr run directly with npx:
npx hytaledocs-mcp-serverSetup (Required)
Documentation is managed by the Hytale IntelliJ Plugin:
- Install the Hytale IntelliJ Plugin
- Open IntelliJ IDEA
- Go to Hytale tool window → AI tab
- Click "Download from GitHub"
- Wait for download to complete (~1 request, extracts from ZIP)
- Click "Copy MCP Config" to get Claude Desktop configuration
The docs are downloaded from the wiki-next GitHub repository and stored at:
~/.hytale-intellij/docs-cache/Claude Desktop Configuration
Add to your claude_desktop_config.json:
{
"mcpServers": {
"hytale-docs": {
"command": "npx",
"args": ["hytaledocs-mcp-server"]
}
}
}Location of config file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
CLI Commands
# Start MCP server (for Claude Desktop)
hytaledocs-mcp
# Check cache status
hytaledocs-mcp --status
# Show help
hytaledocs-mcp --helpMCP Tools
search_docs
Search the documentation for relevant content.
Input:
query: string (required) - The search query
limit: number (optional) - Max results (default: 10)
Output:
List of matching documents with titles, scores, and excerptslist_docs
List all available documentation pages.
Input:
category: string (optional) - Filter by category
Output:
Grouped list of all documents by categoryget_doc
Get the full content of a documentation page.
Input:
slug: string (required) - The document slug (e.g., "api/server-internals/events")
Output:
Full markdown content with metadataMCP Resources
Access documentation directly via URIs:
docs://api/server-internals/events
docs://modding/plugins/overview
docs://getting-started/introductionArchitecture
┌─────────────────────┐ ┌──────────────────────┐
│ IntelliJ Plugin │────>│ GitHub (wiki-next) │
│ (Downloads docs) │ │ ZIP archive │
└─────────────────────┘ └──────────────────────┘
│
v
┌─────────────────────┐
│ Local Cache │
│ ~/.hytale-intellij │
│ /docs-cache/ │
└─────────────────────┘
│
v
┌─────────────────────┐ ┌──────────────────────┐
│ MCP Server │<───>│ Claude Desktop │
│ (Reads cache) │ │ (AI queries) │
└─────────────────────┘ └──────────────────────┘Benefits
- 1 HTTP request to download all docs (GitHub ZIP archive)
- 0 load on hytale-docs.com servers
- Offline access - works without internet after initial download
- Always synced with GitHub repository
- Shared cache between IntelliJ plugin docs tab and MCP server
Development
# Install dependencies
npm install
# Build
npm run build
# Watch mode
npm run dev
# Check status
npm run statusLicense
MIT
