使用说明
项目简介
FreeCAD MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在桥接 LLM 客户端和 FreeCAD 软件。它允许用户通过自然语言指令,利用 LLM 客户端控制 FreeCAD 进行 3D 建模、零件设计等 CAD 任务。该服务器提供了一系列工具,使 LLM 能够创建、编辑和查询 FreeCAD 中的 3D 模型,极大地扩展了 LLM 在工程设计领域的应用能力。
主要功能点
- FreeCAD 控制: 通过 LLM 指令远程控制 FreeCAD 软件,实现自动化 CAD 操作。
- 3D 建模: 支持创建和编辑 FreeCAD 中的 3D 模型,包括几何形状、零件和装配体。
- 零件库集成: 访问和插入 FreeCAD 零件库中的预定义零件,加速设计流程。
- Python 脚本执行: 允许 LLM 执行自定义 Python 代码,实现更复杂和定制化的 FreeCAD 操作。
- 模型信息查询: 能够获取 FreeCAD 文档和对象的信息,为 LLM 提供上下文感知能力。
安装步骤
- 安装 FreeCAD: 确保您的系统中已安装 FreeCAD 软件。
- 安装 FreeCAD MCP Addon:
- 下载或克隆此 GitHub 仓库。
- 将 'addon/FreeCADMCP' 目录复制到 FreeCAD 的插件目录。不同操作系统插件目录位置如下:
- Windows: '%APPDATA%\FreeCAD\Mod'
- Mac: '~/Library/Application Support/FreeCAD/Mod/'
- Linux: '~/.FreeCAD/Mod/' 或 '~/snap/freecad/common/Mod/' (如果 FreeCAD 通过 snap 安装)
- 重启 FreeCAD 软件,并在工作台列表中选择 "MCP Addon" 工作台。
- 在 "FreeCAD MCP" 工具栏中,点击 "Start RPC Server" 启动 RPC 服务器。
- 安装 MCP Server:
- 克隆此 GitHub 仓库。
- 进入 'src/freecad_mcp' 目录。
- 运行 MCP 服务器脚本:'python server.py'
服务器配置
为了使 MCP 客户端能够连接到 FreeCAD MCP Server,您需要在 MCP 客户端的配置文件中添加服务器配置信息。以下是一个 JSON 格式的配置示例,您需要根据实际情况进行调整:
{ "mcpServers": { "freecad": { "command": "python", "args": [ "src/freecad_mcp/server.py" ] } } }
- 'server name': 您可以自定义服务器名称,例如 "freecad"。
- 'command': 启动服务器的命令,通常为 'python'。
- 'args': 命令的参数,指向服务器脚本 'src/freecad_mcp/server.py' 的路径。请确保路径与您的本地文件系统路径一致。
基本使用方法
- 确保 FreeCAD 软件中的 "MCP Addon" 工作台的 RPC 服务器已启动。
- 启动 MCP Server ('python server.py')。
- 配置 MCP 客户端,使其连接到运行中的 FreeCAD MCP Server。
- 通过 MCP 客户端,您可以调用预定义的工具(例如 'create_document', 'create_object', 'edit_object' 等)来控制 FreeCAD 执行各种 CAD 操作。具体的工具使用方法和参数,请参考 'src/freecad_mcp/server.py' 文件中工具函数的描述。
信息
分类
桌面与硬件