• 项目简介 'rde-urdf' 是一个功能丰富的 Visual Studio Code 扩展,旨在为统一机器人描述格式 (URDF)、Xacro 文件和 OpenSCAD 设计提供全面的开发工具。它包括实时3D预览、语法高亮、代码补全、碰撞可视化、摄像头控制等功能。此外,它还集成了一个 MCP 服务器,允许AI助手(如GitHub Copilot)通过调用工具来获取模型的视觉反馈(截图)和 OpenSCAD 库的文档,从而辅助机器人的设计和验证过程。

  • 主要功能点

    • URDF/Xacro/OpenSCAD 3D 预览: 实时查看机器人模型的3D渲染,支持链接、关节、颜色自定义、相机控制和Gizmos。
    • 代码辅助: 提供语法高亮、代码补全、Schema验证和AI辅助编码提示。
    • OpenSCAD 集成: 支持 OpenSCAD 文件渲染、语法高亮以及自动生成库文档。
    • MCP 服务器: 内置一个 MCP 服务器,为AI助手提供以下能力:
      • 截屏工具 ('take_screenshot'): 允许AI对当前活动的URDF/Xacro/OpenSCAD预览进行截图,以进行视觉验证。
      • 文件截屏工具 ('take_screenshot_by_filename'): 允许AI根据文件名对指定文件进行截图,即使该文件当前未在活跃预览中。
      • OpenSCAD 库文档访问 ('get_openscad_libraries'): AI可以获取所有已配置的OpenSCAD库的详细文档,包括模块、函数及其参数,帮助AI理解和生成OpenSCAD代码。
    • VR 预览: 支持在WebXR环境中预览正在编辑的模型。
    • ROS 包路径管理: 自动发现并允许配置ROS包搜索路径。
  • 安装步骤

    1. 打开 Visual Studio Code。
    2. 进入扩展视图 (快捷键 'Ctrl+Shift+X')。
    3. 在搜索框中输入 "rde-urdf" 或 "Robot Developer Extensions for URDF"。
    4. 找到该扩展并点击 "安装" 按钮。
    5. 安装完成后,重新启动 VS Code 以确保所有功能正常加载。
  • 服务器配置 (供 MCP 客户端使用) 'rde-urdf' 扩展内置的 MCP 服务器是一个嵌入式服务器,它不会作为独立的进程运行。当您在 VS Code 中打开一个 URDF、Xacro 或 OpenSCAD 文件的 预览 时,该服务器会自动启动并监听 HTTP 端口。MCP 客户端可以通过以下 JSON 配置连接到此服务器:

    {
      "name": "URDF",
      "command": "code",
      "args": ["<PATH_TO_YOUR_PROJECT_FOLDER>", "--extension-id", "ranch-hand-robotics.rde-urdf"],
      "attach": {
        "type": "http",
        "url": "http://localhost:3005/mcp"
      }
    }
    • 'name': MCP 服务器的名称,此处为 "URDF"。
    • 'command': 启动 Visual Studio Code 的命令,通常是 'code' (假设已添加到系统 PATH)。
    • 'args': 启动 VS Code 时所需的参数。
      • '<PATH_TO_YOUR_PROJECT_FOLDER>': 替换为您包含 URDF、Xacro 或 OpenSCAD 文件的项目文件夹路径。此操作将打开您的项目,确保扩展被激活。
      • '--extension-id ranch-hand-robotics.rde-urdf': 显式激活 'rde-urdf' 扩展。
      • 重要提示: 即使 VS Code 被启动,MCP 服务器也只会在您在 VS Code 中手动打开一个 URDF/Xacro/OpenSCAD 文件的 预览 后才会启动。MCP 客户端需要等待用户执行此操作。
    • 'attach': 定义 MCP 客户端如何连接到服务器。
      • 'type': 连接类型,此处为 "http"。
      • 'url': MCP 服务器的监听地址。默认端口为 '3005',可以在 VS Code 设置中通过 'urdf-editor.mcpServerPort' 进行配置。
  • 基本使用方法

    1. 打开文件: 在 VS Code 中打开一个 '.urdf'、'.xacro' 或 '.scad' 文件。
    2. 启动预览: 右键点击文件,选择 "Preview";或者按下 'Ctrl+Shift+P' (在macOS上是 'Cmd+Shift+P'),然后输入 "URDF: Create Preview" 并选择它。这将在侧边栏打开一个3D预览窗口,并自动启动内置的 MCP 服务器。
    3. AI 助手交互:
      • 当您与 AI 助手(如 GitHub Copilot Chat)交互时,AI 可以调用 'take_screenshot' 工具获取当前预览的截图,以验证其生成的代码。
      • AI 还可以调用 'get_openscad_libraries' 工具获取 OpenSCAD 库的文档,以更好地理解可用功能并生成正确的 OpenSCAD 代码。
      • 'take_screenshot_by_filename' 工具允许AI通过提供文件路径来获取特定文件的截图,即使该文件当前未在活跃预览中。

信息

分类

开发者工具