article
README
🚀 创世记 MCP 服务器
一个用于创世记世界模拟的模型上下文协议(MCP)服务器,支持可视化功能,能为用户提供直观的创世记世界模拟体验。
🚀 快速开始
要快速开始使用可视化功能,可按以下步骤操作:
# 运行简化的设置脚本(仅安装所需的组件)
./setup.sh
# 运行 stdio 客户端(打开一个可视化窗口)
./examples/stdio_client.py
这将直接启动创世记世界模拟,并通过 stdio 传输开始可视化。
✨ 主要特性
- 可视化功能:支持创世记世界模拟的可视化,让用户更直观地感受模拟过程。
- stdio 传输:使用 stdio 传输,是实现可视化功能的必要条件。
📦 安装指南
先决条件
- Python 3.8+
- uv 包管理器(
pip install uv) - npm(可选,用于 MCP 绝缘检测)
安装步骤
Linux/macOS
# 克隆仓库
git clone https://github.com/username/genesis-mcp.git
cd genesis-mcp
# 运行设置脚本
./setup.sh
# 激活虚拟环境
source .venv/bin/activate
Windows
# 克隆仓库
git clone https://github.com/username/genesis-mcp.git
cd genesis-mcp
# 运行设置脚本
setup.bat
# 激活虚拟环境
.venv\Scripts\activate.bat
手动安装(使用 uv)
如果您倾向于手动安装依赖项,可以按以下步骤操作:
- 创建一个虚拟环境:
uv venv .venv
source .venv/bin/activate # Linux/macOS
.venv\Scripts\activate.bat # Windows
- 从锁定文件安装依赖项:
uv pip install -r requirements.lock
uv pip install -e .
uv pip install genesis==0.2.1 --no-deps
- 安装 MCP 绝缘检测(可选):
npm install -g @modelcontextprotocol/inspector@0.6.0
💻 使用示例
基础用法
运行服务器
# 使用 stdio 传输运行(可视化功能所必需)
./start.sh
使用 MCP 绝缘检测进行调试
要与 MCP 绝缘检测一起使用,可按以下步骤操作:
# 在一个终端中启动绝缘检测
mcp-inspector
# 在另一个终端中启动服务器并使用 stdio 传输
python server.py
配置绝缘检测如下:
- 传输类型:STDIO
- 命令:python
- 参数:server.py
高级用法
获取世界信息
获取创世记世界功能的信息:
world_info://{name}
运行模拟
使用提供的代码和参数运行创世记世界模拟:
run_simulation
运行 MCP 客户端
此仓库包含用于可视化的 stdio 客户端:
# 使用 Genesis World 可视化运行一个模拟
./examples/stdio_client.py
祝您愉快地使用!
微信扫一扫