Bitbybit CAD MCP

dev.bitbybitPublished by bitbybit.devOfficial publisherv1.6.0Updated Oct 29, 2026

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

VerifiedStreamable HTTPWeb executableKnowledge & MemoryDeveloper ToolsMedia & Design

Overview

AI-generated overview

Documents the Bitbybit 3D CAD API for coding agents: look up members, signatures, examples and guides for one exact API version.

What you can do
  • Search API members by keyword, with dotted path, summary, tier and supported engines
  • Describe one member's exact contract: signature, parameters, defaults, return type and types it uses
  • List the members one level below a namespace, or the top-level namespaces
  • Get working TypeScript examples for a member, namespace or topic
  • Read sections of the public guides on where geometry runs, kernel workflows, design documents and IFC models
  • Search and fetch documentation entries in the shape ChatGPT connectors require
When to use it
Use it when an assistant writes code against the Bitbybit CAD packages (OpenCascade, JSCAD, Manifold kernels with Babylon.js, three.js or PlayCanvas renderers, or the IFC library) and needs exact names, parameters and examples instead of guessing from memory. It is a documentation lookup only and does not run geometry.
Requirements
Either the hosted remote endpoint over Streamable HTTP, which needs nothing installed, or a local stdio process via npx that needs Node 20. No account, API key or headers are declared. The local server fetches the API index for its version from the Bitbybit CDN; the version can be set by command-line flag or the BITBYBIT_VERSION environment variable, otherwise it is detected from installed packages.
Before you install
All tools are read-only and the stdio server sends nothing except one request to the CDN for the index, but the remote endpoint is a third-party service. Answers carry tiers: platform-pro members exist only inside bitbybit.dev and cloud-pro members run only on Bitbybit CAD Cloud with an API key, so check the tier before relying on a member. Running geometry requires the separate CAD Cloud MCP with an X-API-Key, which may involve a paid service.

Installation

In SourceWeft

  1. Open Bitbybit CAD MCP in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/dev.bitbybit%2Fcad/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "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

Source: packages/dev/mcp/README.md at commit 2ab11c8

Tools

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.

Parameterslimitqueryrequiredengineversion

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.

Parameterspathrequiredversion

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.

Parameterspathversion

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.

Parameterspathlimittopicengineversion

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.

Parameterstopic

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.

Parametersidrequired

Version history

5
  1. v1.6.0LatestOct 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

Score

100% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

Other Bitbybit integrations