MCP 服务器

MCSS MCP Server

用于 MCSS (Minecraft 服务器软体) 的模型上下文协议服务器

largeorbitalobject

开发者工具

README

MCSS MCP 服务器

一个模型上下文协议 (MCP) 服务器，用于通过 MCSS (Minecraft 服务器软件) API 控制 Minecraft 服务器。此工具可以使用像 Claude Desktop 这样的 MCP 客户端与您的 Minecraft 服务器进行无缝交互。

🌟 功能

服务器管理
- 列出由 MCSS 管理的所有 Minecraft 服务器
- 获取有关特定服务器的详细信息
- 执行电源操作（启动、停止、重启、杀死）
- 执行 Minecraft 命令
- 实时查看服务器控制台输出
- 更新服务器设置（名称、描述、崩溃处理等）
备份管理
- 列出可用的备份
- 创建新的备份配置
- 按需运行备份
计划任务管理
- 列出计划的任务
- 创建新的计划任务（命令、备份、服务器操作）
- 更新现有任务
- 删除任务
- 按需运行任务

📋 前提条件

Python 3.10 或更高版本
启用了 Web API 的 MCSS (Minecraft 服务器软件)
MCSS Web API 的 API 密钥
Claude Desktop（用于 MCP 客户端功能）

🚀 快速开始

安装

克隆此存储库：

git clone https://github.com/largeorbitalobject/mcss-mcp-server.git
cd mcss-mcp-server

创建并激活一个虚拟环境：

python -m venv venv
# 在 Windows 上
.\venv\Scripts\activate
# 在 Linux/Mac 上
source venv/bin/activate

安装所需的依赖项：

pip install mcp[cli] httpx python-dotenv

配置

在项目根目录中创建一个 .env 文件：

MCSS_HOST=your_mcss_host_ip
MCSS_PORT=25560
MCSS_API_KEY=your_mcss_api_key

配置 Claude Desktop 以使用此 MCP 服务器：
- 打开您的 Claude Desktop 配置文件：
  - Windows: %AppData%\Claude\claude_desktop_config.json
  - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- 添加以下配置：
```
{
  "mcpServers": {
    "mcss-control": {
      "command": "C:\\path\\to\\mcss-mcp-server\\run_mcss_mcp.bat",
      "args": []
    }
  }
}
```
- 将路径替换为您系统上批处理文件的实际路径

🔧 在 Claude Desktop 中使用 MCP 工具

启动 Claude Desktop 后，服务器将自动启动，您可以使用以下工具：

服务器管理

get_servers()

返回由 MCSS 管理的所有 Minecraft 服务器的列表。

get_server_details(server_id)

返回有关特定服务器的详细信息。

edit_server(server_id, name=None, description=None, is_set_to_auto_start=None, force_save_on_stop=None, java_allocated_memory=None, keep_online=None)

更新特定 Minecraft 服务器的设置。 keep_online 参数控制崩溃处理（0=无，1=提升，2=激进）。

execute_server_action(server_id, action)

在服务器上执行电源操作。有效的操作：start、stop、restart、kill。

execute_server_command(server_id, command)

在服务器上执行 Minecraft 命令。

get_server_console(server_id, lines=50)

返回服务器的控制台输出。

备份管理

get_backups(server_id)

返回服务器的备份列表。

create_backup(server_id, name, description="", compression=None)

创建一个新的备份配置。

run_backup(server_id, backup_id)

运行服务器的备份。

计划任务管理

get_scheduler_tasks(server_id)

返回服务器的计划任务列表。

create_scheduler_task(server_id, name, enabled=True, ...)

创建一个新的计划任务。

update_scheduler_task(server_id, task_id, name=None, ...)

更新现有的计划任务。

delete_scheduler_task(server_id, task_id)

删除一个计划任务。

run_scheduler_task(server_id, task_id)

立即运行一个计划任务。

📁 项目结构

mcss-mcp-server/
├── mcss_mcp/                # 主包
│   ├── __init__.py          # 包初始化
│   └── server.py            # MCP 服务器实现
├── main.py                  # 入口点脚本
├── run_mcss_mcp.bat         # 运行服务器的批处理脚本
├── .env                     # 环境变量（不在仓库中）
└── README.md                # 此文件