Bitbybit CAD MCP

dev.bitbybit由 bitbybit.dev 发布官方发布者v1.6.0更新于 Oct 29, 2026

Bitbybit 3D parametric CAD API, version-exact, for coding agents: search, describe, examples, guide

已验证Streamable HTTP可网页运行知识与记忆开发者工具媒体与设计

概览

AI 生成的概览

为编码助手提供 Bitbybit 3D CAD API 文档:按精确版本查询成员、签名、示例与指南。

可以做什么
  • 按关键词搜索 API 成员,返回点分路径、摘要、层级与支持的引擎
  • 描述单个成员的完整契约:签名、参数、默认值、返回类型及其涉及的类
  • 列出某个命名空间下一层的成员,或不带路径时列出顶层命名空间
  • 获取某个成员、命名空间或主题的可运行 TypeScript 示例
  • 阅读公开指南章节:几何在何处运行、内核工作流、设计文档与 IFC 模型
  • 以 ChatGPT 连接器要求的格式搜索并获取文档条目
适用场景
当助手要针对 Bitbybit CAD 包(OpenCascade、JSCAD、Manifold 内核,配合 Babylon.js、three.js 或 PlayCanvas 渲染器,或 IFC 库)编写代码,需要准确的名称、参数和示例而不是凭记忆猜测时使用。它只做文档查询,不执行几何运算。
运行要求
可使用托管的远程端点(Streamable HTTP,无需安装任何东西),或通过 npx 在本地以 stdio 运行,需要 Node 20。未声明需要账号、API 密钥或请求头。本地服务器会从 Bitbybit CDN 获取对应版本的 API 索引;版本可通过命令行参数或 BITBYBIT_VERSION 环境变量指定,否则从已安装的包中检测。
安装前请注意
所有工具均为只读,stdio 服务器除向 CDN 请求一次索引外不发送任何数据,但远程端点是第三方服务。答案带有层级标记:platform-pro 成员仅存在于 bitbybit.dev 内,cloud-pro 成员只能在 Bitbybit CAD Cloud 上凭 API 密钥运行,使用前请确认层级。实际运行几何运算需要另配 CAD Cloud MCP 并提供 X-API-Key,可能涉及付费服务。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Bitbybit CAD MCP,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/dev.bitbybit%2Fcad/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。

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

README

@bitbybit-dev/mcp: the Bitbybit CAD MCP server

An MCP server that documents the Bitbybit 3D CAD API for AI coding agents: every function, its parameters, defaults, return type and examples, for the exact version your project uses. Bitbybit has 2205 functions across three CAD kernels - more than any model holds in memory - so an agent working from memory invents plausible names that do not exist. An agent with this server looks each one up instead, and writes code that compiles the first time.

