Sean P. KaneandGitHub
47e80f1bc7
* refactor: remove macros * refactor: additional cleanup * chore: small cleanup * refactor: update .coderabbit.yaml configuration * docs: update CLAUDE.md with new documentation * docs: table alignment
99 lines
3.9 KiB
Markdown
99 lines
3.9 KiB
Markdown
# FreeCAD Robust MCP Suite
|
|
|
|
Welcome to the FreeCAD Robust MCP Suite documentation.
|
|
|
|
This project provides an [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server and FreeCAD workbench that enable integration between AI assistants (Claude, GPT, and other MCP-compatible tools) and [FreeCAD](https://www.freecadweb.org/), 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
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# 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](getting-started/installation.md) 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](guide/connection-modes.md) 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](guide/macros.md) for details on using macros with the MCP server.
|
|
|
|
---
|
|
|
|
## Documentation
|
|
|
|
| Section | Description |
|
|
| -------------------------------------------------- | ------------------------------------------------- |
|
|
| [Getting Started](getting-started/installation.md) | Installation, configuration, and quick start |
|
|
| [User Guide](guide/connection-modes.md) | Connection modes, workbench, macros, and tools |
|
|
| [Tools Reference](MCP_TOOLS_REFERENCE.md) | Complete API reference for all 82+ MCP tools |
|
|
| [API Reference](api/server.md) | Python API documentation |
|
|
| [Development](development/contributing.md) | Contributing, architecture, and development setup |
|
|
| [Comparison](COMPARISON.md) | Compare with other FreeCAD MCP implementations |
|
|
|
|
---
|
|
|
|
## Links
|
|
|
|
- [GitHub Repository](https://github.com/spkane/freecad-robust-mcp-and-more) - Source code and issue tracker
|
|
- [PyPI Package](https://pypi.org/project/freecad-robust-mcp/) - Python package for pip installation
|
|
- [Docker Hub](https://hub.docker.com/r/spkane/freecad-robust-mcp) - Pre-built Docker images
|
|
|
|
---
|
|
|
|
!!! tip "Share This Documentation"
|
|
Direct link: **[https://spkane.github.io/freecad-robust-mcp-and-more/](https://spkane.github.io/freecad-robust-mcp-and-more/)**
|