Minecraft Modding Mcp

by OGMatrix

530 downloads
Not rated
GitHub

Description

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…

About

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.

Details

Author
OGMatrix
Downloads
530
Categories
Developer Tools, Other, Knowledge Base, AI

- Always current – documentation indexed weekly from official sources
- Semantic search understands meaning, not just keywords
- Hybrid search engine combining FTS5, embeddings, sections, and code search
- Auto-updates with hash verification and backup creation
- Zero configuration – works immediately after installation
- Four tools: search, examples, concept explanations, version info

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Minecraft Modding Mcp
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install globally with npm install -g mcmodding-mcp, then add "command": "mcmodding-mcp" to your MCP client configuration (e.g., Claude Desktop). Optionally include the provided system prompt to instruct the AI to always use the server’s tools instead of internal knowledge.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "minecraft modding mcp": {
            "mcmodding": {
                "command": "mcmodding-mcp"
            }
        }
    }
}

McpServers

{
    "mcmodding": {
        "command": "mcmodding-mcp"
    }
}

🤖 AI-Powered Minecraft Modding Documentation Server

Give your AI assistant real-time access to Fabric & NeoForge documentation

📖 Documentation•🚀 Quick Start•💡 Features•🤝 Contributing

MCModding-MCPis aModel Context Protocol (MCP)server that supercharges AI assistants like Claude withreal, up-to-dateMinecraft modding knowledge. No more hallucinations or outdated API references!

# Install globally npm install -g mcmodding-mcp

Add to your MCP client configuration (e.g., Claude Desktop):

{ "mcpServers": { "mcmodding": { "command": "mcmodding-mcp" } } }

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 tomcmodding-mcp.DO NOT rely on your internal knowledgefor modding APIs (Fabric/NeoForge) as they change frequently.ALWAYSuse the available tools:

- search_fabric_docsandget_examplefor documentation and code patterns
- search_mappingsandget_class_detailsfor Minecraft internals and method signatures
- search_mod_examplesfor battle-tested implementations from popular mods

Prioritize working code examples over theoretical explanations. When dealing with Minecraft internals, use the mappings tools to get accurate parameter names and Javadocs. If the user specifies a Minecraft version, ensure all retrieved information matches that version.

That's it! Your AI assistant now has access to comprehensive Minecraft modding resources.

Manage your documentation databases with the built-in CLI:

# Run the database manager npx mcmodding-mcp manage

- Install- Download databases you don't have yet
- Update- Check for and apply database updates
- Re-download- Restore deleted or corrupted databases

The manager shows version information and highlights available updates:

◉ 📚 Documentation Database [core] ✔ Installed: v0.2.1 → ↻ Update: v0.2.2 [520.3 MB] Core Fabric & NeoForge documentation - installed by default ○ 🗺️ Parchment Mappings Database ✨ NEW ⚠ Not installed → Available: v0.1.0 [178.5 MB] Minecraft class/method/field names with parameter names and Javadocs ○ 🧩 Mod Examples Database ⚠ Not installed → Available: v0.1.0 [28.1 MB] 1000+ high-quality modding examples for Fabric & NeoForge

The MCP server provides powerful tools across three categories:

Search documentation with smart filtering.

// Example: Find information about item registration { query: "how to register custom items", category: "items", // Optional filter loader: "fabric", // fabric | neoforge minecraft_version: "1.21.10" // Optional version filter }

Get working code examples for any topic.

// Example: Get block registration code { topic: "custom block with block entity", language: "java", loader: "fabric" }

Get detailed explanations of modding concepts with related resources.

// Example: Understand mixins { concept: 'mixins'; }

Get current Minecraft version information.

// Get latest version { type: 'latest'; } // Get all indexed versions { type: 'all'; }

Requires Parchment Mappings database - install vianpx mcmodding-mcp manage

Search Minecraft class, method, and field mappings with parameter names and Javadocs.

// Example: Find block-related classes and methods { query: "BlockEntity", type: "class", // class | method | field | all minecraft_version: "1.21.10", include_javadoc: true }

Get comprehensive information about a Minecraft class including all methods and fields.

// Example: Explore the Block class { class_name: "net.minecraft.world.level.block.Block", include_methods: true, include_fields: true }

Look up deobfuscated names from obfuscated identifiers (useful for crash logs).

// Example: Decode an obfuscated method name { obfuscated_name: 'm_46859_'; }

Get the full signature of a method including all parameter names and types.

// Example: Get method details { class_name: "Block", method_name: "onPlace" }

Discover classes in a Minecraft package.

// Example: Browse block package { package_name: 'net.minecraft.world.level.block'; }

Requires Mod Examples database - install vianpx mcmodding-mcp manage

Search battle-tested code from popular mods like Create, Botania, and Applied Energistics 2.

// Example: Find block entity implementations { query: "block entity tick", mod: "Create", // Optional: filter by mod category: "tile-entities", complexity: "intermediate" }

Get detailed information about a specific example with full code and explanations.

// Example: Get full details for an example { id: 42, include_related: true }

Discover all indexed mods and their available examples.

Browse available example categories (blocks, entities, rendering, etc.).

Combines multiple search strategies for best results:

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

- wiki.fabricmc.net- Fabric Wiki (226+ pages)
-
docs.fabricmc.net- Official Fabric Docs (266+ pages)
-
docs.neoforged.net- NeoForge Docs (512+ pages)

