Minecraft Docker MCP 使用说明

项目简介

Minecraft Docker MCP 是一个基于 Model Context Protocol (MCP) 的服务器实现,专为 Docker 容器化的 Minecraft 服务器设计。它利用 Minecraft 服务器的 RCON 功能,将服务器的管理和交互能力以 MCP 工具的形式暴露出来,使得 AI 客户端(如 Claude Desktop, Cursor, Zed 等)能够方便地与 Minecraft 服务器进行通信和控制。

主要功能点

  • RCON 命令执行: 允许 AI 客户端通过 'rcon' 工具执行任何 Minecraft RCON 命令,实现对服务器的精细控制。
  • 玩家列表查询: 通过 'list_players' 工具获取当前在线玩家列表。
  • 命令帮助查询: 通过 'help' 工具查询 Minecraft 命令的帮助信息。
  • 服务器状态监控: 通过 'server_stats' 工具获取服务器的 CPU、内存使用情况和运行时间等统计信息。
  • 服务器日志查看: 通过 'server_logs' 工具查看最近的服务器日志,便于问题排查。
  • 服务器运行状态检查: 通过 'check_server_status' 工具检查 Minecraft 服务器是否正在运行且响应正常。

安装步骤

  1. 前提条件: 确保你已经运行了一个名为 'mc' 的 Docker Minecraft 服务器容器,并且 RCON 功能已启用并正确配置。你可以参考仓库 README 中的 Docker 运行命令来启动 Minecraft 服务器。
  2. 克隆仓库: 将此 GitHub 仓库克隆到本地。
    git clone https://github.com/rgbkrk/rcon-mcp.git
    cd rcon-mcp
  3. 安装 MCP 工具: 使用 MCP 命令行工具 (MCP CLI) 安装 'rcon.py' 文件。
    mcp install rcon.py
    注意: 此步骤假设你已经安装并配置了 MCP CLI 工具。

服务器配置 (MCP 客户端配置)

为了让 MCP 客户端连接到 Minecraft Docker MCP 服务器,你需要提供以下配置信息。这些配置信息通常在 MCP 客户端的设置中进行配置,以 JSON 格式提供。

{
  "serverName": "Minecraft Admin Server",
  "command": "python",
  "args": ["rcon.py"]
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义,例如 "Minecraft Admin Server"。这将在 MCP 客户端中显示为服务器名称。
  • 'command': 启动 MCP 服务器的命令。由于 'rcon.py' 是一个 Python 脚本,所以这里使用 'python' 命令来执行它。
  • 'args': 启动命令的参数。这里指定要运行的 Python 脚本为 'rcon.py'。

关键信息:

  • 运行环境: MCP 服务器需要在可以访问 Docker 命令的环境中运行,因为它依赖 Docker 命令来与 Minecraft 服务器容器交互。
  • RCON 配置: 确保你的 Minecraft 服务器容器 ('mc') 已经正确配置了 RCON 功能,包括启用 RCON、设置 RCON 端口和密码。
  • MCP 客户端: 你需要使用支持 MCP 协议的客户端,例如 Claude Desktop, Cursor 或 Zed 等,并按照客户端的指引配置上述服务器连接信息。

基本使用方法

  1. 启动 MCP 服务器: 在安装步骤完成后,当 MCP 客户端尝试连接时,MCP CLI 工具会自动启动 'rcon.py' 脚本作为 MCP 服务器。
  2. 连接 MCP 客户端: 在 MCP 客户端中,使用之前配置的服务器连接信息('serverName', 'command', 'args')连接到 Minecraft Docker MCP 服务器。
  3. 使用 MCP 工具: 连接成功后,你可以在 MCP 客户端中看到 Minecraft Docker MCP 服务器提供的工具,例如 'rcon', 'list_players', 'help' 等。根据工具的描述和参数,即可通过客户端调用这些工具来与 Minecraft 服务器进行交互,例如执行 RCON 命令、查询玩家列表等。

示例: 在 MCP 客户端中,你可以调用 'rcon' 工具并输入 Minecraft RCON 命令,例如 'list' 来查看在线玩家,或者输入 'say hello' 来向所有玩家发送消息。你也可以使用 'help' 工具来查询 Minecraft 命令的用法,例如 'help summon' 来获取 'summon' 命令的帮助信息。

信息

分类

开发者工具