JinDaGe - Speckle MCP Details

article

README

🚀 Speckle MCP 服务器

Speckle MCP 服务器是一个模型上下文协议（MCP）服务器，用于与 Speckle 进行交互。Speckle 是一个协作数据枢纽，可连接各类 AEC 工具，而本服务器则在 Speckle API 和客户端应用程序之间搭建了桥梁，为用户提供便捷的数据交互体验。

🚀 快速开始

此 MCP 服务器作为 Speckle API 和客户端应用程序之间的桥梁，为用户提供了一系列实用工具，可帮助用户轻松地与 Speckle 进行交互，如列出并搜索 Speckle 项目、获取特定项目的详细信息、访问项目中的模型版本，以及获取和查询特定版本的对象及其属性。

✨ 主要特性

支持列出并搜索 Speckle 项目。
可获取特定项目的详细信息。
能够访问项目中的模型版本。
支持获取和查询特定版本的对象及其属性。

📦 安装指南

先决条件

Python 3.13 或更高版本。
Speckle 账户及个人访问令牌。
uv 用于依赖管理和虚拟环境。

设置

克隆此仓库：

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

确保安装了 Python 3.13：

python --version  # 应显示 Python 3.13.x

使用 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 许可证约束。

Speckle