mcpField
B
Bitbybit CAD MCP

Bitbybit CAD MCP

远程服务
learn.bitbybit.dev开发工具207今天更新

关于 Bitbybit CAD MCP

Bitbybit CAD MCP 为编码 Agent 提供与项目版本匹配的 Bitbybit 3D CAD API 文档查询。它从发布版本索引提供函数契约、示例和指南,并标注功能所属层级;自身只查询文档,不执行几何操作。

主要功能

  1. 01按版本查询 CAD API
  2. 02搜索并描述 API 成员
  3. 03查看命名空间成员与代码示例
  4. 04检索 CAD 开发指南
  5. 05答案标注功能层级
  6. 06只读文档查询工具

适用场景

  1. 01查找准确的 API 名称和参数
  2. 02根据项目所用版本生成 CAD 代码
  3. 03查看特定函数的示例和返回类型
  4. 04判断功能属于 npm、平台或云端

MCP 相关

该 MCP 服务向编码 Agent 暴露 API 搜索、成员描述、命名空间列表、示例和指南查询工具。可通过托管 Streamable HTTP 端点或本地 stdio 连接;工具为只读,不运行几何计算。

配置

远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。

服务地址https://mcp.bitbybit.dev/mcp
一键复制安装命令
Claude CodeTerminal
Cursor.cursor/mcp.json
VS Code.vscode/mcp.json
Claude Desktopclaude_desktop_config.json
Windsurf~/.codeium/windsurf/mcp_config.json

命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。

安装包
npm@bitbybit-dev/mcp1.5.0

工具

7
参数类型必填说明
limitinteger否结果数量,默认值为 10
querystring是关键词、短语或部分点分路径
engineenum否仅包含此引擎发布的成员,以及在 CAD Cloud 上运行而非引擎内运行的云操作;对所有引擎均省略babylonjs | threejs | playcanvas
versionstring否要搜索的 API 版本;省略时使用服务器持有的版本

详细介绍

@bitbybit-dev/mcp:Bitbybit CAD MCP 服务

一个 MCP 服务,为 AI 编码 Agent 提供 Bitbybit 3D CAD API 文档:针对项目使用的确切版本,列出每个函数、参数、默认值、返回类型和示例。Bitbybit 在三个 CAD 内核中共有 2205 个函数,数量远超任何模型能记住的范围,因此依赖记忆工作的 Agent 会编造看似合理但实际不存在的名称。使用此服务的 Agent 会先查询每个函数,再编写一次就能编译通过的代码。

