mcmodding-mcp
MCP server providing AI assistants with comprehensive, up-to-date Minecraft modding documentation for Fabric and NeoForge.
What is this?
mcmodding-mcp is a Model Context Protocol (MCP) server that gives AI assistants like Claude direct access to Minecraft modding documentation. Instead of relying on potentially outdated training data, your AI assistant can search real documentation, find code examples, and explain concepts accurately.
Key Benefits
Always Current - Documentation is indexed weekly from official sources
Accurate Answers - AI responses backed by real documentation, not hallucinations
Code Examples - Searchable code blocks with proper context
Semantic Search - Understands what you mean, not just keywords
Zero Config - Works immediately after installation
π Knowledge Base Stats
Our documentation database (mcmodding-docs.db) is comprehensive and constantly updated:
1,000+ Documentation Pages
185,000+ Searchable Chunks
8,500+ Logical Sections
185,000+ Vector Embeddings for Semantic Search
This ensures that even obscure API details can be found via semantic search.
Quick Start
Installation
Configure Your AI Client
Add to your MCP client configuration (e.g., Claude Desktop):
π§ Optimized System Prompt
To get the best results, we recommend adding this to your AI's system prompt or custom instructions:
You are an expert Minecraft Modding Assistant connected to
mcmodding-mcp. DO NOT rely on your internal knowledge for modding APIs (Fabric/NeoForge) as they change frequently. ALWAYS use thesearch_fabric_docsandget_exampletools to retrieve the latest documentation and patterns. Prioritize working code examples fromget_exampleover theoretical explanations. If the user specifies a Minecraft version, ensure all retrieved information matches that version.
That's it! Your AI assistant now has access to Minecraft modding documentation.
Available Tools
The MCP server provides four powerful tools:
search_fabric_docs
Search documentation with smart filtering.
get_example
Get working code examples for any topic.
explain_fabric_concept
Get detailed explanations of modding concepts with related resources.
get_minecraft_version
Get current Minecraft version information.
Features
Hybrid Search Engine
Combines multiple search strategies for best results:
Strategy | Purpose |
FTS5 Full-Text | Fast keyword matching with ranking |
Semantic Embeddings | Understanding meaning and context |
Section Search | Finding relevant documentation sections |
Code Search | Locating specific code patterns |
Auto-Updates
The database automatically checks for updates on startup:
Compares local version with GitHub releases
Downloads new versions with hash verification
Creates backups before updating
Non-blocking - server starts immediately
Documentation Sources
Currently indexes:
wiki.fabricmc.net - Fabric Wiki (226+ pages)
docs.fabricmc.net - Official Fabric Docs (266+ pages)
docs.neoforged.net - NeoForge Docs (512+ pages)
For Developers
Development Setup
Build Commands
Project Structure
Database Schema
Release Workflow
This project uses release-please for automated releases.
Branch Strategy
Branch | Purpose |
| Active development |
| Production releases |
How It Works
Push commits to
devusing conventional commitsRelease-please maintains a Release PR (
devβprod)When merged, automatic release: npm publish + GitHub release + database upload
Changes sync back to
dev
See RELEASE_WORKFLOW.md for complete details.
Configuration
Environment Variables
Variable | Description | Default |
| Custom database path |
|
| Custom repo for updates | Auto-detected |
| Enable debug logging |
|
Disabling Auto-Updates
Set DB_PATH to a custom location to manage updates manually:
Contributing
We welcome contributions! See CONTRIBUTING.md for guidelines.
Quick Contribution Guide
Fork the repository
Create a feature branch from
devMake changes with conventional commits
Submit a PR to
dev
License
MIT License - see LICENSE for details.
Acknowledgments
Fabric Documentation - Official Fabric documentation
Fabric Wiki - Community wiki
Model Context Protocol - MCP specification
Transformers.js - Local ML embeddings
better-sqlite3 - Fast SQLite bindings