README
🚀 Minecraft Developer MCP
Minecraft Developer MCP是一款轻量级的MCP桥接工具,适用于Spigot和Paper服务器。它通过HTTP协议提供控制台访问、文件读写、插件信息查询以及日志获取等功能,让外部工具无需借助FTP或屏幕共享,就能实现服务器管理自动化。
🚀 快速开始
1. 安装插件
从发布页面下载最新的JAR文件,并将其放入plugins/文件夹中。
2. 配置与安全设置
启动一次服务器以生成配置文件。编辑plugins/MCPMinecraft/config.yml:
server:
port: 25374 # 选择一个开放的端口(确保主机允许该端口)
token: "CHANGE-THIS-TO-A-SECURE-RANDOM-TOKEN"
⚠️ 重要提示
任何拥有此令牌的人都可以访问控制台。请设置一个长且随机的令牌。
3. 连接MCP客户端(示例配置)
将以下内容放入mcp.json文件中(通常位于~/.cursor/mcp.json):
{
"mcpServers": {
"minecraft": {
"url": "http://YOUR-SERVER-IP:25374/sse?token=YOUR-SECURE-TOKEN",
"transport": "sse"
}
}
}
对于脚本编写或自动化操作,也可以使用同步的/api端点:
curl -X POST "http://YOUR-SERVER-IP:25374/api?token=YOUR-TOKEN" \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"list_plugins","arguments":{}}}'
4. 使用方法
- 备份
whitelist.json,然后添加jeb_。 - 读取
bukkit.yml并调整怪物生成限制。 - 在执行命令前后查看最新的日志条目。
✨ 主要特性
- 执行控制台命令并返回捕获的输出。
- 读取或编辑服务器目录内的任何文本文件。
- 通过base64上传或下载二进制文件(适用于JAR文件或图像)。
- 列出已安装的插件及其版本。
- 从
logs/latest.log中获取最后100行日志。 - 列出任何目录中的文件及其大小。
📦 工具与示例请求
| 工具 | 描述 | 示例请求 |
|------|------|------|
| execute_command | 执行任何控制台命令并捕获输出。 | 给 'Notch' 一把名为 'Excalibur' 的钻石剑。 |
| read_file | 读取服务器目录中的任何文本文件(配置文件、日志、数据)。 | 读取 plugins/Essentials/config.yml 并显示聊天格式。 |
| write_file | 创建或编辑文件。 | 创建 plugins/Skript/scripts/welcome.sk,用于在玩家加入时进行欢迎。 |
| list_plugins | 列出已安装的插件和版本。 | 检查 WorldGuard 是否启用并为最新版本。 |
| get_logs | 获取latest.log的最后100行。 | 获取最近的日志以查看服务器卡顿的原因。 |
| write_file_base64 | 通过base64上传二进制文件。 | 将 SuperSword.jar 上传到 plugins/ 并确认大小。 |
| read_file_base64 | 以base64格式下载二进制文件。 | 以base64格式返回 world/icon.png。 |
| list_directory | 列出文件夹中的文件及其大小。 | 列出 world/region 中的所有文件。 |
📚 详细文档
无额外端口时的故障排除
如果主机不允许打开额外端口(例如某些免费主机提供商),可以使用如playit.gg这样的隧道服务:
- 在服务器上安装playit.gg插件。
- 创建一个指向
127.0.0.1:25374(或你配置的任何本地端口)的自定义TCP隧道。 - 在
mcp.json中使用playit提供的公共地址(例如agent-tunnel.playit.gg:12345)。
从源代码构建
git clone https://github.com/center2055/MinecraftDeveloperMCP.git
cd MinecraftDeveloperMCP
mvn clean package
打包后的JAR文件将位于target/目录中。
扫码联系在线客服