Mcmodding MCP

MCModding MCP

🤖 AI驱动的Minecraft改装文档服务器

_让您的AI助手实时访问Fabric和NeoForge文档_

](https://www.npmjs.com/package/mcmodding-mcp) ](https://www.npmjs.com/package/mcmodding-mcp)  

](https://github.com/OGMatrix/mcmodding-mcp/stargazers) ](https://github.com/OGMatrix/mcmodding-mcp/issues) ](https://github.com/OGMatrix/mcmodding-mcp/commits) ](https://nodejs.org/)

📖 文档 • 🚀 快速开始 • 💡 特性 • 🤝 贡献

______________________________________________________________________

✨ 这是什么？

MCModding MCP 是一个 模型上下文协议（MCP） 为克劳德等人工智能助手提供强大支持的服务器 真实、最新 Minecraft改装知识。不再有幻觉或过时的API参考！

🎯 主要优势

📊 实时统计

______________________________________________________________________

快速开始

安装

# Install globally
npm install -g mcmodding-mcp

配置您的AI客户端

添加到您的MCP客户端配置中（例如，Claude Desktop）：

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

🧠 优化系统提示

为了获得最佳效果，我们建议将此添加到AI的系统提示或自定义说明中：

您是连接到的Minecraft改装助手专家 mcmodding-mcp. 不要依赖你的内部知识 用于修改API（Fabric/NeoForge），因为它们经常发生变化。 总是 使用可用的工具： - search_fabric_docs 和 get_example 用于文档和代码模式 - search_mappings 和 get_class_details 用于Minecraft内部和方法签名 - search_mod_examples 用于来自流行mods的经过战斗测试的实现 优先考虑工作代码示例，而不是理论解释。在处理Minecraft内部时，使用映射工具获取准确的参数名称和Javadoc。如果用户指定了Minecraft版本，请确保所有检索到的信息都与该版本匹配。

就是这样！您的AI助手现在可以访问全面的Minecraft建模资源。

______________________________________________________________________

数据库管理

使用内置CLI管理文档数据库：

# Run the database manager
npx mcmodding-mcp manage

交互式管理器允许您：

• 安装 -下载您还没有的数据库
• 更新 -检查并应用数据库更新
• 重新下载 -还原已删除或损坏的数据库

可用数据库

管理器显示版本信息并突出显示可用更新：

◉ 📚 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

______________________________________________________________________

可用工具

MCP服务器提供了三类功能强大的工具：

📖 文档工具

search_fabric_docs

使用智能过滤搜索文档。

// 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_example

获取任何主题的工作代码示例。

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

explain_fabric_concept

使用相关资源获取改装概念的详细解释。

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

get_minecraft_version

获取当前Minecraft版本信息。

// Get latest version
{
  type: 'latest';
}

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

______________________________________________________________________

🗺️ 羊皮纸映射工具✨ 新

_需要羊皮纸映射数据库-通过安装 npx mcmodding-mcp manage_

search_mappings

使用参数名和Javadoc搜索Minecraft类、方法和字段映射。

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

get_class_details

获取有关Minecraft类的全面信息，包括所有方法和字段。

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

lookup_obfuscated

从模糊的标识符中查找去模糊的名称（对崩溃日志很有用）。

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

get_method_signature

获取方法的完整签名，包括所有参数名称和类型。

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

browse_package

在Minecraft软件包中发现课程。

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

______________________________________________________________________

🧩 Mod示例工具

_需要Mod Examples数据库-通过安装 npx mcmodding-mcp manage_

search_mod_examples

从流行的模组中搜索经过战斗测试的代码，如Create、Botania和Applied Energistics 2。

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

get_mod_example

获取有关特定示例的详细信息，包括完整的代码和解释。

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

list_canonical_mods

发现所有索引模组及其可用示例。

list_mod_categories

浏览可用的示例类别（块、实体、渲染等）。

______________________________________________________________________

特性

混合搜索引擎

结合多种搜索策略以获得最佳结果：

自动更新

数据库在启动时自动检查更新：

• 将本地版本与GitHub版本进行比较
• 下载带有哈希验证的新版本
• 在更新之前创建备份
• 无阻塞-服务器立即启动

文档来源

当前索引：

• wiki.fabricmc.net -Fabric Wiki（226+页）
• docs.fabricmc.net -官方布料文档（266+页）
• docs.neoforged.net -NeoForge文档（512+页）

______________________________________________________________________

对于开发者

开发设置

# 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(...);

______________________________________________________________________

发布工作流

此项目使用 请释放 自动发布。

分支策略

运作原理

1. 推送承诺 dev 使用 常规承诺
2. 发布请保持发布PR(dev → prod)
3. 合并时，自动发布：npm发布+GitHub发布+数据库上传
4. 更改同步回 dev

看 发布_工作流.md 了解完整细节。

______________________________________________________________________

配置

环境变量

禁用自动更新

集 DB_PATH 到自定义位置手动管理更新：

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

______________________________________________________________________

💡 分享你的想法！

我们正在积极开发mcmodding mcp，希望收到您的来信！

有想法吗？

• 功能请求 -哪些工具可以让你的修改更容易？
• 新的文档来源 -知道我们应该索引的一个伟大的建模资源吗？
• 工作流程改进 -这些工具如何更好地适用于您的用例？

👉 打开功能请求

发现Bug了吗？

• 搜索结果不正确？
• 文件缺失或过时？
• 工具未按预期工作？

👉 报告错误

分享你的经验

使用mcmodding mcp进行一个很酷的项目？我们很想听听！分享你的故事 讨论.

______________________________________________________________________

贡献

我们欢迎捐款！看 贡献.md 作为指导方针。

快速贡献指南

1. 克隆该仓库
2. 从以下位置创建要素分支 dev
3. 使用常规提交进行更改
4. 向提交PR dev

______________________________________________________________________

许可证

MIT许可证-请参阅 许可证 了解详情。

更新日志

看 更改日志.md 查看更改和发布的详细历史记录。

______________________________________________________________________

致谢

• 织物文档 -官方面料文档
• 织物维基 -社区wiki
• NeoForge文档 -NeoForge官方文档
• 羊皮纸MC -参数名称和Javadoc映射
• 模型上下文协议 -MCP规范
• Transformers.js -本地ML嵌入
• 更好平方3 -快速SQLite绑定

______________________________________________________________________

🎮 内置于❤️ Minecraft改装社区

  

如果你觉得这个项目有用，请考虑给它一个⭐!

⬆️ 返回顶部