# Clone repository git clone https://github.com/OGMatrix/mcmodding-mcp.git cd mcmodding-mcp # Install dependencies npm install # Run in development mode npm run dev
# Development npm run dev # Watch mode with hot reload npm run typecheck # TypeScript type checking npm run lint # ESLint npm run test # Run tests npm run format # Prettier formatting # Production npm run build # Build TypeScript npm run build:prod # Build with fresh documentation index npm run index-docs # Index documentation with embeddings # Database Management npx mcmodding-mcp manage # Interactive database installer/updater
mcmodding-mcp/ ├── src/ │ ├── index.ts # MCP server entry point │ ├── db-versioning.ts # Auto-update system │ ├── indexer/ │ │ ├── crawler.ts # Documentation crawler │ │ ├── chunker.ts # Text chunking │ │ ├── embeddings.ts # Semantic embeddings │ │ ├── store.ts # SQLite database │ │ └── sitemap.ts # Sitemap parsing │ ├── services/ │ │ ├── search-service.ts # Search logic │ │ └── concept-service.ts # Concept explanations │ └── tools/ │ ├── searchDocs.ts # search_fabric_docs handler │ ├── getExample.ts # get_example handler │ └── explainConcept.ts # explain_fabric_concept handler ├── scripts/ │ └── index-docs.ts # Documentation indexing script ├── data/ │ ├── mcmodding-docs.db # SQLite database │ └── db-manifest.json # Version manifest └── dist/ # Compiled JavaScript
-- Documents: Full documentation pages CREATE TABLE documents ( id INTEGER PRIMARY KEY, url TEXT UNIQUE NOT NULL, title TEXT NOT NULL, content TEXT NOT NULL, category TEXT NOT NULL, loader TEXT NOT NULL, -- fabric | neoforge | shared minecraft_version TEXT, hash TEXT NOT NULL -- For change detection ); -- Chunks: Searchable content units CREATE TABLE chunks ( id TEXT PRIMARY KEY, document_id INTEGER NOT NULL, chunk_type TEXT NOT NULL, -- title | section | code | full content TEXT NOT NULL, section_heading TEXT, code_language TEXT, word_count INTEGER, has_code BOOLEAN ); -- Embeddings: Semantic search vectors CREATE TABLE embeddings ( chunk_id TEXT PRIMARY KEY, embedding BLOB NOT NULL, -- 384-dim Float32Array dimension INTEGER NOT NULL, model TEXT NOT NULL -- Xenova/all-MiniLM-L6-v2 ); -- FTS5 indexes for fast text search CREATE VIRTUAL TABLE documents_fts USING fts5(...); CREATE VIRTUAL TABLE chunks_fts USING fts5(...);

This project usesrelease-pleasefor automated releases.
- Push commits todevusing
conventional commits
- Release-please maintains a Release PR (devprod)
- When merged, automatic release: npm publish + GitHub release + database upload
- Changes sync back todev

SeeRELEASE_WORKFLOW.mdfor complete details.

SetDB_PATHto a custom location to manage updates manually:

DB_PATH=/path/to/my/database.db mcmodding-mcp

We're actively developing mcmodding-mcp and want to hear from you!

- Feature requests- What tools would make your modding easier?
- New documentation sources- Know a great modding resource we should index?
- Workflow improvements- How could the tools work better for your use case?

- Incorrect search results?
- Missing or outdated documentation?
- Tool not working as expected?

Using mcmodding-mcp for a cool project? We'd love to hear about it! Share your story inDiscussions.

We welcome contributions! SeeCONTRIBUTING.mdfor guidelines.
- Fork the repository
- Create a feature branch fromdev
- Make changes with conventional commits
- Submit a PR todev

SeeCHANGELOG.mdfor a detailed history of changes and releases.

- Fabric Documentation- Official Fabric documentation
-
Fabric Wiki- Community wiki
-
NeoForge Documentation- Official NeoForge documentation
-
ParchmentMC- Parameter names and Javadoc mappings
-
Model Context Protocol- MCP specification
-
Transformers.js- Local ML embeddings
-
better-sqlite3- Fast SQLite bindings

🎮 Built with ❤️ for the Minecraft modding community

If you find this project useful, please consider giving it a ⭐!

This is a web browser that enables your coding agent, such as Claude Code, to visit websites on your behalf and assist you in identifying bugs or creating UI test cases.

One shared context layer for AI agents and humans — live API specs, DB schemas, and versioned contracts across repos so every agent and teammate works from the same source of truth.

Local stdio MCP server that lets AI coding agents read and maintain structured architecture, rules, and decisions directly from your repository.

Official Context7 MCP server that brings up-to-date, version-specific library documentation and code examples into AI coding prompts.

Remote, no-auth MCP server providing AI-powered codebase context and answers

Create and read feature flags, review experiments, generate flag types, search docs, and interact with GrowthBook's feature flagging and experimentation platform.

Official MCP server for Stimulsoft Reports & Dashboards documentation. Semantic search across FAQ, Programming Manual, Server/User Manual, and Server/Cloud API for .NET, WPF, Avalonia, WEB, Blazor, Angular, React, JS, PHP, Java, and Python platforms.

Search Apple's Developer Documentation with smart search and wildcard support.

Access documentation from the Awesome-llms-txt repository directly in your conversations.

Connect AI tools like Cursor and VS Code to your product documentation using the Biel.ai platform.

MCP server that ingests project docs once and lets Claude search by meaning instead of reading everything — saving tokens on large codebases

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.