API文档服务器

Trimble Connect MCP Server是一个提供结构化、可搜索的Trimble Connect平台API文档的服务器,旨在辅助AI开发Trimble Connect扩展和应用。

  • by SimonTrim
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 SimonTrim/trb-mcp-server-api

使用说明

Trimble Connect MCP服务器

MCP(模型上下文协议)服务器公开所有 Trimble Connect浏览器API 文档。专为人工智能辅助开发Trimble Connect扩展和应用程序而设计。

包含什么

此MCP服务器为以下内容提供结构化、可搜索的文档 200多个API终点 在整个Trimble Connect平台上:

类别 描述
工作区API SDK连接、命名空间(项目、用户、扩展、ui、查看器、嵌入)、事件
REST API(核心2.0版) 项目、文件、文件夹、待办事项、视图、搜索、区域
REST API扩展 活动、冲突(完全CRUD)、二维视图、评论、公司、组、对象链接、对象同步、发布、共享、标签、用户、视图组、扩展文件/文件夹/项目/视图端点
BCF API BIM协作格式——主题、评论、观点
三维API查看器 相机、选择、对象、模型、层次结构、剖面、图标、图层、点云
标记API 注释——文本、箭头、线条、云、测量值、点、自由线
查看API 保存的三维视图(通过工作区API进行CRUD)
面板API PropertyPanel、DataTable、ModelsPanel
认证 OAuth 2.0,集成模式(工作区API),独立模式,令牌管理
区域 核心API和BCF API的每个地区(美国、欧盟、亚太地区、澳大利亚)的URL
扩展 类型(项目、viewer3d、嵌入式)、清单、安装指南
属性集服务 BIM模型对象、库、定义、实例的自定义特性集
Trimble Connect SDK trimble-connect-sdk npm包--TCPS客户端、组织者(LBS/WBS)、PSet SDK、凭据
TypeScript类型 所有接口(矢量3、相机、对象属性、BCFTopic、查看器选择等)
项目设置 架构、文件夹结构、后端代理、Vite配置、部署
代码示例 扩展骨架、React钩子、ViewerBridge模式、注释工作流
陷阱 Trimble Connect扩展的常见错误和经过验证的解决方案

可用工具

工具 说明
search_trimble_connect_docs 在所有文档中进行全文搜索
get_api_reference 获取特定API类别的完整参考资料
get_extension_starter 获取新扩展(project/viewer3d/embedded)的启动模板
get_viewer_api_guide 获取特定Viewer 3D主题的详细指南
list_available_docs 列出所有可用的文档部分
tc_bcf_dashboard_app MCP应用程序:Trimble Assist内呈现的交互式Trimble Connect BCF仪表板
tc_bcf_create_app MCP应用程序:创建BCF主题的交互式表单,在Trimble Assist中呈现(通过提交 tc_bcf_create_topic)

MCP应用程序(Trimble Assist中的交互式UI)

tc_bcf_dashboard_app 和 tc_bcf_create_app 是 MCP应用程序:它们返回HTML资源 (text/html+skybridge)Trimble Assist在聊天中以嵌套iframe的形式内联呈现。

  • HTML通过以下方式连接到主机 @modelcontextprotocol/ext-apps (从加载 https://esm.sh).
  • 初始上下文通过工具推送到应用程序 structuredContent.
  • 创建表单有两个提交路径:
    • 无3D视点:调用服务器工具 tc_bcf_create_topic 通过 callServerTool (即时、服务器端、无重复逻辑)。
    • 使用当前三维视点 (复选框,默认打开):调用 sendMessage 要求代理人 通过创建BCF 主机应用程序 create_bcf_topic 工具,捕捉现场 相机+快照+加载模型。这仅使用标准的MCP Apps SDK。
  • CSP允许列表(esm.sh)在资源中声明 _meta.ui.csp.

注意:Trimble主机代理扩展(callLocalTool 从 @trimble-agentic/agentic-mcp-app-tools) 将允许应用程序直接调用宿主工具,但该包是私有的(不在公共npm/esm.sh上), 因此,它无法导入到服务器提供的HTML应用程序中。这 sendMessage 上述委托实现 仅使用公共SDK即可获得相同的结果(在主机中捕获视点)。

安装

先决条件

  • Node.js>=18
  • npm

从源代码构建

git clone https://github.com/YOUR_USERNAME/trb-mcp-server-api.git
cd trb-mcp-server-api
npm install
npm run build

配置

Cursor 集成开发环境

添加到光标MCP设置(.cursor/mcp.json 或全局设置):

{
  "mcpServers": {
    "trimble-connect": {
      "command": "node",
      "args": ["C:/path/to/trb-mcp-server-api/dist/index.js"]
    }
  }
}

克劳德桌面

添加到您的Claude桌面配置(claude_desktop_config.json):

{
  "mcpServers": {
    "trimble-connect": {
      "command": "node",
      "args": ["C:/path/to/trb-mcp-server-api/dist/index.js"]
    }
  }
}

VS代码(副本)

添加 .vscode/mcp.json:

{
  "servers": {
    "trimble-connect": {
      "command": "node",
      "args": ["C:/path/to/trb-mcp-server-api/dist/index.js"]
    }
  }
}

用法示例

配置后,AI助手可以使用这些工具:

搜索特定的API方法:

“搜索Trimble Connect文档以选择查看器”

获取完整的API参考:

“获取查看器api参考”

启动新的扩展项目:

“使用React获取viewer3d扩展的扩展启动器”

获取特定的查看者API指南:

“获取层次结构的查看器API指南”

列出所有可用文档:

“列出所有可用的Trimble Connect文档”

项目结构

trb-mcp-server-api/
├── src/
│   ├── index.ts                  # MCP server entry point
│   └── data/                     # Structured documentation
│       ├── workspace-api.ts      # Workspace API reference
│       ├── rest-api.ts           # REST API Core v2.0 (basic)
│       ├── rest-api-extended.ts  # REST API extended (activities, clashes, comments, companies, groups, etc.)
│       ├── bcf-api.ts            # BCF Topics API
│       ├── viewer-api.ts         # Viewer 3D API
│       ├── markup-api.ts         # Markup/Annotations API
│       ├── view-api.ts           # View API
│       ├── panels-api.ts         # PropertyPanel, DataTable, ModelsPanel
│       ├── auth.ts               # Authentication (OAuth, tokens)
│       ├── regions.ts            # Region URLs
│       ├── extensions.ts         # Extension types, manifests, embedded
│       ├── sdk.ts                # trimble-connect-sdk (TCPS, Organizer, PSet)
│       ├── typescript-types.ts   # TypeScript interfaces
│       ├── project-setup.ts      # Architecture, proxy, Vite, deployment
│       ├── code-examples.ts      # Code skeletons and patterns
│       ├── property-set.ts       # Property Set Service
│       └── pitfalls.ts           # Common pitfalls and solutions
├── dist/                         # Compiled output
├── package.json
├── tsconfig.json
└── README.md

更新文档

添加或更新API文档:

  1. 在中编辑相关文件 src/data/
  2. 跑 npm run build
  3. 重新启动MCP服务器(或在Cursor中重新连接)

源文件

许可证

麻省理工学院