Freecad

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 命令的参数数组。第一个参数应为 freecad_bridge.py 脚本的路径，该脚本负责处理 MCP 服务逻辑。请根据你的安装情况调整路径。

不同操作系统的示例

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

# Connect to the FreeCAD MCP server
client = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
client.connect(('localhost', 9876))

# Example: Get scene information
command = {
    "type": "get_scene_info"
}
client.sendall(json.dumps(command).encode('utf-8'))

# Receive the response
response = client.recv(4096)
print(json.loads(response.decode('utf-8')))

# Example: Run a script
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'))

# Receive the response
response = client.recv(4096)
print(json.loads(response.decode('utf-8')))

# Close the connection
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 文件。