This project provides a local bridge that lets an MCP client such as Copilot inspect and, eventually, modify a FreeCAD document safely.
The first milestone provides:
- A versioned newline-delimited JSON protocol.
- A local Unix-socket client/server transport.
- A FreeCAD-side service skeleton with
get_session_info. - An MCP adapter exposing session and read-only inspection tools over stdio.
- Document listing, object-tree inspection, and object metadata.
- A native add-on copy layout in
freecad_addon/.
The adapter only connects to a bridge explicitly started by the FreeCAD add-on. It does not expose arbitrary Python execution.
get_session_infolist_documentsget_document_treeget_object
python -m pip install -e '.[test]'
pytestStart the MCP adapter after starting the bridge from FreeCAD:
freecad-mcp-adapterSet FREECAD_MCP_SOCKET to use a socket path other than the default /tmp/freecad-mcp.sock.
The freecad_addon/ directory is intended to be copied into FreeCAD's Mod/FreeCADMCPBridge/ directory. The add-on currently exposes a small service API; GUI command registration will be added after the transport handshake is validated.