article
README
🚀 MCSS MCP 服务器
一个借助 MCSS(Minecraft 服务器软件)API 来控制 Minecraft 服务器的 MCP(模型上下文协议)服务器。该工具能让您使用像 Claude Desktop 这样的 MCP 客户端,与您的 Minecraft 服务器实现无缝交互。
🚀 快速开始
📦 安装
- 克隆此仓库:
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:%home%/.config/Claude/claude_desktop_config.json%
- 添加以下配置:
{
"mcpServers": {
"mcss-control": {
"command": "C:\\path\\to\\mcss-mcp-server\\run_mcss_mcp.bat",
"args": []
}
}
}
- 将路径替换为您系统上实际的批处理文件路径
✨ 主要特性
服务器管理
- 列出所有由 MCSS 管理的 Minecraft 服务器
- 获取特定服务器的详细信息
- 执行电源操作(启动、停止、重启、终止)
- 执行 Minecraft 命令
- 实时查看服务器控制台输出
- 更新服务器设置(名称、描述、崩溃处理等)
备份管理
- 列出可用备份
- 创建新的备份配置
- 在需要时运行备份
调度程序管理
- 列出计划任务
- 创建新的计划任务(命令、备份、服务器操作)
- 更新现有任务
- 删除任务
- 在需要时运行任务
💻 使用示例
基础用法
在 Claude Desktop 中使用 MCP 工具,一旦启动 Claude Desktop,服务器将自动开始运行,您可以使用以下代码示例:
服务器管理
# 返回所有由 MCSS 管理的 Minecraft 服务器的列表
get_servers()
# 返回特定服务器的详细信息
get_server_details(server_id)
# 更新指定服务器的设置
set_server_settings(server_id, settings)
# 重启指定服务器
restart_server(server_id)
# 关闭指定服务器
shutdown_server(server_id)
备份管理
# 为指定服务器创建备份
create_backup(server_id)
# 删除指定服务器的特定备份
delete_backup(server_id, backup_id)
# 返回指定服务器的所有备份列表
get_backups(server_id)
调度程序管理
# 为指定服务器创建新的计划任务
create_schedule(server_id, schedule)
# 删除指定服务器的特定计划任务
delete_schedule(server_id, schedule_id)
# 返回指定服务器的所有计划任务列表
get_schedules(server_id)
# 立即运行指定服务器的特定计划任务
run_schedule(server_id, schedule_id)
📚 详细文档
项目结构
mcss-mcp-server/
├── mcss_mcp/ # 主包
│ ├── __init__.py # 包初始化
│ └── server.py # MCP 服务器实现
├── main.py # 入口脚本
├── run_mcss_mcp.bat # 批处理脚本以运行服务器
├── .env # 环境变量(不在代码库中)
└── README.md # 此文件
🤝 贡献
欢迎贡献!请随意提交 Pull Request。
📄 许可证
此项目根据 MIT License 许可 - 有关详细信息,请参阅 LICENSE 文件。
🙏 感谢
- MCSS 提供了 Minecraft 服务器管理软件
- MCP 提供了模型上下文协议规范
- Claude Desktop 提供了 MCP 客户端实现
微信扫一扫