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" 文件中。