creo-mcp


Namecreo-mcp JSON
Version 0.1.4 PyPI version JSON
download
home_pageNone
SummaryAn MCP server with tools for CAD interaction and knowledge base retrieval.
upload_time2025-07-30 15:34:03
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT
keywords mcp cad creo cadquery agent
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Creo MCP

An MCP (Machine-Collaboration-Platform) server with tools for CAD interaction and knowledge base retrieval. This project exposes several functions as tools that a larger agent or system can call, including interacting with Creo and querying a Volcengine knowledge base.

---

## ⚙️ Key Features

* **CAD Integration**: Opens `.STEP` files directly in Creo Parametric.
* **Knowledge Base Retrieval**: Connects to and queries a Volcengine knowledge base.
* **Code Execution**: Provides a tool to execute arbitrary Python code remotely.
* **Command-Line Interface**: Runs as a standalone server application with configurable credentials.

---

## 📦 Installation & Setup

### Prerequisites

* Python 3.12 or newer
* **uv** package manager:
    * **On macOS:**
        ```bash
        brew install uv
        ```
    * **On Windows (PowerShell):**
        ```powershell
        powershell -c "irm [https://astral.sh/uv/install.ps1](https://astral.sh/uv/install.ps1) | iex"
        ```
        You may need to add `uv` to your Path manually:
        ```powershell
        # Add this line to your PowerShell profile
        $env:Path = "C:\Users\YOUR_USERNAME\.local\bin;" + $env:Path
        ```
    * For other systems, see the official [uv installation instructions](https://github.com/astral-sh/uv?tab=readme-ov-file#installation).

    ⚠️ **Do not proceed before installing uv.**

### Claude for Desktop Integration

1.  Go to `Claude > Settings > Developer > Edit Config > claude_desktop_config.json`.
2.  Add the following configuration to the `mcpServers` object:
    ```json
    {
        "mcpServers": {
            "creo_mcp": {
                "command": "uvx",
                "args": [
                    "creo-mcp",
                    "--authorization",
                    "YOUR_TOKEN_HERE",
                    "--service-resource-id",
                    "YOUR_ID_HERE"
                ]
            }
        }
    }
    ```
    *This allows Claude to automatically start your server when needed.*

### Cursor Integration

1.  Go to `Settings > MCP` in Cursor.
2.  Add a new server configuration.
    * **For macOS**: Use "add new global MCP server" or create a `.cursor/mcp.json` file in your project with the following content:
        ```json
        {
            "mcpServers": {
                "creo_mcp": {
                    "command": "uvx",
                    "args": [
                        "creo-mcp",
                        "--authorization",
                        "YOUR_TOKEN_HERE",
                        "--service-resource-id",
                        "YOUR_ID_HERE"
                    ]
                }
            }
        }
        ```
    * **For Windows**: Add a new server with the following settings:
        ```json
        {
            "mcpServers": {
                "creo_mcp": {
                    "command": "cmd",
                    "args": [
                        "/c",
                        "uvx",
                        "creo-mcp",
                        "--authorization",
                        "YOUR_TOKEN_HERE",
                        "--service-resource-id",
                        "YOUR_ID_HERE"
                    ]
                }
            }
        }
        ```

⚠️ **Only run one instance of the MCP server (either via Cursor or Claude Desktop), not both simultaneously.**

---

## ▶️ Manual Execution

If you need to run the server manually for debugging, first install it locally:

```bash
# Clone the repo
git clone [https://github.com/yangkunyi/creo-mcp.git](https://github.com/yangkunyi/creo-mcp.git)
cd creo-mcp

# Create a virtual environment and install in editable mode
uv venv
source .venv/bin/activate
uv pip install -e .
```

Then, run the server with your credentials:

```bash
creo-mcp --authorization YOUR_TOKEN_HERE --service-resource-id YOUR_ID_HERE
```

---

## 🛠️ Available Tools

The following tools are exposed by the server for remote execution:

* `execute_python_code`: Executes a given string of Python code.
* `open_file_in_cad`: Imports a `.STEP` file into Creo and opens it.
* `retrieve_from_knowledge_base`: Performs a retrieval query against the configured Volcengine knowledge base.
* `print_something`: Prints a given string to the server's console.
* `do_nothing`: A simple tool that does nothing.

---

## 🙏 Acknowledgements

The structure and setup instructions for this project were heavily inspired by the [blender-mcp](https://github.com/ahujasid/blender-mcp) project. Many thanks to its contributors for paving the way.

---

## 📄 License

This project is licensed under the **MIT License**. See the `LICENSE` file for more details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "creo-mcp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "mcp, cad, creo, cadquery, agent",
    "author": null,
    "author_email": "yangkunyi <colibri8n24@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/54/f9/743cd38265f63699b8ee6dbe24616356e682cd19b6ab114f8d5a7fb1e455/creo_mcp-0.1.4.tar.gz",
    "platform": null,
    "description": "# Creo MCP\r\n\r\nAn MCP (Machine-Collaboration-Platform) server with tools for CAD interaction and knowledge base retrieval. This project exposes several functions as tools that a larger agent or system can call, including interacting with Creo and querying a Volcengine knowledge base.\r\n\r\n---\r\n\r\n## \u2699\ufe0f Key Features\r\n\r\n* **CAD Integration**: Opens `.STEP` files directly in Creo Parametric.\r\n* **Knowledge Base Retrieval**: Connects to and queries a Volcengine knowledge base.\r\n* **Code Execution**: Provides a tool to execute arbitrary Python code remotely.\r\n* **Command-Line Interface**: Runs as a standalone server application with configurable credentials.\r\n\r\n---\r\n\r\n## \ud83d\udce6 Installation & Setup\r\n\r\n### Prerequisites\r\n\r\n* Python 3.12 or newer\r\n* **uv** package manager:\r\n    * **On macOS:**\r\n        ```bash\r\n        brew install uv\r\n        ```\r\n    * **On Windows (PowerShell):**\r\n        ```powershell\r\n        powershell -c \"irm [https://astral.sh/uv/install.ps1](https://astral.sh/uv/install.ps1) | iex\"\r\n        ```\r\n        You may need to add `uv` to your Path manually:\r\n        ```powershell\r\n        # Add this line to your PowerShell profile\r\n        $env:Path = \"C:\\Users\\YOUR_USERNAME\\.local\\bin;\" + $env:Path\r\n        ```\r\n    * For other systems, see the official [uv installation instructions](https://github.com/astral-sh/uv?tab=readme-ov-file#installation).\r\n\r\n    \u26a0\ufe0f **Do not proceed before installing uv.**\r\n\r\n### Claude for Desktop Integration\r\n\r\n1.  Go to `Claude > Settings > Developer > Edit Config > claude_desktop_config.json`.\r\n2.  Add the following configuration to the `mcpServers` object:\r\n    ```json\r\n    {\r\n        \"mcpServers\": {\r\n            \"creo_mcp\": {\r\n                \"command\": \"uvx\",\r\n                \"args\": [\r\n                    \"creo-mcp\",\r\n                    \"--authorization\",\r\n                    \"YOUR_TOKEN_HERE\",\r\n                    \"--service-resource-id\",\r\n                    \"YOUR_ID_HERE\"\r\n                ]\r\n            }\r\n        }\r\n    }\r\n    ```\r\n    *This allows Claude to automatically start your server when needed.*\r\n\r\n### Cursor Integration\r\n\r\n1.  Go to `Settings > MCP` in Cursor.\r\n2.  Add a new server configuration.\r\n    * **For macOS**: Use \"add new global MCP server\" or create a `.cursor/mcp.json` file in your project with the following content:\r\n        ```json\r\n        {\r\n            \"mcpServers\": {\r\n                \"creo_mcp\": {\r\n                    \"command\": \"uvx\",\r\n                    \"args\": [\r\n                        \"creo-mcp\",\r\n                        \"--authorization\",\r\n                        \"YOUR_TOKEN_HERE\",\r\n                        \"--service-resource-id\",\r\n                        \"YOUR_ID_HERE\"\r\n                    ]\r\n                }\r\n            }\r\n        }\r\n        ```\r\n    * **For Windows**: Add a new server with the following settings:\r\n        ```json\r\n        {\r\n            \"mcpServers\": {\r\n                \"creo_mcp\": {\r\n                    \"command\": \"cmd\",\r\n                    \"args\": [\r\n                        \"/c\",\r\n                        \"uvx\",\r\n                        \"creo-mcp\",\r\n                        \"--authorization\",\r\n                        \"YOUR_TOKEN_HERE\",\r\n                        \"--service-resource-id\",\r\n                        \"YOUR_ID_HERE\"\r\n                    ]\r\n                }\r\n            }\r\n        }\r\n        ```\r\n\r\n\u26a0\ufe0f **Only run one instance of the MCP server (either via Cursor or Claude Desktop), not both simultaneously.**\r\n\r\n---\r\n\r\n## \u25b6\ufe0f Manual Execution\r\n\r\nIf you need to run the server manually for debugging, first install it locally:\r\n\r\n```bash\r\n# Clone the repo\r\ngit clone [https://github.com/yangkunyi/creo-mcp.git](https://github.com/yangkunyi/creo-mcp.git)\r\ncd creo-mcp\r\n\r\n# Create a virtual environment and install in editable mode\r\nuv venv\r\nsource .venv/bin/activate\r\nuv pip install -e .\r\n```\r\n\r\nThen, run the server with your credentials:\r\n\r\n```bash\r\ncreo-mcp --authorization YOUR_TOKEN_HERE --service-resource-id YOUR_ID_HERE\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udee0\ufe0f Available Tools\r\n\r\nThe following tools are exposed by the server for remote execution:\r\n\r\n* `execute_python_code`: Executes a given string of Python code.\r\n* `open_file_in_cad`: Imports a `.STEP` file into Creo and opens it.\r\n* `retrieve_from_knowledge_base`: Performs a retrieval query against the configured Volcengine knowledge base.\r\n* `print_something`: Prints a given string to the server's console.\r\n* `do_nothing`: A simple tool that does nothing.\r\n\r\n---\r\n\r\n## \ud83d\ude4f Acknowledgements\r\n\r\nThe structure and setup instructions for this project were heavily inspired by the [blender-mcp](https://github.com/ahujasid/blender-mcp) project. Many thanks to its contributors for paving the way.\r\n\r\n---\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the **MIT License**. See the `LICENSE` file for more details.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An MCP server with tools for CAD interaction and knowledge base retrieval.",
    "version": "0.1.4",
    "project_urls": {
        "Homepage": "https://github.com/yangkunyi/creo-mcp",
        "Repository": "https://github.com/yangkunyi/creo-mcp"
    },
    "split_keywords": [
        "mcp",
        " cad",
        " creo",
        " cadquery",
        " agent"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "17b5821729a38f3e2bd6bb030b4430a3702df925d386b2986425c061a6c0fe4e",
                "md5": "496acbee0715b73fe0fb19e28861eaf7",
                "sha256": "bb5cb31d9762f273adea9c56667269d49e0aec79913296b546b15e0115f8dd3b"
            },
            "downloads": -1,
            "filename": "creo_mcp-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "496acbee0715b73fe0fb19e28861eaf7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 122929,
            "upload_time": "2025-07-30T15:34:01",
            "upload_time_iso_8601": "2025-07-30T15:34:01.689387Z",
            "url": "https://files.pythonhosted.org/packages/17/b5/821729a38f3e2bd6bb030b4430a3702df925d386b2986425c061a6c0fe4e/creo_mcp-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "54f9743cd38265f63699b8ee6dbe24616356e682cd19b6ab114f8d5a7fb1e455",
                "md5": "76a2c2c1477a2c07b132b60214398091",
                "sha256": "4596251f2686c380390e03b3ce2a0e5966536c77095627fa00a3d8df4aa19ca8"
            },
            "downloads": -1,
            "filename": "creo_mcp-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "76a2c2c1477a2c07b132b60214398091",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 108645,
            "upload_time": "2025-07-30T15:34:03",
            "upload_time_iso_8601": "2025-07-30T15:34:03.024165Z",
            "url": "https://files.pythonhosted.org/packages/54/f9/743cd38265f63699b8ee6dbe24616356e682cd19b6ab114f8d5a7fb1e455/creo_mcp-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-30 15:34:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yangkunyi",
    "github_project": "creo-mcp",
    "github_not_found": true,
    "lcname": "creo-mcp"
}
        
Elapsed time: 0.91209s