Speckle

🚀 Speckle MCP 服務器

Speckle MCP 服務器是一個模型上下文協議（MCP）服務器，用於與 Speckle 進行交互。Speckle 是一個協作數據樞紐，可連接各類 AEC 工具，而本服務器則在 Speckle API 和客戶端應用程序之間搭建了橋樑，為用戶提供便捷的數據交互體驗。

🚀 快速開始

此 MCP 服務器作為 Speckle API 和客戶端應用程序之間的橋樑，為用戶提供了一系列實用工具，可幫助用戶輕鬆地與 Speckle 進行交互，如列出並搜索 Speckle 項目、獲取特定項目的詳細信息、訪問項目中的模型版本，以及獲取和查詢特定版本的對象及其屬性。

✨ 主要特性

• 支持列出並搜索 Speckle 項目。
• 可獲取特定項目的詳細信息。
• 能夠訪問項目中的模型版本。
• 支持獲取和查詢特定版本的對象及其屬性。

📦 安裝指南

先決條件

• Python 3.13 或更高版本。
• Speckle 賬戶及個人訪問令牌。
• uv 用於依賴管理和虛擬環境。

設置

1. 克隆此倉庫：

   git clone https://github.com/bimgeek/speckle-mcp.git
   cd speckle-mcp
   

2. 確保安裝了 Python 3.13：

   python --version  # 應顯示 Python 3.13.x
   

3. 使用 uv 安裝依賴項：

   uv pip install -r requirements.txt
   

📚 詳細文檔

配置

環境變量

服務器需要以下環境變量：

• SPECKLE_TOKEN：您的 Speckle 個人訪問令牌（必需）。
• SPECKLE_SERVER：Speckle 服務器 URL（默認為 https://app.speckle.systems）。

MCP 配置

要將此服務器與 Claude 一起使用，需要更新您的 MCP 配置文件。配置文件通常位於：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

在mcpServers部分中添加或更新“speckle”條目：

{
  "mcpServers": {
    "speckle": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/speckle-mcp",
        "run",
        "speckle_server.py"
      ],
      "env": {
        "SPECKLE_TOKEN": "YOUR_SPECKLE_API_TOKEN_HERE",
        "SPECKLE_SERVER": "https://app.speckle.systems"
      }
    }
  }
}

將/path/to/speckle-mcp替換為您實際路徑，指向包含speckle_mcp包的目錄。

可用工具

項目

• list_projects：列出所有可訪問的 Speckle 項目。
  • 參數：
    • limit（可選）：要檢索的最大項目數（默認：20）。
• get_project_details：獲取特定項目的詳細信息。
  • 參數：
    • project_id：要檢索的 Speckle 項目的 ID。
    • limit（可選）：要檢索的最大模型數（默認：20）。
• search_projects：按名稱或描述搜索項目。
  • 參數：
    • query：要在項目名稱和描述中查找的搜索詞。

模型

• get_model_versions：列出特定模型的所有版本。
  • 參數：
    • project_id：Speckle 項目的 ID。
    • model_id：要檢索其版本的模型 ID。
    • limit（可選）：要檢索的最大版本數（默認：20）。

對象

• get_objects：按類型或屬性過濾對象。
  • 參數：
    • type（可選）：要查找的對象類型。
    • properties（可選）：要包含的屬性列表。
    • limit（可選）：要檢索的最大對象數（默認：20）。

故障排除

• 檢查令牌是否正確設置，並確保其具有適當的權限。
• 查看服務器日誌以獲取更多信息。

📄 許可證

此項目受 MIT 許可證約束。