FreeCAD MCP (模型控制协议)

概述

FreeCAD MCP（模型控制协议）提供了一个简化接口，通过服务器-客户端架构与FreeCAD进行交互。这允许用户执行命令并检索有关当前FreeCAD文档和场景的信息。

https://github.com/user-attachments/assets/5acafa17-4b5b-4fef-9f6c-617e85357d44

配置

要配置MCP服务器，可以使用JSON格式来指定服务器设置。以下是一个示例配置：

{
    "mcpServers": {
        "freecad": {
            "command": "C:\\ProgramData\\anaconda3\\python.exe",
            "args": [
                "C:\\Users\\USER\\AppData\\Roaming\\FreeCAD\\Mod\\freecad_mcp\\src\\freecad_bridge.py"
            ]
        }
    }
}

配置详情

• command: 运行FreeCAD MCP服务器的Python可执行文件路径。这会根据您的操作系统而有所不同：

  • Windows: 通常看起来像这样 C:\\ProgramData\\anaconda3\\python.exe 或 C:\\Python39\\python.exe。
  • Linux: 可能是 /usr/bin/python3 或您Python安装的路径。
  • macOS: 通常是 /usr/local/bin/python3 或您Python安装的路径。

• args: 要传递给Python命令的参数数组。第一个参数应该是负责处理MCP服务器逻辑的 freecad_bridge.py 脚本的路径。确保根据您的安装调整路径。

不同操作系统的示例

Windows

{
    "mcpServers": {
        "freecad": {
            "command": "C:\\ProgramData\\anaconda3\\python.exe",
            "args": [
                "C:\\Users\\USER\\AppData\\Roaming\\FreeCAD\\Mod\\freecad_mcp\\src\\freecad_bridge.py"
            ]
        }
    }
}

Linux

{
    "mcpServers": {
        "freecad": {
            "command": "/usr/bin/python3",
            "args": [
                "/home/USER/.FreeCAD/Mod/freecad_mcp/src/freecad_bridge.py"
            ]
        }
    }
}

macOS

{
    "mcpServers": {
        "freecad": {
            "command": "/usr/local/bin/python3",
            "args": [
                "/Users/USER/Library/Preferences/FreeCAD/Mod/freecad_mcp/src/freecad_bridge.py"
            ]
        }
    }
}

功能

FreeCAD MCP目前支持以下功能：

1. get_scene_info

• 描述: 获取关于当前FreeCAD文档的全面信息，包括：
  • 文档属性（名称、标签、文件名、对象数量）
  • 对象详细信息（类型、位置、旋转、形状属性）
  • 草图数据（几何图形、约束条件）
  • 视图信息（相机位置、方向等）

2. run_script

• 描述: 在FreeCAD上下文中执行任意Python代码。这允许用户执行复杂操作，创建新对象，修改现有对象，并使用FreeCAD的Python API自动化任务。

使用示例

要使用FreeCAD MCP，您可以连接到服务器并发送命令如下：

import socket
import json

# 连接到FreeCAD MCP服务器
client = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
client.connect(('localhost', 9876))

# 示例：获取场景信息
command = {
    "type": "get_scene_info"
}
client.sendall(json.dumps(command).encode('utf-8'))

# 接收响应
response = client.recv(4096)
print(json.loads(response.decode('utf-8')))

# 示例：运行脚本
script = """
import FreeCAD
doc = FreeCAD.ActiveDocument
box = doc.addObject("Part::Box", "MyBox")
box.Length = 20
box.Width = 20
box.Height = 20
doc.recompute()
"""
command = {
    "type": "run_script",
    "params": {
        "script": script
    }
}
client.sendall(json.dumps(command).encode('utf-8'))

# 接收响应
response = client.recv(4096)
print(json.loads(response.decode('utf-8')))

# 关闭连接
client.close()

安装

1. 克隆仓库或下载文件。
2. 将 freecad_mcp 目录放置在您的FreeCAD模块目录中：
   • Windows: %APPDATA%/FreeCAD/Mod/
   • Linux: ~/.FreeCAD/Mod/
   • macOS: ~/Library/Preferences/FreeCAD/Mod/
3. 重新启动FreeCAD，并从工作台选择器中选择“FreeCAD MCP”工作台。

贡献

欢迎您通过提交问题或拉取请求来贡献。您的反馈和贡献非常受欢迎！

许可证

本项目采用MIT许可证。详情见LICENSE文件。