Grasshopper 3D

🚀 GH_mcp_server Project Documentation

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

⚠️ Important Note

This project is still under development - your help is welcome!

• 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 love to invite you to join the team!

📋 Requirements

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

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

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

• Claude Desktop

📦 Installation

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:

For MacOS/Linux

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

For Windows

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

⚠️ Important Note: Make sure to activate the virtual environment before running or developing the project.

3. Configuration steps

1. In Claude Desktop, navigate to Settings -> Developers. You'll see the Edit Configuration option.
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, 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. It's recommended to refer to the file examples\zaha01.gh to understand 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 the style of Zaha and write the ghpython code to the file "D:\zaha01.py".