README
🚀 Gausium OpenAPI MCP 服务器
该项目实现了一个 MCP(模型控制协议)服务器,它作为与 Gausium OpenAPI 的桥梁,允许 AI 模型或其他客户端借助标准化接口与高斯机器人进行交互。
仓库:https://github.com/cfrs2005/mcp-gs-robot
🚀 快速开始
环境要求
- Python 3.6+
安装依赖
pip install python-sseclient requests
运行步骤
- 克隆仓库:
git clone https://github.com/cfrs2005/mcp-gs-robot.git
cd mcp-gs-robot
- 安装依赖:
pip install -r requirements.txt
- 设置环境变量(在终端中):
export GS_CLIENT_ID="your_client_id"
export GS_CLIENT_SECRET="your_client_secret"
export GS_OPEN_ACCESS_KEY="your_access_key"
- 运行服务器:
python main.py
默认情况下,此命令启动使用 SSE 传输的服务器,绑定地址为http://0.0.0.0:8000。您可以在main.py中修改传输类型为 stdio。
✨ 主要特性
服务器遵循分层架构,分离关注点并促进维护:
MCP 协议流程
下图显示了 AI 模型如何通过 MCP 协议与高斯机器人交互:
当前服务器支持以下功能作为 MCP 工具:
list_robots:列出可通过 API 密钥访问的机器人。 (基于: 列出机器人 API)get_robot_status:通过序列号获取特定机器人的详细状态。(基于: 获取机器人状态 API)list_robot_task_reports:根据时间过滤,检索特定机器人任务报告。(基于: 列出机器人任务报告 API)list_robot_maps:检索特定机器人的地图列表。(基于: 列出机器人地图 API)
📦 安装指南
环境要求
- Python 3.6+
安装依赖
pip install python-sseclient requests
运行步骤
- 克隆仓库:
git clone https://github.com/cfrs2005/mcp-gs-robot.git
cd mcp-gs-robot
- 安装依赖:
pip install -r requirements.txt
- 设置环境变量(在终端中):
export GS_CLIENT_ID="your_client_id"
export GS_CLIENT_SECRET="your_client_secret"
export GS_OPEN_ACCESS_KEY="your_access_key"
- 运行服务器:
python main.py
默认情况下,此命令启动使用 SSE 传输的服务器,绑定地址为http://0.0.0.0:8000。您可以在main.py中修改传输类型为 stdio。
📚 详细文档
项目结构
代码目录的布局如下:
src/
├── gs_openapi/
│ ├── config.py
│ ├── client.py
│ └── tools/
│ ├── list_robots.py
│ ├── get_robot_status.py
│ ├── list_robot_task_reports.py
│ └── list_robot_maps.py
└── main.py
项目说明
- GS_CLIENT_ID:您的 Gausium 应用程序客户端 ID。
- GS_CLIENT_SECRET:您的 Gausium 应用程序客户端密钥。
- GS_OPEN_ACCESS_KEY:您的 Gausium OpenAPI 访问密钥。
请勿在代码中硬编码凭据,也请不要将它们提交到版本控制系统。
连接 MCP 客户端
服务器运行后,MCP 客户端(如 Cursor 或其他兼容工具)可以通过适当的传输协议(SSE 或 stdio)连接到该服务器以使用定义的工具。
使用示例:与 Cursor 配合使用
下图为 Cursor 如何与此 MCP 服务器交互的示例:

调试
您可以通过监控服务器日志来进行调试。main.py中的基本日志配置提供了时间戳、级别和来源信息。
以下是服务器运行时的日志输出示例:

Scan to join WeChat group