使用说明

项目简介

FreeCAD MCP Bridge 是一个基于 Model Context Protocol (MCP) 的服务器,它充当语言模型 (LLM) 客户端与 FreeCAD 之间的桥梁。通过这个桥梁,LLM 可以以标准化的方式与 FreeCAD 交互,实现 3D 建模、场景信息查询、以及执行 FreeCAD 的 Python 脚本,从而进行 CAD 自动化和智能设计。

主要功能点

  • 场景信息获取: 提供 'get_scene_info' 工具,允许 LLM 获取 FreeCAD 文档的详细信息,包括文档属性、对象列表、对象类型、位置、形状等。
  • 命令执行: 支持 'send_command' 工具,LLM 可以发送 FreeCAD Python 命令,直接控制 FreeCAD 环境。
  • 脚本运行: 支持 'run_script' 工具,LLM 可以执行任意 FreeCAD Python 脚本,实现复杂的建模操作和自动化流程。
  • 上下文感知: 在执行命令或脚本后,服务器会返回 FreeCAD 文档的上下文信息,使 LLM 能够理解操作结果和环境变化。
  • 标准 MCP 协议: 使用 JSON-RPC over Stdio 与 MCP 客户端通信,符合 MCP 标准,易于集成到各种 LLM 应用中。

安装步骤

  1. 安装 FreeCAD: 确保已安装 FreeCAD 软件,并能正常运行。
  2. 克隆仓库: 从 GitHub 克隆 'freecad_mcp' 仓库到本地。
  3. 安装为 FreeCAD 模块: 将 'freecad_mcp' 目录复制到 FreeCAD 的模块目录中。
    • Windows: '%APPDATA%/FreeCAD/Mod/'
    • Linux: '~/.FreeCAD/Mod/'
    • macOS: '~/Library/Preferences/FreeCAD/Mod/'
  4. 启动 FreeCAD MCP 服务器: 启动 FreeCAD 软件,在工作台切换器中选择 "FreeCAD MCP" 工作台。在 FreeCAD MCP 面板中,点击 "Start Server" 按钮,启动 FreeCAD 内部的 Socket 服务器。
  5. 运行 MCP Bridge 服务器: 打开终端,导航到克隆仓库的 'src' 目录,运行 'freecad_bridge.py' 脚本。例如,执行命令 'python src/freecad_bridge.py'。这将启动 MCP Bridge 服务器,它将作为 MCP 客户端与 LLM 应用通信,并作为 MCP 服务端与 FreeCAD Socket 服务器通信。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 FreeCAD MCP Bridge 服务器:

{
  "serverName": "freecad-bridge",
  "command": "python",
  "args": ["src/freecad_bridge.py"]
}
  • 'serverName': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器,例如 '"freecad-bridge"'。
  • 'command': 启动 MCP 服务器的命令,这里是 'python',假设您的 Python 环境已配置到系统路径中。
  • 'args': 命令参数列表,指定了 MCP Bridge 服务器脚本的路径 '["src/freecad_bridge.py"]'。

基本使用方法

  1. 启动服务器: 首先确保 FreeCAD 软件内的 MCP Socket 服务器(通过 FreeCAD MCP 工作台启动)和独立的 MCP Bridge 服务器 ('src/freecad_bridge.py') 都已成功运行。
  2. 连接 MCP 客户端: 配置您的 MCP 客户端(例如,LLM 应用程序),使用上述提供的服务器配置信息连接到 MCP Bridge 服务器。
  3. 调用工具: 在 MCP 客户端中,您可以调用 'send_command' 和 'run_script' 这两个工具,向 FreeCAD 发送命令或脚本。例如,使用 'send_command' 工具可以发送 FreeCAD 的 Python 命令来查询场景信息或操作对象;使用 'run_script' 工具可以执行更复杂的 Python 脚本来创建或修改 3D 模型。MCP 客户端发送的请求会通过 MCP Bridge 服务器转发到 FreeCAD,并将 FreeCAD 的响应返回给客户端。

信息

分类

桌面与硬件