Freecad

🚀 FreeCAD MCP (Model Control Protocol)

FreeCAD MCP provides a simplified interface for interacting with FreeCAD through a server-client architecture, allowing users to execute commands and obtain information about the current FreeCAD document and scene.

🚀 Quick Start

FreeCAD MCP (Model Control Protocol) offers a simplified interface to interact with FreeCAD via a server-client architecture. This enables users to execute commands and retrieve information about the current FreeCAD document and scene.

Click here for related content

📦 Installation

Follow these steps to install FreeCAD MCP:

1. Copy all the content to the clipboard.
2. Open FreeCAD.
3. Go to the "Tools" menu and select "Customize My Workbench".
4. Paste the content and save.

✨ Features

• Feature 1: Describe the first feature.
• Feature 2: Describe the second feature.
• Feature 3: Describe the third feature.

📚 Documentation

Configuration

To configure the MCP server, you can specify the server settings in JSON format. Here is an example configuration:

{
    "mcpServers": {
        "freecad": {
            "command": "C:\\ProgramData\\anaconda3\\python.exe",
            "args": [
                "C:\\Users\\USER\\AppData\\Roaming\\FreeCAD\\Mod\\freecad_mcp\\src\\freecad_bridge.py"
            ]
        }
    }
}

Configuration Details

• command: The path to the Python executable for running the MCP server. This may vary depending on your operating system:

  • Windows: Similar to C:\\ProgramData\\anaconda3\\python.exe or C:\\Python39\\python.exe.
  • Linux: May be similar to /usr/bin/python3 or the path of your installed Python.
  • macOS: Usually /usr/local/bin/python3 or the path of your installed Python.

• args: An array of arguments passed to the Python command. The first argument should be the path to the freecad_bridge.py script, which is responsible for handling the MCP server logic. Please adjust the path according to your installation.

Examples for Different Operating Systems

Windows

{
    "mcpServers": {
        "freecad": {
            "command": "C:\\ProgramData\\anaconda3\\python.exe",
            "args": [
                "C:\\Users\\USER\\AppData\\Roaming\\FreeCAD\\Mod\\freecad_mcp\\src\\freecad_bridge.py"
            ]
        }
    }
}

Linux

{
    "mcpServers": {
        "freecad": {
            "command": "/usr/bin/python3",
            "args": [
                "/home/USER/.FreeCAD/Mod/freecad_mcp/src/freecad_bridge.py"
            ]
        }
    }
}

macOS

{
    "mcpServers": {
        "freecad": {
            "command": "/usr/local/bin/python3",
            "args": [
                "/Users/USER/Library/Preferences/FreeCAD/Mod/freecad_mcp/src/freecad_bridge.py"
            ]
        }
    }
}

💻 Usage Examples

Basic Usage

# Example code
print("Hello, MCP!")

🤝 Contribution

We welcome you to submit issues or pull requests. Your feedback and contributions are highly valuable!

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.