FreeCAD Robust MCP Suite¶
Welcome to the FreeCAD Robust MCP Suite documentation.
This project provides an MCP (Model Context Protocol) server and FreeCAD workbench that enable 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¶
- 150+ 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
Quick Start¶
# Install the Robust MCP Server
pip install freecad-robust-mcp
# Install the workbench via FreeCAD Addon Manager
# (search for "Robust MCP" - the package is "FreeCAD Robust MCP Suite")
# Start FreeCAD and switch to the "Robust MCP Bridge" workbench
# Click "Start Bridge" in the toolbar
# 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 Robust 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¶
The MCP server provides tools for working with FreeCAD macros:
- List macros - Discover available macros in your FreeCAD installation
- Run macros - Execute macros with parameter passing
- Create macros - Generate new macros from templates or custom code
See Macros Guide for details on using macros with the MCP server.
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 150+ MCP tools |
| API Reference | Python API documentation |
| Development | Contributing, architecture, and development setup |
| Comparison | Compare with other FreeCAD MCP implementations |
Links¶
- GitHub Repository - Source code and issue tracker
- PyPI Package - Python package for pip installation
- Docker Hub - Pre-built Docker images
Share This Documentation
Direct link: https://spkane.github.io/freecad-robust-mcp-and-more/