它根据 Bitbybit 每次发布时提供的 API 索引作答(https://git-cdn.bitbybit.dev/v<version>/ai-context/index.json),绝不依赖记忆,也不会使用不断变化的“latest”。

Bitbybit 平台示意图,展示网站如何通过脚本运行器、iframe 嵌入、NPM 包、CAD Cloud REST API 和通过 MCP 接入的 AI Agent 获取几何体

这张图展示了 Agent 编写代码的目标。采用 MIT 许可的 npm 包可在用户的浏览器或你自己的 Node 进程中运行 CAD 内核;脚本运行器可从单个文件加载相同的引擎;CAD Cloud REST API则在托管服务上执行工作。此服务了解所有这些方式,且每个回答都会标明层级——oss、platform-pro 或 cloud-pro——因此 Agent 不会让你为了免费包已经能完成的工作而使用付费服务。

连接

此服务有两种运行方式:通过 Streamable HTTP 使用托管服务 https://mcp.bitbybit.dev/mcp,无需安装任何内容,并提供最新版本;或通过 npx 在本地使用 stdio 运行,需要 Node 20,并提供项目已安装的版本。建议先使用远程服务。

添加到 Cursor 在 VS Code 中安装 在 VS Code Insiders 中安装

Claude Code

claude mcp add --transport http bitbybit https://mcp.bitbybit.dev/mcp

或使用本地服务:

claude mcp add --transport stdio bitbybit -- npx -y @bitbybit-dev/mcp

对于项目,可在项目根目录提交 .mcp.json,让每位协作者的 Claude Code 都能找到它:

{ "mcpServers": { "bitbybit": { "type": "http", "url": "https://mcp.bitbybit.dev/mcp" } } }

Cursor(.cursor/mcp.json)

{ "mcpServers": { "bitbybit": { "url": "https://mcp.bitbybit.dev/mcp" } } }

VS Code(.vscode/mcp.json)——必须指定 type,否则 VS Code 会尝试将 URL 作为程序启动:

{ "servers": { "bitbybit": { "type": "http", "url": "https://mcp.bitbybit.dev/mcp" } } }

两种配置都可以改为使用本地服务:{ "command": "npx", "args": ["-y", "@bitbybit-dev/mcp"] },在 VS Code 中还需加上 "type": "stdio"。

Codex

codex mcp add bitbybit --url https://mcp.bitbybit.dev/mcp

本地服务也可以通过 codex mcp add bitbybit -- npx -y @bitbybit-dev/mcp 添加。在 ~/.codex/config.toml 中,对应配置为 [mcp_servers.bitbybit] 和 url = "https://mcp.bitbybit.dev/mcp"。

Gemini CLI(gemini mcp add -t http bitbybit https://mcp.bitbybit.dev/mcp)、Windsurf(在 ~/.codeium/windsurf/mcp_config.json 中设置 serverUrl)、Zed(在其设置中配置 context_servers)和 JetBrains IDE(AI Assistant、MCP,使用包含 url 的 JSON 条目)都使用相同的地址。claude.ai、ChatGPT 和 Claude API 可通过自定义连接器连接远程服务——此处记录了所有配置。

提供的版本

此服务只记录某个确切 API 版本的文档。它按以下顺序确定版本:

  1. 命令行中的 --version <version>;
  2. 环境中的 BITBYBIT_VERSION=<version>;
  3. 工作目录附近安装的 @bitbybit-dev 软件包版本(依次检查 core、渲染器软件包,然后是 occt);版本不一致的软件包会报告到 stderr,并以第一个为准;
  4. 它自身的版本,即发布时所支持的最新 API 版本。

索引缓存在 $XDG_CACHE_HOME/bitbybit-mcp(或 ~/.cache/bitbybit-mcp)中;--no-cache 会跳过缓存。程序输出的所有内容都发送到 stderr;stdout 用于协议。

工具

工具可回答的问题
search_api按关键词搜索成员,并提供路径、摘要、层级和引擎
describe按点分隔的路径获取某个成员的完整契约,并列出其返回或接收的类型;按类型名称查询时,会逐字段列出该类型;若路径未知,则会报告最接近的现有路径
list_namespace列出命名空间下一级的成员
get_examples获取某个成员、命名空间或主题的代码示例
get_guide获取公开指南的各个章节:几何运算应在哪里运行、如何使用内核构建、检查和导出零件、如何编写设计文档,以及如何编写 IFC 建筑模型
search、fetch以 ChatGPT 连接器所需的相同格式执行查询

所有工具均为只读。回答中的层级:oss(位于 npm 软件包中,采用 MIT 许可证)、platform-pro(仅在 bitbybit.dev 内编写脚本时可用)、cloud-pro(仅在 CAD Cloud 上可用,需提供 API 密钥)。

配套服务

此服务用于回答问题;它不会运行几何运算。如果你希望 Agent 生成几何图形——测量 STEP 文件、运行管线、展开钣金零件、转换为 glTF——请同时连接 Bitbybit CAD Cloud MCP,并提供 CAD Cloud API 密钥:

claude mcp add --transport http bitbybit-cloud https://api.bitbybit.dev/mcp --header "X-API-Key: <your key>"

在 Codex 中,对应配置为 [mcp_servers.bitbybit-cloud],并使用 url = "https://api.bitbybit.dev/mcp" 和 env_http_headers = { "X-API-Key" = "BITBYBIT_API_KEY" },密钥从环境中读取。

二者专为协同工作而设计:Agent 在此处了解某个成员,然后在彼处使用相同的点分隔路径和相同的参数对象调用它。

作为库使用

该软件包会导出工具注册表和索引读取器,因此其他服务也可以提供相同的工具:

import { createDocsRegistry, contextForIndex, GUIDES, GUIDE_PAGE_URL } from "@bitbybit-dev/mcp";
import { loadIndex } from "@bitbybit-dev/mcp/index-loader";
import { createMcpServer } from "@bitbybit-dev/mcp/server";

const version = "<a released version>";
const index = await loadIndex({ version });
const context = contextForIndex(index, GUIDES, GUIDE_PAGE_URL);
const server = createMcpServer(createDocsRegistry(), context, { name: "bitbybit", version });

toHttp(registry, context) 会将相同的工具呈现为普通 HTTP 端点;guarded(registry, report) 是每个服务都会放在注册表外围的错误边界:处理器抛出异常时,会返回通用错误结果,并将异常交给 report,因此内部消息不会传递给客户端。Registry.map(wrap) 会重新包装每个处理器,以处理你自己的此类需求。软件包根目录不会导入任何 Node 内置模块,因此打包工具可以将其用于边缘运行时;会读取文件系统的加载器和版本检测器分别位于 index-loader 和 installed-version 条目中,而工具架构所使用的 $ref 内联器则位于无依赖的 json-schema 条目中。

隐私

stdio 服务除了向 CDN 发送一个请求以获取所提供版本的索引外,不会向任何地方发送数据。

链接

资源URL
使用 AI 搭配 Bitbybithttps://learn.bitbybit.dev/learn/using-ai-with-bitbybit/intro
本文档介绍的服务https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/bitbybit-mcp
CAD Cloud MCPhttps://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/cad-cloud-mcp
Agentic CAD - 几何运算应该在哪里运行https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/agentic-cad
上下文文件,适用于不支持 MCP 的宿主https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/prompt-contexts
GitHubhttps://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/mcp
单体仓库https://github.com/bitbybit-dev/bitbybit
TypeScript API 参考https://docs.bitbybit.dev

Bitbybit 平台

除了 NPM 软件包,Bitbybit 还提供:

  • 可视化编程编辑器 - Rete 和 Blockly 拖放式 3D 建模,以及 Monaco TypeScript 编辑器
  • CAD Cloud API - 构建完整的管线,组合所有 Bitbybit 算法,每个步骤都可以引用前序步骤的输出。支持参数化模型生成、STEP 到 glTF 的转换,以及通过 HTTP 执行复杂的 CAD 工作流
  • Bitbybit Studio - 不断扩展的可视化仪表板,API Key 用户可在其中生成模型、转换文件、通过 GUI 构建管线、检查任务并预览 3D 结果
  • 面向 Shopify 的 3D Bits - 适用于电子商务的交互式 3D 产品配置器
  • 脚本运行器 - 直接在你的网站上执行可视化脚本
  • 专为 AI 编码 Agent 打造 - 本服务、用于运行几何运算的 CAD Cloud MCP,以及适用于不支持 MCP 的助手的上下文文件
  • 商业与企业服务 - 我们帮助企业开发自定义应用,并在我们管理的服务上搭建经过优化的 CAD 租户工作流

支持项目

此软件包是开源 Bitbybit 生态系统的一部分。你的订阅有助于支持持续开发。

⭐ 订阅 - Silver 或 Gold 方案 | 获取 CAD Cloud API Key

社区

许可证

MIT © Bit By Bit Developers

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。