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 整合