Sean P. KaneandGitHub
6a6cad9e65
* FreeCAD addon support for Workbench and Plugins * docs: refactor docs and clean up linters, etc. * Remove mdformat * test: improve test coverage * test:Lots of general fixes * chore: more general fixes
3.6 KiB
3.6 KiB
FreeCAD MCP Server
Welcome to the FreeCAD MCP Server documentation.
This project provides an MCP (Model Context Protocol) server that enables integration between AI assistants (Claude, GPT, and other MCP-compatible tools) and FreeCAD, allowing AI-assisted development and debugging of 3D models, macros, and workbenches.
Features
- 82+ MCP Tools - Comprehensive CAD operations including primitives, PartDesign, booleans, export
- Multiple Connection Modes - XML-RPC (recommended), JSON-RPC socket, or embedded (Linux only)
- GUI & Headless Support - Full modeling in headless mode, plus screenshots/colors in GUI mode
- Macro Development - Create, edit, run, and template FreeCAD macros via MCP
- Standalone Macros - Useful FreeCAD macros that work independently of the MCP server
Quick Start
# Install the MCP server
pip install freecad-robust-mcp
# Install the workbench via FreeCAD Addon Manager
# (search for "FreeCAD MCP and More")
# Start FreeCAD and click "Start Bridge" in the MCP Bridge workbench
# Configure your MCP client and start building!
See Installation for detailed setup instructions.
Connection Modes
| Mode | Description | Platform |
|---|---|---|
xmlrpc |
XML-RPC protocol (port 9875) | All platforms (recommended) |
socket |
JSON-RPC socket (port 9876) | All platforms |
embedded |
In-process FreeCAD | Linux only |
See Connection Modes for details on choosing the right mode.
GUI vs Headless Mode
The MCP server works with FreeCAD in both GUI and headless mode:
| Feature | Headless | GUI |
|---|---|---|
| Object creation | Yes | Yes |
| Boolean operations | Yes | Yes |
| Export (STEP, STL, etc.) | Yes | Yes |
| Screenshots | No | Yes |
| Object colors/visibility | No | Yes |
| Camera control | No | Yes |
FreeCAD Macros
This project includes standalone FreeCAD macros:
- CutObjectForMagnets - Cuts objects along planes with automatic magnet hole placement
- MultiExport - Export objects to multiple formats simultaneously
Documentation
| Section | Description |
|---|---|
| Getting Started | Installation, configuration, and quick start |
| User Guide | Connection modes, workbench, macros, and tools |
| Tools Reference | Complete API reference for all 82+ MCP tools |
| API Reference | Python API documentation |
| Development | Contributing, architecture, and development setup |
| Comparison | Analysis of other FreeCAD MCP implementations |