使用说明

项目简介

本项目 'minecraft-mcp-server' 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为大型语言模型 (LLM) 提供与 Minecraft 游戏世界交互的能力。通过该服务器，LLM 可以控制 Minecraft 客户端执行诸如连接到服务器、发送聊天消息和断开连接等操作，从而实现基于 LLM 的 Minecraft 游戏自动化或交互应用。

主要功能点

连接 Minecraft 服务器: 允许 LLM 指示服务器连接到指定的 Minecraft 服务器。
发送聊天消息: 允许 LLM 控制 Minecraft 角色在游戏中发送聊天消息。
断开 Minecraft 服务器连接: 允许 LLM 指示服务器断开与 Minecraft 服务器的连接。

安装步骤

克隆仓库

git clone https://github.com/DennisTraub/minecraft-mcp-server.git
cd minecraft-mcp-server

安装依赖 确保你已经安装了 Node.js 和 npm。在项目根目录下运行：
```
npm install
```

服务器配置

MCP 客户端需要配置以下信息以连接到 'minecraft-mcp-server' 服务器。以下是一个 JSON 格式的配置示例，你可以将其填入 MCP 客户端的服务器配置中：

{
  "serverName": "minecraft-server",  // 服务器名称，可以自定义
  "command": "node",               // 启动服务器的命令，这里使用 node.js 运行时
  "args": [                         // 启动服务器的命令参数
    "src/index.js"                  // 指定服务器入口文件
  ]
}

配置参数说明:

'serverName': 为你的 MCP 服务器指定一个名称，例如 "minecraft-server"，这个名称将在 MCP 客户端中用于标识和选择该服务器。
'command': 运行服务器端代码的命令。由于该项目是 Node.js 项目，所以这里使用 'node' 命令来运行 JavaScript 文件。
'args': 命令参数数组，用于指定 'command' 命令的参数。这里 '"src/index.js"' 指定了服务器的入口文件路径。

注意:

确保你的系统环境变量中已经配置了 Node.js 的可执行路径，这样 MCP 客户端才能正确执行 'node' 命令。
运行 'src/index.js' 前，请确保已经按照 安装步骤 安装了项目依赖。

基本使用方法

启动 MCP 服务器: 配置好 MCP 客户端后，启动 MCP 客户端，它会自动根据配置启动 'minecraft-mcp-server'。
LLM 调用工具: 在 LLM 应用中，你可以指示 LLM 调用以下工具来与 Minecraft 服务器交互：
- connect: 连接到 Minecraft 服务器。可以指定 'name' 参数作为 Minecraft 角色名称。
- chat: 发送聊天消息。可以指定 'message' 参数作为要发送的消息内容。
- disconnect: 断开与 Minecraft 服务器的连接。可以指定 'message' 参数作为断开连接时发送的消息。

示例: 假设你的 LLM 客户端已经连接到 'minecraft-mcp-server'，你可以指示 LLM 调用 'chat' 工具发送消息 "Hello, Minecraft!"，客户端会向服务器发送如下格式的请求 (JSON-RPC 格式细节由 MCP 客户端和服务器 SDK 负责处理，用户无需关心底层协议细节):

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "chat",
    "arguments": {
      "message": "Hello, Minecraft!"
    }
  },
  "id": 1
}

服务器收到请求后，会将 "Hello, Minecraft!" 发送到连接的 Minecraft 服务器的游戏聊天中。

关键词