It answers from the API index Bitbybit publishes with every release (https://git-cdn.bitbybit.dev/v<version>/ai-context/index.json), never from memory, and never from a moving "latest".

[Diagram of the Bitbybit platform showing how a website reaches its geometry: script runners, iframe embeds, the NPM packages, the CAD Cloud REST API and AI agents over MCP]

The diagram shows what an agent is writing code for. The MIT-licensed npm packages run the CAD kernels in your users' browsers or in your own Node process; script runners load the same engine from one file; the CAD Cloud REST API runs the work on managed servers. This server knows all of them, and every answer carries a tier - oss, platform-pro or cloud-pro - so an agent never sends you to a paid service for something the free packages already do.

Connect it

The same server runs two ways. Hosted at https://mcp.bitbybit.dev/mcp over Streamable HTTP, which needs nothing installed and serves the newest release; or locally over stdio with npx, which needs Node 20 and serves the version your project has installed. Start with the remote.

[Add to Cursor] [Install in VS Code] [Install in VS Code Insiders]

Claude Code

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

or the local server:

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

For a project, commit a .mcp.json at its root so every collaborator's Claude Code finds it:

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

Cursor (.cursor/mcp.json)

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

VS Code (.vscode/mcp.json) - the type is required, or VS Code tries to start the URL as a program:

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

Either form takes the local server instead: { "command": "npx", "args": ["-y", "@bitbybit-dev/mcp"] }, with "type": "stdio" in VS Code.

Codex

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

or codex mcp add bitbybit -- npx -y @bitbybit-dev/mcp for the local server. In ~/.codex/config.toml that is [mcp_servers.bitbybit] with url = "https://mcp.bitbybit.dev/mcp".

Gemini CLI (gemini mcp add -t http bitbybit https://mcp.bitbybit.dev/mcp), Windsurf (serverUrl in ~/.codeium/windsurf/mcp_config.json), Zed (context_servers in its settings) and the JetBrains IDEs (AI Assistant, MCP, a JSON entry with url) take the same address. claude.ai, ChatGPT and the Claude API connect to the remote as a custom connector - every configuration is documented here.

Which version it serves

The server documents one exact version of the API. It picks it in this order:

  1. --version <version> on the command line;
  2. BITBYBIT_VERSION=<version> in the environment;
  3. the version of the @bitbybit-dev packages installed around the working directory (core, then the renderer packages, then occt); packages that disagree are reported on stderr and the first wins;
  4. its own version, which is the newest API version it was released with.

Indexes are cached in $XDG_CACHE_HOME/bitbybit-mcp (or ~/.cache/bitbybit-mcp); --no-cache skips the cache. Everything the program prints goes to stderr; stdout is the protocol.

Tools

ToolWhat it answers
search_apimembers by keywords, with path, summary, tier and engines
describethe full contract of one member by dotted path, naming the types it returns or takes; such a type by its name, field by field; an unknown path is reported with the nearest existing ones
list_namespacethe members one level below a namespace
get_examplescode examples for a member, a namespace or a topic
get_guidesections of the public guides: where geometry should run, how to build, check and export parts with the kernels, how to write design documents, and how to write IFC building models
search, fetchthe same lookups in the shape ChatGPT connectors require

Every tool is read-only. Tiers in the answers: oss (in the npm packages, MIT), platform-pro (only when scripting inside bitbybit.dev), cloud-pro (only on CAD Cloud, with an API key).

The companion server

This server answers questions; it never runs geometry. When you want the agent to produce geometry - measure a STEP file, run a pipeline, unfold a sheet-metal part, convert to glTF - connect the Bitbybit CAD Cloud MCP alongside it, with a CAD Cloud API key:

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

In Codex the same is [mcp_servers.bitbybit-cloud] with url = "https://api.bitbybit.dev/mcp" and env_http_headers = { "X-API-Key" = "BITBYBIT_API_KEY" }, the key read from the environment.

The two are designed to work together: the agent learns a member here and calls it there with the same dotted path and the same argument object.

As a library

The package exports the tool registry and the index reader, so another server can serve the same tools:

ts
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) renders the same tools for a plain HTTP endpoint, and guarded(registry, report) is the error boundary every server puts around a registry: a handler that throws answers a generic error result and the throw goes to report, so no internal message reaches a client. Registry.map(wrap) re-wraps every handler for such concerns of your own. The package root imports no Node built-in, so a bundler can take it into an edge runtime; the loader and the version detector, which read the file system, are the separate index-loader and installed-version entries, and the $ref inliner the tool schemas go through is the dependency-free json-schema entry.

Privacy

The stdio server sends nothing anywhere except one request to the CDN for the index of the version it serves.

Links

Bitbybit Platform

Beyond NPM packages, Bitbybit offers:

  • Visual Programming Editors - Rete & Blockly drag-and-drop 3D modeling, plus a Monaco TypeScript editor
  • CAD Cloud API - Build full pipelines that compose all Bitbybit algorithms, where each step can reference outputs of previous steps. Supports parametric model generation, STEP-to-glTF conversion, and complex CAD workflows via HTTP
  • Bitbybit Studio - A growing visual dashboard where API Key users can generate models, convert files, build pipelines with a GUI, inspect tasks, and preview 3D results
  • 3D Bits for Shopify - Interactive 3D product configurators for e-commerce
  • Script Runners - Execute visual scripts directly on your website
  • Built for AI Coding Agents - This server, the CAD Cloud MCP for running geometry, and context files for assistants without MCP
  • Business & Enterprise - We help businesses and enterprises develop custom applications and spin up optimized CAD tenant workflows on our managed servers

Support the Project

This package is part of the open-source Bitbybit ecosystem. Your subscription helps fund continued development.

⭐ Subscribe - Silver or Gold plan | Get API Key for CAD Cloud

Community

License

MIT © Bit By Bit Developers

来源:packages/dev/mcp/README.md,提交 2ab11c8

工具

7

search_api

Search the Bitbybit API

Find Bitbybit API members (methods, namespaces, cloud operations) by keywords, for example "box solid" or "fillet edges". Returns dotted paths with a one-line summary, the tier (oss on npm, platform-pro only at bitbybit.dev, cloud-pro only on CAD Cloud) and the engines each is published for. Call describe with a path before writing code that uses it.

输入参数limitquery必填engineversion

describe

Describe an API member

The exact contract of one member by dotted path, for example occt.shapes.solid.createBox: signature, every parameter with its type, default and range, the return type, the documentation, examples and where it runs. Answers are for the API version the server holds. It also describes the types a member returns or takes by their name, for example Inputs.IFC.SpaceInfoDto, field by field, and a member's answer lists those types. An unknown path is reported as not found together with the nearest existing paths; nothing is guessed.

输入参数path必填version

list_namespace

List a namespace

The members one level below a namespace path, for example occt.shapes, each with its kind and summary. Without a path, the top-level namespaces. Use it to discover what exists before searching for details.

输入参数pathversion

get_examples

Get code examples

Working TypeScript examples for a member path, for a namespace, or for a topic given as keywords. Each example names the member it belongs to and links its reference page. Examples are written for the API version the server holds.

输入参数pathlimittopicengineversion

get_guide

Read the guides

Sections of the public guides: building with Bitbybit (what runs in the browser, on a server, on a lightweight backend, and what needs CAD Cloud), writing geometry with the kernels (which kernel to use, the order to build a part in, choosing edges, checking and exporting shapes), writing design documents (parametric models as JSON: parameters, sketches, features, references, parts and assemblies), and writing IFC building models (storeys, walls and their joins, doors, windows, slabs, roofs, rooms, properties and quantities). Without a topic it lists the sections. Read "integrate" before recommending where geometry should run: the npm packages are the default, and CAD Cloud is for algorithms that exist only there or compute the caller cannot provide. Read "geometry" before writing geometry code, "design" before writing a design document, and "ifc" before writing an IFC model.

输入参数topic

fetch

Fetch

Fetches the full documentation of one Bitbybit API member by id (a dotted path returned by search) as text, with its title, url and metadata.

输入参数id必填

版本历史

5
  1. v1.6.0最新Oct 29, 2026
  2. v1.5.0Oct 12, 2026
  3. v1.4.1Oct 2, 2026
  4. v1.4.0Sep 30, 2026
  5. v1.3.2Sep 20, 2026

评分

已满足适用检查项的 100%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

其他 Bitbybit 集成