Skip to main content

Add your description here

Project description

FreeCAD MCP

This repository is a FreeCAD MCP that allows you to control FreeCAD from Claude Desktop.

Demo

Design a flange

demo

Design a toy car

demo

Design a part from 2D drawing

Input 2D drawing

input

Demo

demo

This is the conversation history. https://claude.ai/share/7b48fd60-68ba-46fb-bb21-2fbb17399b48

Install addon

FreeCAD Addon directory is

  • Windows: %APPDATA%\FreeCAD\Mod\
  • Mac: ~/Library/Application Support/FreeCAD/Mod/
  • Linux: ~/.FreeCAD/Mod/ or ~/snap/freecad/common/Mod/ (if you install FreeCAD from snap)

Please put addon/FreeCADMCP directory to the addon directory.

git clone https://github.com/neka-nat/freecad-mcp.git
cd freecad-mcp
cp -r addon/FreeCADMCP ~/.FreeCAD/Mod/

When you install addon, you need to restart FreeCAD. You can select "MCP Addon" from Workbench list and use it.

workbench_list

And you can start RPC server by "Start RPC Server" command in "FreeCAD MCP" toolbar.

start_rpc_server

Setting up Claude Desktop

Edit claude_desktop_config.json file.

For user.

{
  "mcpServers": {
    "freecad": {
      "command": "uvx",
      "args": [
        "freecad-mcp"
      ]
    }
  }
}

If you want to save token, you can set only_text_feedback to true and use only text feedback.

{
  "mcpServers": {
    "freecad": {
      "command": "uvx",
      "args": [
        "freecad-mcp",
        "--only-text-feedback"
      ]
    }
  }
}

For developer. First, you need clone this repository.

git clone https://github.com/neka-nat/freecad-mcp.git
{
  "mcpServers": {
    "freecad": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/freecad-mcp/",
        "run",
        "freecad-mcp"
      ]
    }
  }
}

Tools

  • create_document: Create a new document in FreeCAD.
  • create_object: Create a new object in FreeCAD.
  • edit_object: Edit an object in FreeCAD.
  • delete_object: Delete an object in FreeCAD.
  • execute_code: Execute arbitrary Python code in FreeCAD.
  • insert_part_from_library: Insert a part from the parts library.
  • get_view: Get a screenshot of the active view.
  • get_objects: Get all objects in a document.
  • get_object: Get an object in a document.
  • get_parts_list: Get the list of parts in the parts library.

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

freecad_mcp-0.1.11.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

freecad_mcp-0.1.11-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file freecad_mcp-0.1.11.tar.gz.

File metadata

  • Download URL: freecad_mcp-0.1.11.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.13

File hashes

Hashes for freecad_mcp-0.1.11.tar.gz
Algorithm Hash digest
SHA256 f1606849a46e0dc5c8b1e37dd556d87997753791008501b9514a179c7fe6023c
MD5 450632769e207c4e9a19ab2697b061f0
BLAKE2b-256 f6ed8be4667e4df1684d500ee8c5f32021a7cda40a2398313d88e93362ee0c8b

See more details on using hashes here.

File details

Details for the file freecad_mcp-0.1.11-py3-none-any.whl.

File metadata

File hashes

Hashes for freecad_mcp-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 c1594139d4bfb6a0882bfa4014046b7ff2985c8fc5a7a97eafaed109650c9cd0
MD5 45c396b43c020a12d7dfeb677a89a5a8
BLAKE2b-256 f539b0b52b6c8e1ee6d5d11629d8d0a5f6c5afdd6727a3542442c92fd8dd42e2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page