freecad_mcp

MCP.Pizza Chef: bonninr

FreecadMCP is a client that integrates FreeCAD with Claude AI and other MCP-compatible tools like Cursor. It enables direct interaction and control of FreeCAD through the Model Context Protocol, facilitating prompt-assisted 3D CAD design workflows. This client uses a server-client architecture to execute commands and retrieve information from FreeCAD documents and scenes, streamlining CAD operations with AI-driven context and control.

Use This MCP client To

Control FreeCAD via natural language prompts using Claude AI Execute CAD commands remotely through MCP protocol Retrieve and manipulate FreeCAD document data programmatically Integrate FreeCAD with other MCP-ready AI tools like Cursor Automate 3D design tasks with AI-driven instructions Enable collaborative CAD workflows with AI context sharing

README

FreeCAD MCP (Model Control Protocol)

Overview

The FreeCAD MCP (Model Control Protocol) provides a simplified interface for interacting with FreeCAD through a server-client architecture. This allows users to execute commands and retrieve information about the current FreeCAD document and scene.

freecad.mp4

Configuration

To configure the MCP server, you can use a JSON format to specify the server settings. Below is an example configuration:

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

Configuration Details

  • command: The path to the Python executable that will run the FreeCAD MCP server. This can vary based on your operating system:

    • Windows: Typically, it might look like C:\\ProgramData\\anaconda3\\python.exe or C:\\Python39\\python.exe.
    • Linux: It could be /usr/bin/python3 or the path to your Python installation.
    • macOS: Usually, it would be /usr/local/bin/python3 or the path to your Python installation.
  • args: An array of arguments to pass to the Python command. The first argument should be the path to the freecad_bridge.py script, which is responsible for handling the MCP server logic. Make sure to adjust the path according to your installation.

Example for Different Operating Systems

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

Features

The FreeCAD MCP currently supports the following functionalities:

1. get_scene_info

  • Description: Retrieves comprehensive information about the current FreeCAD document, including:
    • Document properties (name, label, filename, object count)
    • Detailed object information (type, position, rotation, shape properties)
    • Sketch data (geometry, constraints)
    • View information (camera position, direction, etc.)

2. run_script

  • Description: Executes arbitrary Python code within the FreeCAD context. This allows users to perform complex operations, create new objects, modify existing ones, and automate tasks using FreeCAD's Python API.

Example Usage

To use the FreeCAD MCP, you can connect to the server and send commands as follows:

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()

Installation

  1. Clone the repository or download the files.
  2. Place the freecad_mcp directory in your FreeCAD modules directory:
    • Windows: %APPDATA%/FreeCAD/Mod/
    • Linux: ~/.FreeCAD/Mod/
    • macOS: ~/Library/Preferences/FreeCAD/Mod/
  3. Restart FreeCAD and select the "FreeCAD MCP" workbench from the workbench selector.

Contributing

Feel free to contribute by submitting issues or pull requests. Your feedback and contributions are welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.

freecad_mcp FAQ

How do I configure the FreeCAD MCP client?
Configure the client by specifying the MCP server settings in JSON, including the Python executable path and script arguments for the FreeCAD MCP server.
Can FreecadMCP work with AI models other than Claude?
Yes, FreecadMCP supports any MCP-ready AI tools, including Claude, Cursor, and others compatible with the Model Context Protocol.
What operating systems are supported by FreecadMCP?
FreecadMCP supports Windows, Linux, and macOS, with configuration paths adjustable per OS requirements.
How does FreecadMCP communicate with FreeCAD?
It uses a server-client architecture where the client sends commands and queries to the FreeCAD MCP server running a Python bridge script.
Is programming knowledge required to use FreecadMCP?
Basic familiarity with JSON configuration and FreeCAD scripting helps, but the client enables prompt-driven CAD control reducing manual coding.
Can FreecadMCP automate complex CAD workflows?
Yes, by leveraging AI prompts and MCP integration, users can automate multi-step 3D design and document manipulation tasks.
How secure is the communication between FreecadMCP client and server?
Communication is scoped and controlled via MCP principles ensuring secure and observable interactions.
Where can I find the FreecadMCP source code?
The source code is available on GitHub at the repository linked in the MCP entity details.