AI导哈

CAD模型控制协议

FreeCAD MCP提供基于服务器-客户端架构的简化接口，用于执行命令和获取FreeCAD文档及场景信息。

  • by bonninr
  • Python
  • 本地部署
  • 226 星标
  • 更新于
在 GitHub 查看 bonninr/freecad_mcp

使用说明

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"
            ]
        }
    }
}

配置详情

  • 命令：将运行FreeCAD MCP服务器的Python可执行文件的路径。这可能因您的操作系统而异：

    • 视窗：通常，它可能看起来像 C:\\ProgramData\\anaconda3\\python.exe 或 C:\\Python39\\python.exe.
    • Linux：可能是 /usr/bin/python3 或者Python安装的路径。
    • macOS：通常是 /usr/local/bin/python3 或者Python安装的路径。

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

不同操作系统的示例

视窗

{
    "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模块目录中的目录：
    • 窗户： %APPDATA%/FreeCAD/Mod/
    • Linux： ~/.FreeCAD/Mod/
    • macOS： ~/Library/Preferences/FreeCAD/Mod/
  3. 重新启动FreeCAD，并从工作台选择器中选择“FreeCAD MCP”工作台。

贡献

您可以通过提交问题或拉取请求来做出贡献。欢迎您的反馈和贡献！

许可证

该项目根据MIT许可证获得许可。有关详细信息，请参阅LICENSE文件。

相关 MCP