
MCP Server for Minecraft Mod Documentation

2025.05.04
0
PythonMinecraft 模组开发文档查阅开发效率
MCP Server for Minecraft Mod Documentation 是一个基于 Model Context Protocol (MCP) 的服务器,专门用于查看 Minecraft 模组开发文档。目前支持 Neoforge 文档,并设计为可扩展以支持其他文档源(如 Fabric)。该服务器提供了获取文档提供者和版本列表、查看文档文件结构和预览、获取完整内容等功能,旨在为 Minecraft 模组开发者提供便捷的文档查阅体验。
View on GitHub
Overview
基本能力
产品定位
该 MCP 服务器专注于为 Minecraft 模组开发者提供便捷的文档查阅服务,支持多种文档源,并可通过 MCP 协议与各种客户端集成。
核心功能
- 获取提供者和版本列表:列出所有可用的文档提供者及其版本。
- 获取文件结构和预览:查看指定版本的文档文件结构,包括目录和文件,并显示每个文件的前几段内容作为预览。
- 获取完整内容:获取文档文件的完整内容。
- 自动管理本地仓库:只在必要时(首次使用或上次更新超过24小时)更新仓库内容。
适用场景
- Minecraft 模组开发过程中快速查阅相关文档。
- 需要了解不同版本 Minecraft 模组开发 API 的差异。
- 在支持 MCP 的客户端(如 Claude Desktop、VS Code 等)中集成文档查阅功能。
工具列表
- get_providers:获取文档提供者及其版本列表。
- get_structure:获取指定版本的文档文件结构和预览。
- get_full_content:获取文档文件的完整内容。
常见问题解答
- 无法获取文档内容:
- 确保已安装 Git 并可正常使用。
- 检查仓库目录是否存在并包含正确内容。
-
确保有权限读取仓库目录中的文件。
-
服务器无法启动:
- 确保已安装所有必要的依赖。
- 检查端口是否被其他应用程序占用。
使用教程
使用依赖
确保已安装 Python 3.12+ 和 Git。
# 检查 Python 版本
python --version
# 检查 Git 是否安装
git --version
安装教程
- 克隆仓库或下载源代码。
- 安装依赖:
pip install -r requirements.txt
- 运行服务器:
python -m src.mcp_server_minecraft_mod_devdoc.main
调试方式
- 检查服务器是否正常运行:
# 检查进程是否运行
ps aux | grep mcp_server_minecraft_mod_devdoc
# 检查端口占用情况
netstat -tuln | grep <port>
- 查看日志文件以排查问题。