返回 MCP 目录
public公开dns本地运行

mcp-gs-robot

该项目实现了一个MCP服务器,作为与Gausium机器人OpenAPI交互的桥梁,支持查询机器人状态、任务报告和地图等功能。

article

README

🚀 Gausium OpenAPI MCP 服务器

该项目实现了一个 MCP(模型控制协议)服务器,它作为与 Gausium OpenAPI 的桥梁,允许 AI 模型或其他客户端借助标准化接口与高斯机器人进行交互。

仓库:https://github.com/cfrs2005/mcp-gs-robot

🚀 快速开始

环境要求

  • Python 3.6+

安装依赖

pip install python-sseclient requests

运行步骤

  1. 克隆仓库:
git clone https://github.com/cfrs2005/mcp-gs-robot.git
cd mcp-gs-robot
  1. 安装依赖:
pip install -r requirements.txt
  1. 设置环境变量(在终端中):
export GS_CLIENT_ID="your_client_id"
export GS_CLIENT_SECRET="your_client_secret"
export GS_OPEN_ACCESS_KEY="your_access_key"
  1. 运行服务器:
python main.py

默认情况下,此命令启动使用 SSE 传输的服务器,绑定地址为http://0.0.0.0:8000。您可以在main.py中修改传输类型为 stdio。

✨ 主要特性

服务器遵循分层架构,分离关注点并促进维护:

架构图

MCP 协议流程

下图显示了 AI 模型如何通过 MCP 协议与高斯机器人交互:

MCP 协议流程

当前服务器支持以下功能作为 MCP 工具:

📦 安装指南

环境要求

  • Python 3.6+

安装依赖

pip install python-sseclient requests

运行步骤

  1. 克隆仓库:
git clone https://github.com/cfrs2005/mcp-gs-robot.git
cd mcp-gs-robot
  1. 安装依赖:
pip install -r requirements.txt
  1. 设置环境变量(在终端中):
export GS_CLIENT_ID="your_client_id"
export GS_CLIENT_SECRET="your_client_secret"
export GS_OPEN_ACCESS_KEY="your_access_key"
  1. 运行服务器:
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 服务器交互的示例:

Cursor 使用截图

调试

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

以下是服务器运行时的日志输出示例:

MCP 调试截图

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端