内容
# mcp-minecraft-forge
MCP 服务器，用于 Forge Minecraft 模组文档，为 AI 助手提供直接访问 Forge 文档的权限，并具有结构化的搜索结果。
## 功能
- **文档搜索**: 跨所有 Forge 版本（1.12.x - 1.21.x）的全文搜索
- **结构化结果**: 返回标题、类别、URL 和内容预览
- **代码示例**: 单独提取代码块以便轻松访问
- **多版本支持**: 支持 12 个 Forge 版本
- **自动索引**: 文档通过 GitHub Actions 每周自动重新索引
- **离线支持**: 初始索引后完全离线支持
## 数据库统计
- **731 篇文档**，涵盖 12 个 Forge 版本（1.12.x - 1.21.x）
- **4,536 个可搜索的区块**（标题、章节、代码块）
- **1,750 个代码示例**
## 安装
### 从 NPM 安装
```bash
npm install -g @hayrem_/mcp-minecraft-forge
```
### 从 GitHub 安装
```bash
git clone https://github.com/Hayremyt/mcp-minecraft-forge.git
cd mcp-minecraft-forge
npm install -g
```
## 配置 AI 客户端
将以下内容添加到您的 MCP 客户端配置文件中：
```json
{
"mcp": {
"forge": {
"type": "local",
"command": ["mcp-minecraft-forge"],
"enabled": true
}
}
}
```
## 可用工具
| 工具 | 描述 |
|------|-------------|
| `search_forge_docs` | 搜索 Forge 文档，可选类别和版本过滤 |
| `get_example` | 获取特定主题的代码示例 |
| `explain_forge_concept` | 获取 Forge 概念的详细解释 |
| `list_forge_versions` | 列出所有可用的 Forge 版本 |
| `get_database_stats` | 获取数据库统计信息 |
## 自动索引
文档通过 GitHub Actions 每周日 00:00 UTC 自动重新索引。
或在本地：
```bash
npm run index-docs
```
## 项目结构
```
mcp-minecraft-forge/
├── .github/workflows/index-docs.yml # 每周自动索引
├── data/
│ └── forge-docs.db # SQLite 数据库（10 MB）
├── dist/ # 编译后的 JavaScript
├── src/
│ ├── index.ts # MCP 服务器入口
│ ├── services/
│ │ ├── database.ts # SQLite 操作
│ │ └── search-service.ts # 搜索逻辑
│ └── tools/ # MCP 工具处理程序
├── scripts/
│ ├── index-docs.ts # 文档索引器
│ └── postinstall.js # 安装后脚本
└── package.json
```
## 许可证
MIT
