GH MCP Server

🚀 GH_mcp_server

GH_mcp_server offers a way for designers to directly interact with Rhino and Grasshopper through Large Language Models (LLMs). It includes analyzing .3dm files, conducting 3D modeling, and automatically generating GHPython scripts for Grasshopper based on user guidance.

⚠️ Important Note

This project is currently under development - we welcome your participation!

• If you encounter any issues or have ideas, feel free to open an issue.
• Pull Requests are welcome.
• If you're interested in long - term collaboration, please contact yizhuod@andrew.cmu.edu - we'd be glad to invite you to the team!

📦 Installation

Requirements

• Rhino 7 or 8
• Install RhinoPython: https://github.com/jingcheng-chen/RhinoPythonForVscode/tree/master?tab=readme-ov-file
• uv

  • # MacOS and Linux
    curl -LsSf https://astral.sh/uv/install.sh | sh
    

  • # Windows
    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
    

• Claude Desktop

Steps

1. Clone the repository

git clone git@github.com:veoery/GH_mcp_server.git
cd GH_mcp_server

2. Configure the environment

We recommend using uv:

MacOS/Linux

uv venv
source .venv/bin/activate
uv pip install -e .

Windows

uv venv
.venv\Scripts\activate
uv pip install -e .

💡 Usage Tip

Please make sure to activate the virtual environment before running or developing the project.

3. Configuration

1. In Claude Desktop, navigate to Settings -> Developers. You'll see Edit Configuration.
2. Click Edit Configuration and open the file claude_desktop_config.json.
3. Add the following code to the JSON file:

   {
     "mcpServers": {
       "grasshopper": {
         "command": "path_to_GH_mcp_server/.venv/bin/python",
         "args": [
           "path_to_GH_mcp_server/run_server.py"
         ]
       }
     }
   }
   

4. Restart Claude Desktop. If you see a hammer icon, it means the configuration is successful. Click the hammer icon to check all attached MCP tools.

💻 Usage Examples

Basic Usage

1. Start Rhino.
2. Enter the command CodeListener. You should see the prompt: VS Code listener has started...
3. Open Claude Desktop and enter prompts to interact with the GH_mcp_server tool. Refer to the example in the file examples\zaha01.gh to learn how to interact with Grasshopper. Here are some examples:

   First, read the file "D:\test01.3dm" and analyze the objects in this file.
   

   Create a tower in Zaha's style and write the ghpython code to the file "D:\zaha01.py".