Freecad

by bonninr

199 stars

709 downloads

Not rated

GitHub

About

FreecadMCP connects Freecad to Claude AI and other MCP-ready tools like Cursor through the Model Context Protocol (MCP), allowing Claude to directly interact with and control Freecad. This integration enables prompt assisted CAD 3d Design.

Details

Author: bonninr
GitHub stars: 199
Downloads: 709
Categories: Developer Tools, Design, Other

- Retrieve comprehensive scene information (document properties, objects, sketches, camera)
- Execute arbitrary Python code within the FreeCAD context
- Automate complex CAD operations via script
- Modify existing objects and create new ones programmatically
- Access shape properties, geometry, and constraints of sketches

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Freecad

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

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

JSON

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

JSON

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

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

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

JSON

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

JSON

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

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

From the repository

Install by placing the freecad_mcp directory in your FreeCAD modules directory, restart FreeCAD, and select the "FreeCAD MCP" workbench. Configure the MCP server in JSON format specifying the Python executable path and the path to freecad_bridge.py. Connect to the server via socket on localhost:9876 to send commands such as get_scene_info and run_script.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

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. https://github.com/user-attachments/assets/5acafa17-4b5b-4fef-9f6c-617e85357d44

Configuration

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

json
{
    "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

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



Linux

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



macOS

json
{
    "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:

``python import socket import json

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

FreeCAD MCP (Model Control Protocol)

Overview

Configuration

Configuration Details

Example for Different Operating Systems

Windows

Linux

macOS

Features

1. get_scene_info

2. run_script

Example Usage

Install

More like this

Sequential Thinking

Sentry

Github

Filesystem

EverArt

Google Drive

`1.` get_scene_info

`2.` run_script