GH MCP Server

🚀 GH_mcp_server

GH_mcp_server 为设计师提供了一种独特的交互方式，可借助大型语言模型（LLMs）直接与 Rhino 和 Grasshopper 进行交互。它具备分析 .3dm 文件、开展 3D 建模的能力，还能依据用户的指导自动生成 Grasshopper 的 GHPython 脚本，极大地提升了设计工作的效率和创新性。

⚠️ 重要提示

此项目目前仍处于开发阶段，我们热忱欢迎您的参与！

• 若您遇到问题或有任何想法，请随时 打开一个 issues。
• 欢迎提交拉取请求（Pull Requests）。
• 若您对长期合作感兴趣，欢迎联系 yizhuod@andrew.cmu.edu，我们很乐意邀请您加入团队！

🚀 快速开始

在使用 GH_mcp_server 之前，您需要了解相关的需求、安装步骤以及使用方法。下面将为您详细介绍。

✨ 主要特性

• 支持设计师通过大型语言模型（LLMs）与 Rhino 和 Grasshopper 进行交互。
• 能够分析 .3dm 文件，为设计工作提供数据支持。
• 可以进行 3D 建模，满足多样化的设计需求。
• 能根据用户的指导自动生成 Grasshopper 的 GHPython 脚本，提高设计效率。

📦 安装指南

需求

uv 安装命令

• MacOS 和 Linux 系统

# MacOS 和 Linux 系统
curl -LsSf https://astral.sh/uv/install.sh | sh

• Windows 系统

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

安装步骤

1. 克隆仓库

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

2. 配置环境

我们推荐使用 uv 来配置环境：

• MacOS/Linux 系统

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

• Windows 系统

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

💡 使用建议

请确保在运行或开发项目之前激活虚拟环境。

3. 配置

1. 在 Claude Desktop 中，导航到 设置 -> 开发者，您将看到 编辑配置。
2. 点击 编辑配置 并打开文件 claude_desktop_config.json。
3. 将以下代码添加到 JSON 文件中：

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

4. 重启 Claude Desktop。如果看到锤子图标，则表示配置成功。点击锤子图标以检查所有附加的 MCP 工具。

💻 使用示例

基础用法

1. 启动 Rhino。
2. 输入命令 CodeListener，您应该会看到提示：VS Code 监听器已启动...
3. 打开 Claude Desktop 并输入提示词与 GH_mcp_server 工具交互。请参考文件 examples\zaha01.gh 中的示例，了解如何与 Grasshopper 交互。以下是一些示例：

首先读取文件 "D:\test01.3dm" 并分析此文件中的对象。

参考 Zaha 的风格创建一个塔，并将 ghpython 代码写入到 "D:\zaha01.py" 文件中。