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

ros2mcp

ROS2MCP是一个将ROS 2服务和主题转换为MCP工具和资源的项目,支持在Linux、macOS和Windows上运行,并通过MCP协议与客户端交互。

article

README

🚀 ros2mcp

ros2mcp 可将任意 ROS 2 服务和主题作为 MCP 工具公开,并将主题列为资源。

ROS 到 MCP 转换示例

mcp_server 节点可以将任何 ROS 主题和服务转换为 MCP 资源或工具(包括将源注释作为参数描述)。

🚀 快速开始

📦 安装指南

本项目的演示可以在 Linux、macOS 和 Windows 系统上使用 Pixi 运行。具体步骤如下:

  1. 克隆仓库:
git clone https://github.com/nico0302/ros2mcp.git

💻 使用示例

基础用法

  1. 启动 Gazebo 和 Rviz2:
pixi run start-tb4

首次运行时,由于需要下载必要的资源,这可能需要一些时间。

  1. 在 Gazebo 和 Rviz2 启动后,在 Rviz2 中选择 2D Pose Estimate 工具,通过在地图中心点击并向右拖动来设置机器人的初始位置: Rviz2 选择 2D 姿态估计

  2. 启动 MCP 服务器和演示节点(这也会运行 build):

pixi run demo-tb4
  1. 将 MCP 客户端连接到位于 http://localhost:8080 的演示服务器。本项目包含一个简单的 MCP 客户端,可以使用以下命令运行:
# 确保设置了 OPENAI_API_KEY 环境变量
export OPENAI_API_KEY=your_openai_api_key
pixi run demo-client
help

运行方式说明

cloud

托管运行

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

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

本地运行 / 其它方式

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

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