pycadmcp 0.1.0__tar.gz

pycadmcp-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  offline:
+    name: Offline checks
+    runs-on: windows-latest
+    defaults:
+      run:
+        shell: pwsh
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install package + dev deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Ruff
+        run: python -m ruff check .
+
+      - name: Pytest (offline)
+        env:
+          PYTHONPATH: "."
+          PYTHONUTF8: "1"
+          PYTHONIOENCODING: "utf-8"
+        run: python -m pytest -q -m "not sw"
+
+      - name: Tool inventory check
+        env:
+          PYTHONPATH: "."
+        run: python scripts/tool_inventory.py --check

pycadmcp-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pycadmcp-0.1.0/.gitignore

@@ -0,0 +1,54 @@
+# Environment
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Test / tool caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Runtime artifacts (workspace hygiene)
+logs/
+*.log
+backup_*/
+output/
+workspace/
+.env
+.env.*
+
+# Real-machine / probe artifacts (stay on the Windows workstation)
+spike*.json
+probe_out/
+deliverables/
+archive/
+*.bak
+
+# Read-only reference clones
+.refs/
+
+# Evidence moved out of the package tree (never wheel / never public export)
+internal-evidence/
+
+# Editor / OS
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+*.swp
+*~
+
+# Local IDE / agent workspace noise (tracked .opencode/skills sync can stay until export)
+.cursor/
+.codegraph/
+
+# One-shot S9 API snapshot (must not overwrite / commit; compare locally)
+cadmcp/backend/api_baseline_s9.json

pycadmcp-0.1.0/ARCHITECTURE.md

@@ -0,0 +1,62 @@
+# Architecture
+
+Product runtime constraints for `cadmcp`. This document is **not** an
+internal agent playbook; it describes what any SolidWorks COM maintainer
+must preserve.
+
+## Backends
+
+| Backend | Package | Role |
+|---|---|---|
+| Protocol / CAD-neutral | `cadmcp.backend.protocol` | Shared models, validators, `CADBackend` surface |
+| Fake | `cadmcp.backend.fake` | Offline geometry engine for CI and local tests |
+| SolidWorks | `cadmcp.backend.solidworks` | Real COM automation (Windows + SolidWorks 2025) |
+
+`fake` and `solidworks` are peer implementations of the same protocol.
+Feature packages must not depend on assembly packages across domains.
+Business mixins must not import `backend.py` composition modules.
+
+## STA (SolidWorks COM)
+
+All SolidWorks COM work runs on a dedicated Single-Threaded Apartment (STA)
+thread:
+
+1. Every COM call goes through the STA executor.
+2. Business mixins must not open their own COM connections.
+3. COM objects must not be used from other threads.
+4. COM objects must not be passed across threads.
+5. COM init / attach / release / exception mapping stay on the STA lifecycle.
+6. Thread start / stop / ready / error state remain explicit.
+7. COM reference release is audited carefully.
+
+Business mixins call COM only via `infrastructure.py`, which is the sole
+business-side facade over `sta.py`. `sta.py` must not depend upward on
+`infrastructure.py`.
+
+## Layering
+
+```text
+toolsets / kernel / executor
+        ↓
+backend protocol models
+        ↓
+fake  ⊥  solidworks
+              ↓
+     infrastructure → sta
+```
+
+- `naming.py` owns feature-name alias state.
+- Sketch lifecycle state lives in the sketch modules.
+- Error codes for COM failures are mapped in `sta.py` only.
+
+## Public API stability
+
+Do not casually rename public tools, change default arguments, reorder COM
+API sequences, or alter OpResult / error envelopes. Compatibility shims for
+the pre-rename package name were removed; see [docs/naming.md](docs/naming.md).
+
+## Skills and resources
+
+Usage-layer skills ship as markdown under
+`cadmcp/resources/content/skills/` and are exposed as `cadmcp://skill/...`
+resources (same source as `help` topics under `cadmcp://help/...`).

