Metadata-Version: 2.4
Name: build123d-mcp
Version: 0.3.75
Summary: MCP server wrapping build123d for interactive 3D CAD
Project-URL: Homepage, https://github.com/pzfreo/build123d-mcp
Project-URL: Repository, https://github.com/pzfreo/build123d-mcp
Project-URL: Issues, https://github.com/pzfreo/build123d-mcp/issues
Author-email: Paul Fremantle <pzfreo@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
License-File: LICENSE
Keywords: 3d,ai,build123d,cad,mcp
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.15,>=3.11
Requires-Dist: augura>=0.1.6
Requires-Dist: bd-warehouse
Requires-Dist: build123d-drafting-helpers>=0.10.0
Requires-Dist: build123d<0.12,>=0.10
Requires-Dist: defusedxml>=0.7.1
Requires-Dist: mcp>=1.9
Requires-Dist: resvg-py
Requires-Dist: scipy
Requires-Dist: vtk>=9.3
Provides-Extra: http
Requires-Dist: uvicorn; extra == 'http'
Description-Content-Type: text/markdown

# build123d-mcp

[![PyPI version](https://img.shields.io/pypi/v/build123d-mcp)](https://pypi.org/project/build123d-mcp/)
[![Python](https://img.shields.io/pypi/pyversions/build123d-mcp)](https://pypi.org/project/build123d-mcp/)
[![CI](https://github.com/pzfreo/build123d-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/pzfreo/build123d-mcp/actions/workflows/ci.yml)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![build123d-mcp MCP server](https://glama.ai/mcp/servers/pzfreo/build123d-mcp/badges/score.svg)](https://glama.ai/mcp/servers/pzfreo/build123d-mcp)

Give your AI CAD eyes.

build123d-mcp is not a standalone chatbot or CAD program. It is a CAD toolbox
that an AI/LLM app can use through MCP.

With an LLM app such as Claude, Cursor, VS Code, Continue, Cline, or Codex CLI,
build123d-mcp lets the assistant create build123d CAD models, render previews,
measure geometry, fix mistakes, and export files such as STEP, STL, SVG, and
DXF. Instead of writing a whole CAD script blindly, the assistant can build a
part in small steps and check the result as it goes.

On the public [CADGenBench](https://huggingface.co/spaces/HuggingAI4Engineering/CADGenBench)
leaderboard in June 2026, using build123d-mcp raised the same model's score from
0.360 to 0.457 and CAD validity from 88% to 100%.

## Pick Your Setup

Most users should start with the local MCP server setup:

- You use Claude, Cursor, VS Code, Continue, Cline, or Codex CLI on your own
  machine.
- Your AI app starts `build123d-mcp` as a local subprocess.
- You do not need to clone this repository.

Use GitHub Codespaces instead if you want a browser-only trial or a ready-made
development workspace with Copilot Chat, Python, uv, and the CAD dependencies
already installed.

Use HTTP mode only for advanced deployments where you are hosting the MCP server
yourself.

## Quick Start

You need:

- [uv](https://github.com/astral-sh/uv)
- An AI/LLM app that supports MCP, such as Claude Code, Claude Desktop, Cursor,
  VS Code, Continue, Cline, or Codex CLI

No repository clone is needed for normal use. First check that the package can
start:

```bash
uv tool run --python 3.12 build123d-mcp@latest --version
```

Then add the same command to your AI app's MCP config. The common pieces are:

```text
command: uv
args:    ["tool", "run", "--python", "3.12", "build123d-mcp@latest"]
```

> Python 3.11, 3.12, 3.13, and 3.14 are supported. The examples use 3.12 because
> it is a conservative default, and uv can download it if you do not already
> have it installed.

## Connect To Your AI App

The pieces are:

- The LLM app is where you chat with the assistant.
- MCP is the connection that lets the assistant call tools.
- build123d-mcp is the CAD tool server the assistant calls.

The server normally runs over stdio. Your AI app starts it as a local subprocess
when it needs the CAD tools.

### Claude Code

Add this to your project's `.mcp.json`, or to `~/.claude/mcp.json` for global
use:

```json
{
  "mcpServers": {
    "build123d-mcp": {
      "command": "uv",
      "args": ["tool", "run", "--python", "3.12", "build123d-mcp@latest"]
    }
  }
}
```

Restart Claude Code after editing.

### Claude Desktop

Edit `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS,
or `%APPDATA%\Claude\claude_desktop_config.json` on Windows:

```json
{
  "mcpServers": {
    "build123d-mcp": {
      "command": "uv",
      "args": ["tool", "run", "--python", "3.12", "build123d-mcp@latest"]
    }
  }
}
```

Restart Claude Desktop after saving.

### Cursor

Open **Settings -> MCP** and add a new server entry, or edit
`~/.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "build123d-mcp": {
      "command": "uv",
      "args": ["tool", "run", "--python", "3.12", "build123d-mcp@latest"]
    }
  }
}
```

### VS Code, Continue, Cline, Codex CLI

Use the same command and arguments in whichever MCP config your AI app or
extension reads. The exact filename varies by app, but the server command is the
same:

```text
command: uv
args:    ["tool", "run", "--python", "3.12", "build123d-mcp@latest"]
```

For GitHub Copilot MCP support in VS Code, this repository includes a
`.vscode/mcp.json` for development checkouts and Codespaces. For another
workspace, the config looks like this:

```json
{
  "servers": {
    "build123d-mcp": {
      "type": "stdio",
      "command": "uv",
      "args": ["tool", "run", "--python", "3.12", "build123d-mcp@latest"]
    }
  }
}
```

## First Test Prompt

Once your AI app is connected to the server, ask your assistant something
concrete:

```text
Use build123d-mcp to make a 60 mm x 40 mm x 6 mm mounting plate with two
5 mm through holes 40 mm apart. Render it, measure it, then export STEP and STL.
```

The useful loop is:

1. Build one feature at a time.
2. Render or measure after important steps.
3. Validate before export.
4. Export the final part.

If something goes wrong, ask the assistant to inspect `last_error`, repair the
script, and try the next smaller step.

Good prompts usually ask the assistant to use the MCP tools explicitly and to
verify the result before exporting. For example:

```text
Use build123d-mcp. Build this incrementally, render after the main features,
measure the final dimensions, run validate(), and export STEP if it passes.
```

## Try It In GitHub Codespaces With Copilot

You can also run the project in a browser with GitHub Codespaces:

[Open in GitHub Codespaces](https://codespaces.new/pzfreo/build123d-mcp)

For a beginner, this is the closest path to "GitHub-hosted LLM + MCP":

- GitHub Codespaces gives you VS Code in the browser.
- GitHub Copilot Chat gives you the LLM assistant.
- build123d-mcp runs inside the codespace as the MCP CAD tool server.

You need GitHub Copilot access for the LLM part. The codespace itself gives you
a throwaway workspace with the project already checked out and the right
Python/CAD dependencies installed. It is useful when you want to:

- Try the project without changing your laptop setup
- Run the tests before making a contribution
- Use Copilot Chat and build123d-mcp together in the same browser workspace

GitHub's docs cover:

- [Using Copilot in Codespaces](https://docs.github.com/en/codespaces/reference/using-github-copilot-in-github-codespaces)
- [Extending Copilot Chat with MCP](https://docs.github.com/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp)

This repository includes a dev container that installs Python 3.12, uv, and the
Linux display packages needed for headless rendering. It also installs the
GitHub Copilot VS Code extensions and includes a workspace MCP config at
`.vscode/mcp.json`.

When the codespace opens, it runs:

```bash
uv sync --all-groups
```

To check the development install:

```bash
uv run build123d-mcp --version
uv run pytest
```

To use Copilot with the local CAD server:

1. Open the codespace.
2. Wait for setup to finish.
3. Open Copilot Chat and choose Agent mode.
4. Open `.vscode/mcp.json` and start the `build123d-mcp` server if VS Code has
   not started it already.
5. Ask the first test prompt from the previous section.

The Codespaces MCP config points at the local checkout rather than the PyPI
package:

```json
{
  "servers": {
    "build123d-mcp": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "build123d-mcp"]
    }
  }
}
```

Codespaces is a good fit for trying the project, contributing, or using GitHub
Copilot and build123d-mcp in one remote environment. For desktop AI apps on your
own machine, the normal `uv tool run ... build123d-mcp@latest` setup is simpler
because those apps expect to start the MCP server locally.

## What It Can Do

build123d-mcp gives an assistant tools to:

- Execute build123d code in a persistent CAD session
- Render PNG, SVG, and DXF previews
- Measure volume, area, bounding boxes, topology, and centers of mass
- Find holes, bosses, countersinks, and hole patterns
- Check printability, fit/alignment comparisons, and export validity
- Import STEP/STL files for comparison
- Export STEP, STL, DXF, SVG, or multiple formats at once
- Save and restore session snapshots
- Produce 2D engineering drawing previews

For the complete tool and resource reference, see [llms.md](llms.md).

## Guidance For Assistants

The server includes workflow guidance that helps assistants use the CAD loop
properly. This is especially useful in coding agents that read project guidance
files.

After connecting the server, ask your assistant to call `install_skill` for the
workflow you need:

```text
install_skill(target="agents-md", skill="modeling")
install_skill(target="agents-md", skill="drawing")
install_skill(target="agents-md", skill="repair")
```

`install_skill` also supports `target="claude"`, `"cursor"`, and `"windsurf"`.
Use `skill="modeling"` for 3D parts, `skill="drawing"` for engineering drawings,
and `skill="repair"` when a solid fails validation.

You can also paste [default_prompt.md](default_prompt.md) into your AI app as a
system prompt.

## Developer Setup

For local development:

```bash
git clone https://github.com/pzfreo/build123d-mcp.git
cd build123d-mcp
uv sync --all-groups
uv run build123d-mcp --version
uv run pytest
```

To run the server from this checkout in an AI app, use:

```text
command: uv
args:    ["run", "build123d-mcp"]
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

## Advanced Use

The default stdio transport gives each app process its own isolated session.
HTTP mode is available for web, container, or remote deployments:

```bash
uv tool run --python 3.12 "build123d-mcp[http]@latest" \
  --transport http --host 127.0.0.1 --port 8000
```

HTTP-capable apps then connect to:

```text
http://localhost:8000/mcp
```

HTTP mode has no built-in authentication and uses one shared CAD session unless
the host provides per-request session middleware. Do not expose it to multiple
users directly.

Other advanced topics:

- Security model and sandboxing: [security.md](security.md)
- Complete tool reference: [llms.md](llms.md)
- Live session viewer: [docs/live-viewer.md](docs/live-viewer.md)
- Changelog: [CHANGELOG.md](CHANGELOG.md)

## Status

Active development.

<!-- mcp-name: io.github.pzfreo/build123d-mcp -->
