README
🚀 Minecraft RCON MCP 服务器
本项目是一个基于 Spring Boot 的应用程序,它在 Model Context Protocol (MCP) 和 Minecraft 服务器 RCON 接口之间搭建了一座桥梁。借助它,AI 模型能够向 Minecraft 服务器发送命令,为 AI 与 Minecraft 服务器的交互提供了便利,且该项目使用 SpringAI 开发。
🚀 快速开始
本项目使运用 Spring AI 的 MCP 功能的 AI 模型,能够借助 RCON 协议与 Minecraft 服务器进行交互。它提供了一个简便的工具,可向 Minecraft 服务器发送命令并接收响应,从而让 AI 模型实现对 Minecraft 服务器的控制与查询。
✨ 主要特性
- 作为 MCP 和 Minecraft 服务器 RCON 接口的桥梁,实现 AI 模型与 Minecraft 服务器的交互。
- 提供简单工具,支持向 Minecraft 服务器发送命令并接收响应。
- 可通过环境变量或
.env文件进行灵活配置。
📦 安装指南
先决条件
- Java 21 或更高版本
- Maven 3.6 或更高版本
- 启用 RCON 的 Minecraft 服务器
构建项目
- 克隆仓库:
git clone https://github.com/yourusername/minecraft-rcon-mcp.git
cd minecraft-rcon-mcp
- 使用 Maven 构建项目: 在 Linux 或 macOS 上:
./mvnw clean package
在 Windows 上:
mvnw.cmd clean package
- 构建好的 JAR 文件位于
target目录中:
target/minecraft-rcon-mcp-1.0.0.jar
🔧 配置
应用程序可通过环境变量或项目根目录中的 .env 文件进行配置。
必填环境变量配置
| 属性 | 详情 |
|------|------|
| RCON_HOST | Minecraft 服务器的主机名或 IP 地址(默认:localhost) |
| RCON_PORT | Minecraft 服务器的 RCON 端口(默认:25575) |
| RCON_PASSWORD | RCON 认证密码(必需,无默认值) |
可选配置
| 属性 | 详情 |
|------|------|
| logging.file.name | 日志文件的名称(默认:rconmcp.log) |
💻 使用示例
构建完成后,将应用程序添加到 MCP 客户端,并指定您的环境变量,它将暴露一个 MCP 服务器,Spring AI 客户端可以使用该服务器向 Minecraft 服务器发送命令。
MCP 服务器提供了一个名为 sendCommand 的工具,该工具接受 Minecraft 命令作为输入并返回来自服务器的响应。
📄 许可证
本项目采用 MIT License。
微信扫一扫