pycadmcp-0.1.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+once public tags are cut.
+
+## [Unreleased]
+
+### Added
+
+- Public project facade: MIT license, four-language READMEs, CONTRIBUTING,
+  SECURITY, ARCHITECTURE, CHANGELOG, and CI workflow.
+- `examples/box_recipe.json` for `replay_recipe` quick start.
+- Naming gate (`tests/architecture/test_naming.py`) and [docs/naming.md](docs/naming.md).
+
+### Changed
+
+- Product identity is **cadmcp** (distribution, import, CLI). SolidWorks COM
+  backend lives under `cadmcp.backend.solidworks` with `--backend solidworks`.
+- Resource URIs use `cadmcp://`; environment variables use `CADMCP_*`.
+
+### Removed
+
+- Compatibility shims for the pre-rename package name (`backend/base.py`,
+  `com_backend.py`, `fake_backend.py`, `compat/`). See [docs/naming.md](docs/naming.md).
+
+## [0.1.0] — 2026-11-10
+
+First public release on GitHub and PyPI (`pip install pycadmcp`;
+import/CLI remain `cadmcp`).

pycadmcp-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Thanks for helping improve **cadmcp**.
+
+## Where to send changes
+
+| Kind of change | Where |
+|---|---|
+| Public bug fixes, docs, examples | Open a **GitHub** pull request against the public repo |
+| Day-to-day product development | Happens on the **internal Gitee** tree (whitelist export → GitHub) |
+
+Do **not** treat the GitHub mirror as the primary development remote. Maintainers
+merge GitHub PRs, then **patch-back** the diff onto Gitee (`gh pr diff` /
+`git format-patch` → apply on Gitee → green tests → next Sync export).
+Commit SHAs are **not** shared between the two remotes.
+
+## Development setup
+
+```bash
+git clone https://github.com/shiyang19822000/cad-mcp.git
+cd cad-mcp
+python -m venv .venv
+# Windows: .venv\Scripts\activate
+source .venv/bin/activate
+pip install -e ".[dev]"   # or: uv sync
+```
+
+Offline checks (no SolidWorks required):
+
+```bash
+ruff check .
+pytest -q
+python scripts/tool_inventory.py --check
+```
+
+## Coding rules (short)
+
+- Keep tool names, schemas, and COM call order stable unless the PR is an
+  intentional breaking change.
+- SolidWorks COM must stay on the STA path — see [ARCHITECTURE.md](ARCHITECTURE.md).
+- Prefer asserting `error.code` over brittle message substrings.
+- Do not add compatibility aliases for removed legacy package names
+  (see [docs/naming.md](docs/naming.md)).
+
+## Pull requests
+
+1. One concern per PR when practical.
+2. Include offline test results in the description.
+3. Update [CHANGELOG.md](CHANGELOG.md) for user-visible changes.
+4. DE/JA README edits should keep chapter structure aligned with `README.md`
+   (English is authoritative).
+
+## Security
+
+See [SECURITY.md](SECURITY.md). Do not file public issues for vulnerabilities.

pycadmcp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 shiyang19822000
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pycadmcp-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.5
+Name: pycadmcp
+Version: 0.1.0
+Summary: CAD MCP server: one process, dedicated STA executor, offline-testable (SolidWorks backend first)
+Project-URL: Homepage, https://github.com/shiyang19822000/cad-mcp
+Project-URL: Repository, https://github.com/shiyang19822000/cad-mcp.git
+Project-URL: Issues, https://github.com/shiyang19822000/cad-mcp/issues
+Author-email: shiyang19822000 <shiyang19822000@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cad,com,mcp,solidworks,sta
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.26.0
+Requires-Dist: mcp>=2.3.0
+Requires-Dist: pydantic>=2.14.1
+Requires-Dist: pywin32>=312; sys_platform == 'win32'
+Requires-Dist: starlette>=0.48
+Requires-Dist: uvicorn>=0.34
+Provides-Extra: dev
+Requires-Dist: httpx>=0.28.1; extra == 'dev'
+Requires-Dist: pytest>=9.1.1; extra == 'dev'
+Requires-Dist: pyyaml>=6.0; extra == 'dev'
+Requires-Dist: ruff>=0.17.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cadmcp
+
+**Languages:** [English](README.md) · [简体中文](README.zh-CN.md) · [Deutsch](README.de.md) · [日本語](README.ja.md)
+
+CAD MCP server: one process, a dedicated STA executor, and an offline-testable
+Fake backend — **SolidWorks backend first**.
+
+> **Not affiliated with Dassault Systèmes.** SolidWorks® is a trademark of
+> Dassault Systèmes or its subsidiaries. This project is an independent
+> community MCP server.
+
+[![CI](https://github.com/shiyang19822000/cad-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/shiyang19822000/cad-mcp/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/pycadmcp.svg)](https://pypi.org/project/pycadmcp/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## Requirements
+
+| Mode | Needs |
+|---|---|
+| **Fake backend (default for CI)** | Python 3.11+, Windows/macOS/Linux |
+| **SolidWorks backend** | Windows + SolidWorks **2025** (ProgID `SldWorks.Application` / `SOLIDWORKS_2025`) + `pywin32` |
+
+The full offline test suite runs against **FakeBackend** — you do **not** need
+SolidWorks installed to develop or verify locally.
+
+## Install
+
+```bash
+pip install pycadmcp
+```
+
+For development (editable + test tools):
+
+```bash
+git clone https://github.com/shiyang19822000/cad-mcp.git
+cd cad-mcp
+python -m venv .venv
+# Windows PowerShell:
+.\.venv\Scripts\Activate.ps1
+pip install -e ".[dev]"
+```
+
+CLI entry point: `cadmcp`.
+
+## Quick start
+
+Health check (Fake):
+
+```bash
+cadmcp doctor --backend fake
+```
+
+Replay a design recipe from the workspace (Fake):
+
+```bash
+# Copy examples/box_recipe.json into your workspace, then via MCP tool:
+#   replay_recipe(path="box_recipe.json")
+# Or drive the same tools interactively through an MCP client.
+```
+
+Install into a local MCP client (writes server key `solidworks`):
+
+```bash
+cadmcp install --client opencode --dry-run
+cadmcp install --client opencode
+```
+
+Stdio serve (typical for editors):
+
+```bash
+cadmcp serve --transport stdio --backend fake --profile part
+```
+
+For real SolidWorks, use `--backend solidworks` on Windows with SolidWorks running.
+
+## Capability matrix
+
+**134 tools** across 9 toolsets (see [docs/TOOL_INVENTORY.md](docs/TOOL_INVENTORY.md)):
+
+| Toolset | Count | Focus |
+|---|---|---|
+| core | 45 | Documents, sketches, basic features, queries |
+| features_adv | 25 | Thread, helix, sweep, surfaces, feature ops |
+| assembly | 20 | Insert, mates, component ops |
+| drawing | 16 | Views, annotations, DrawingSpec |
+| sketch_adv | 12 | Splines, offset/trim, constraints, dims |
+| sheetmetal | 7 | Base/flange/hem, flat pattern |
+| selection | 6 | Face/edge pick helpers |
+| view | 2 | Orientations / screenshots |
+| export | 1 | STEP/STL/PDF/DXF |
+
+Skills (`solidworks-modeling`, `solidworks-assembly`, `solidworks-recovery`)
+ship as `cadmcp://skill/...` resources.
+
+## Architecture (summary)
+
+- **Protocol layer** shared by Fake and SolidWorks backends.
+- **SolidWorks COM** runs only on a dedicated **STA** thread; business code
+  never creates COM connections itself.
+- Tool results use a typed OpResult envelope (`ok` / `error.code` / `delta` /
+  `state_version`).
+
+Details: [ARCHITECTURE.md](ARCHITECTURE.md). Naming history: [docs/naming.md](docs/naming.md).
+
+## Testing
+
+Offline (default):
+
+```bash
+ruff check .
+pytest -q
+python scripts/tool_inventory.py --check
+```
+
+Real SolidWorks (destructive):
+
+```bash
+# WARNING: closes all open SolidWorks documents WITHOUT saving.
+set CADMCP_REAL_SW=1
+pytest -q -m sw
+```
+
+Only run real-SW tests on disposable sessions.
+
+## Known limitations
+
+| Limitation | Notes |
+|---|---|
+| Mold Core/Cavity | Blocked pending reliable parting-surface / license context — [#1](https://github.com/shiyang19822000/cad-mcp/issues/1) |
+| Native InsertThread API | Helix + sweep cut path is used instead — [#2](https://github.com/shiyang19822000/cad-mcp/issues/2) |
+| SolidWorks Toolbox | Not integrated — [#3](https://github.com/shiyang19822000/cad-mcp/issues/3) |
+| Part in-context edit (`EditPart2`) | Not supported; subassembly edit is — [#4](https://github.com/shiyang19822000/cad-mcp/issues/4) |
+| Axial screw-in / feed mate motion | Not supported |
+
+## License
+
+[MIT](LICENSE) — Copyright (c) 2026 shiyang19822000.
+
+Not affiliated with Dassault Systèmes. SolidWorks® is a trademark of
+Dassault Systèmes or its subsidiaries.

pycadmcp-0.1.0/README.de.md

@@ -0,0 +1,117 @@
+# cadmcp
+
+**Sprachen:** [English](README.md) · [简体中文](README.zh-CN.md) · [Deutsch](README.de.md) · [日本語](README.ja.md)
+
+> **English README is authoritative; translations welcome via PR.**
+
+CAD-MCP-Server: ein Prozess, eigener STA-Executor, offline testbares Fake-Backend —
+**SolidWorks-Backend zuerst**.
+
+> **Nicht verbunden mit Dassault Systèmes.** SolidWorks® ist eine Marke von
+> Dassault Systèmes oder verbundenen Unternehmen. Dies ist ein unabhängiger
+> Community-MCP-Server.
+
+[![CI](https://github.com/shiyang19822000/cad-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/shiyang19822000/cad-mcp/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/pycadmcp.svg)](https://pypi.org/project/pycadmcp/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## Anforderungen
+
+| Modus | Benötigt |
+|---|---|
+| **Fake-Backend (CI-Standard)** | Python 3.11+, Windows/macOS/Linux |
+| **SolidWorks-Backend** | Windows + SolidWorks **2025** + `pywin32` |
+
+Die komplette Offline-Testsuite läuft gegen **FakeBackend** — SolidWorks ist
+für lokale Entwicklung nicht erforderlich.
+
+## Installation
+
+```bash
+pip install pycadmcp
+```
+
+Entwicklung (editierbar + Testdeps):
+
+```bash
+git clone https://github.com/shiyang19822000/cad-mcp.git
+cd cad-mcp
+python -m venv .venv
+# Windows:
+.\.venv\Scripts\Activate.ps1
+pip install -e ".[dev]"
+```
+
+CLI: `cadmcp`.
+
+## Schnellstart
+
+```bash
+cadmcp doctor --backend fake
+```
+
+Beispiel-Rezept: `examples/box_recipe.json` (MCP-Tool `replay_recipe`).
+
+```bash
+cadmcp install --client opencode --dry-run
+cadmcp serve --transport stdio --backend fake --profile part
+```
+
+Für echte SolidWorks-Nutzung: `--backend solidworks` unter Windows.
+
+## Fähigkeitsmatrix
+
+**134 Tools** in **9 Toolsets** — siehe [docs/TOOL_INVENTORY.md](docs/TOOL_INVENTORY.md).
+
+| Toolset | Anzahl | Fokus |
+|---|---|---|
+| core | 45 | Dokumente, Skizzen, Basis-Features, Abfragen |
+| features_adv | 25 | Gewinde, Helix, Sweep, Flächen |
+| assembly | 20 | Einfügen, Verknüpfungen, Komponenten |
+| drawing | 16 | Ansichten, Annotationen |
+| sketch_adv | 12 | Splines, Offset/Trim, Bemaßungen |
+| sheetmetal | 7 | Blech |
+| selection | 6 | Flächen-/Kantenwahl |
+| view | 2 | Ansichten / Screenshots |
+| export | 1 | STEP/STL/PDF/DXF |
+
+Skills: `cadmcp://skill/...`.
+
+## Architektur (Kurz)
+
+- Gemeinsame Protocol-Schicht für Fake und SolidWorks.
+- SolidWorks-COM nur auf einem **STA**-Thread.
+- Ergebnisse als OpResult-Umschlag.
+
+Details: [ARCHITECTURE.md](ARCHITECTURE.md). Umbenennung: [docs/naming.md](docs/naming.md).
+
+## Tests
+
+```bash
+ruff check .
+pytest -q
+python scripts/tool_inventory.py --check
+```
+
+Echte SolidWorks-Tests (schließen Dokumente **ohne Speichern**):
+
+```bash
+set CADMCP_REAL_SW=1
+pytest -q -m sw
+```
+
+## Bekannte Einschränkungen
+
+| Einschränkung | Hinweis |
+|---|---|
+| Mold Core/Cavity | Blockiert — [#1](https://github.com/shiyang19822000/cad-mcp/issues/1) |
+| Native InsertThread-API | Helix + Sweep-Cut-Pfad — [#2](https://github.com/shiyang19822000/cad-mcp/issues/2) |
+| Toolbox | Nicht integriert — [#3](https://github.com/shiyang19822000/cad-mcp/issues/3) |
+| Part in-context edit | Nicht unterstützt — [#4](https://github.com/shiyang19822000/cad-mcp/issues/4) |
+| Axiale Einschraubbewegung | Nicht unterstützt |
+
+## Lizenz
+
+[MIT](LICENSE) — Copyright (c) 2026 shiyang19822000.
+
+Nicht verbunden mit Dassault Systèmes.