solidworks-mcp-python 1.5.0__tar.gz

solidworks_mcp_python-1.5.0/.gitignore

@@ -0,0 +1,104 @@
+# Dependencies
+node_modules/
+yarn.lock
+pnpm-lock.yaml
+
+# Build output
+dist/
+build/
+*.tsbuildinfo
+info/
+
+# Environment files
+.env
+.env.local
+.env.*.local
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# Testing
+coverage/
+.nyc_output
+
+# State files
+.solidworks-state.json
+*.state.json
+
+# Temporary files
+*.tmp
+*.temp
+.cache/
+.tmp_diag_*.py
+
+# npm pack output
+*.tgz
+
+# Python virtualenv (for any Python integrations)
+venv/
+__pycache__/
+*.pyc
+EOF < /dev/null
+.prettierrc
+
+# docs folder (if built locally)
+site/
+coverage.xml
+.coverage
+.coverage.*
+
+# Generated test artifacts
+tests/.generated/
+
+# Runtime-generated agent / cache artifacts
+.generated/
+.solidworks_mcp/
+htmlcov/
+.playwright-mcp/
+tmp/ui_smoke/
+
+# Claude local settings (personal, machine-specific)
+.claude/*
+!.claude/commands/
+!.claude/commands/**
+!.claude/skills/
+!.claude/skills/**
+
+# random mypy artifacts
+mypy_*
+
+.mypy_cache/
+uv.lock
+.venv
+.venv/
+
+# Live-demo artefacts produced by scripts/demo_sketches.py
+out/
+
+# Live demo recordings: the raw frames and the README demo's stills are
+# working files; the GIFs and the call transcript are what gets published.
+docs/assets/demos/*/recording/
+docs/assets/demos/readme/*.png

solidworks_mcp_python-1.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ESPO Corporation
+
+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.

solidworks_mcp_python-1.5.0/PKG-INFO

@@ -0,0 +1,410 @@
+Metadata-Version: 2.5
+Name: solidworks-mcp-python
+Version: 1.5.0
+Summary: Python MCP server for SolidWorks: lets Claude and other AI agents build parts, assemblies and drawings through the SolidWorks COM API.
+Project-URL: Homepage, https://github.com/andrewbartels1/SolidworksMCP-python
+Project-URL: Documentation, https://andrewbartels1.com/SolidworksMCP-python/
+Project-URL: Bug Reports, https://github.com/andrewbartels1/SolidworksMCP-python/issues
+Project-URL: Source, https://github.com/andrewbartels1/SolidworksMCP-python
+Project-URL: Changelog, https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/CHANGELOG.md
+Author: Andrew Bartels
+Maintainer: Andrew Bartels
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai-agents,cad,cad-automation,claude,mcp,mcp-server,model-context-protocol,pywin32,solidworks,solidworks-api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Software Distribution
+Requires-Python: >=3.13
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: chardet<6
+Requires-Dist: charset-normalizer>=3.4.0
+Requires-Dist: comtypes>=1.4.0; platform_system == 'Windows'
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: fastmcp>=3.2.2
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: mcp>=1.28.1
+Requires-Dist: pyasn1>=0.6.4
+Requires-Dist: pydantic-ai-slim[anthropic,mcp,openai]<2,>=1.107.4
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pywin32-ctypes>=0.2.0; platform_system == 'Windows'
+Requires-Dist: pywin32>=306; platform_system == 'Windows'
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: sqlmodel>=0.0.22
+Requires-Dist: typer>=0.12.0
+Requires-Dist: typing-extensions>=4.8.0
+Requires-Dist: urllib3>=2.7.0
+Requires-Dist: uvicorn>=0.24.0
+Provides-Extra: dev
+Requires-Dist: black>=23.9.0; extra == 'dev'
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: coverage[toml]>=7.3.0; extra == 'dev'
+Requires-Dist: doc8>=1.1.0; extra == 'dev'
+Requires-Dist: factory-boy>=3.3.0; extra == 'dev'
+Requires-Dist: hatch-fancy-pypi-readme>=24; extra == 'dev'
+Requires-Dist: mypy>=1.6.0; extra == 'dev'
+Requires-Dist: numpy>=1.26.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.4.0; extra == 'dev'
+Requires-Dist: pydocstyle>=6.3.0; extra == 'dev'
+Requires-Dist: pypdfium2>=4.30.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-benchmark>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.11.0; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.1.0; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.3.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: sphinx-autodoc-typehints>=1.24.0; extra == 'dev'
+Requires-Dist: sphinx>=7.0.0; extra == 'dev'
+Requires-Dist: tox>=4.11.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mike>=2.0.0; extra == 'docs'
+Requires-Dist: mkdocs-autorefs>=0.5.0; extra == 'docs'
+Requires-Dist: mkdocs-awesome-pages-plugin>=2.9.0; extra == 'docs'
+Requires-Dist: mkdocs-gen-files>=0.5.0; extra == 'docs'
+Requires-Dist: mkdocs-include-markdown-plugin>=6.0.0; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav>=0.6.0; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.4.0; extra == 'docs'
+Requires-Dist: mkdocs-mermaid2-plugin>=1.1.0; extra == 'docs'
+Requires-Dist: mkdocs-minify-plugin>=0.7.0; extra == 'docs'
+Requires-Dist: mkdocs-section-index>=0.3.0; extra == 'docs'
+Requires-Dist: mkdocs<2,>=1.5.0; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == 'docs'
+Requires-Dist: pygments>=2.16.0; extra == 'docs'
+Provides-Extra: rag
+Requires-Dist: faiss-cpu>=1.7.0; extra == 'rag'
+Requires-Dist: numpy>=1.26.0; extra == 'rag'
+Requires-Dist: sentence-transformers>=2.7.0; extra == 'rag'
+Provides-Extra: test
+Requires-Dist: coverage[toml]>=7.3.0; extra == 'test'
+Requires-Dist: fastapi>=0.115.0; extra == 'test'
+Requires-Dist: hatch-fancy-pypi-readme>=24; extra == 'test'
+Requires-Dist: numpy>=1.26.0; extra == 'test'
+Requires-Dist: pypdfium2>=4.30.0; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
+Requires-Dist: pytest-mock>=3.11.0; extra == 'test'
+Requires-Dist: pytest-timeout>=2.1.0; extra == 'test'
+Requires-Dist: pytest-xdist>=3.3.0; extra == 'test'
+Requires-Dist: pytest>=7.4.0; extra == 'test'
+Provides-Extra: ui
+Requires-Dist: fastapi>=0.115.0; extra == 'ui'
+Provides-Extra: vision
+Requires-Dist: numpy>=1.26.0; extra == 'vision'
+Requires-Dist: pillow>=10.0.0; extra == 'vision'
+Requires-Dist: scikit-image>=0.23.0; extra == 'vision'
+Description-Content-Type: text/markdown
+
+# SolidWorks CAD Assistant & MCP Server
+
+<!-- mcp-name: io.github.andrewbartels1/solidworks-mcp-python -->
+
+**Languages:** [English](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/README.md) | [Español](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/README.es-ES.md)
+
+[![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Windows](https://img.shields.io/badge/Windows-10%2F11-blue?logo=windows)](https://www.microsoft.com/windows)
+[![SolidWorks](https://img.shields.io/badge/tested%20on-SolidWorks%202026-red)](https://www.solidworks.com/)
+[![Coverage](https://codecov.io/gh/andrewbartels1/SolidworksMCP-python/branch/main/graph/badge.svg)](https://codecov.io/gh/andrewbartels1/SolidworksMCP-python)
+
+Python MCP server for SolidWorks automation with 154 tools, plus an optional agent/prompt-testing layer for AI-assisted workflows.
+
+## See it work
+
+> Make a 100 x 50 x 10 mm AISI 1020 mounting plate with four M5 clearance holes, 10 mm in from each edge, and draw it fully dimensioned. Stack two of them 10 mm apart, check the result, and draw the assembly with a BOM.
+
+![A fully dimensioned plate, its drawing with GD&T, two plates mated 10 mm apart and the assembly drawing with a BOM, built in SolidWorks through the MCP tools](https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/readme/test_plate_stack_from_prompt_to_drawing-motion.gif)
+
+The 58 tool calls an agent made from that prompt, run against SolidWorks 2026 through the same MCP tools a client calls, and recorded (sped up five times). Each result is checked against a hand calculation: the plate's volume and mass, the 10 mm gap and the BOM quantity. This is a replay of the calls, not a recorded model session.
+
+> **Note:** the demo is not perfect, and is not the most efficient way to get this result. The run pauses after each call so it can be read, and the calls are chosen to show what the tools can do: every sketch dimension is added one at a time, and the mate distance is stepped down only so the plates are seen coming together.
+
+The [walkthrough in the docs](https://andrewbartels1.github.io/SolidworksMCP-python/demos/#prompt-to-drawing) has the agent's plan and every call with its arguments. Run it yourself with the [README demo](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/tests/live/test_live_sw_readme_demo.py); the calls are also in [`plate_stack_calls.json`](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/assets/demos/readme/plate_stack_calls.json).
+
+<details>
+<summary>The 58 tool calls</summary>
+
+1. **Sketch** (24 calls): `create_sketch` on Top; four `add_line` for the 100 x 50 outline; `add_circle` for each Ø5.5 hole; `add_sketch_dimension` for the 100, the 50, one Ø5.5 and each hole 10 mm from two edges; `add_sketch_constraint` making the other three holes equal; `exit_sketch`
+2. **Check and extrude**: `check_sketch_fully_defined`, `create_extrusion` 10 mm (+49 049.7 mm³ read back)
+3. **Material and check**: `list_model_dimensions` (finds the Ø5.5 by value), `set_material` AISI 1020, `verify_model` (volume, mass 0.3875 kg, size, 1 feature, 1 body)
+4. **Plate drawing**: `generate_drawing_package` PS-01 (A3, four views, every model dimension laid out with no overlaps, notes, title block, PDF), `auto_center_marks`
+5. **GD&T**: `add_datum_tag` A, B and C, then `add_gtol` ⊕ Ø0.2 Ⓜ A|B|C on the Ø5.5
+6. **Assembly**: `insert_component` twice, `list_components`, `add_mate` Front and Right coincident and Top planes 60 mm apart, `set_dimension` stepping that distance down to 20 mm (10 calls), `verify_model` (2 parts, 3 mates, no interference; the stack measures 30 mm, so the gap is 10 mm)
+7. **Assembly drawing**: `set_custom_property` Material, `generate_drawing_package` PS-02 with `include_bom` (the BOM above the isometric: Demo Plate, QTY 2), then the same datums and position frame
+
+</details>
+
+## Overview
+
+> **Tried it?** Tell us what worked and what didn't in a [feedback issue](https://github.com/andrewbartels1/SolidworksMCP-python/issues/new?template=feedback.yml). Reports from real setups decide what gets fixed next.
+
+This project focuses on practical SolidWorks automation with an AI-friendly loop:
+
+1. describe intent
+2. generate a plan
+3. execute MCP tools
+4. inspect results
+5. iterate
+
+It includes:
+
+- core MCP runtime for SolidWorks tool execution
+- COM/VBA routing and adapter safety wrappers
+- tool coverage across modeling, sketching, drawing, analysis, export, automation, templates, and macros
+- optional agent orchestration/testing utilities under `src/solidworks_mcp/agents/`
+
+## Demos
+
+Each GIF is a live test driving SolidWorks 2026 through the MCP tools, with the call and its result captioned beneath. Click one to see what it checks, a prompt that asks for it, and its tool calls.
+
+<table>
+<tr>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#verify-block"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/verify-model/test_verify_model_passes_a_block_and_names_what_is_wrong.gif" alt="verify_model passes a block and names what is wrong" width="100%"></a><br><sub><code>verify_model</code> passes a block and names what is wrong</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#verify-assembly"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/verify-model/test_assembly_counts_components_mates_and_interference.gif" alt="An assembly: parts, mates and interference" width="100%"></a><br><sub>An assembly: parts, mates and interference</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#verify-cut"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/verify-model/test_cut_reports_the_volume_it_removed.gif" alt="A cut reports the volume it removed" width="100%"></a><br><sub>A cut reports the volume it removed</sub></td>
+</tr>
+<tr>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#verify-revolve"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/verify-model/test_revolve_reports_the_volume_it_added.gif" alt="A revolve reports the volume it added" width="100%"></a><br><sub>A revolve reports the volume it added</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#verify-round"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/verify-model/test_round_part_size_is_exact.gif" alt="A round part's size is exact" width="100%"></a><br><sub>A round part's size is exact</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#verify-selection"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/verify-model/test_reading_the_model_keeps_the_selection.gif" alt="Reading the model keeps the selection" width="100%"></a><br><sub>Reading the model keeps the selection</sub></td>
+</tr>
+<tr>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#package-block"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/drawing-package/test_generate_drawing_package_on_a_block.gif" alt="A full drawing package from one call" width="100%"></a><br><sub>A full drawing package from one call</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#sheet-scale"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/drawing-package/test_set_sheet_scale_halves_the_views.gif" alt="Setting the sheet scale" width="100%"></a><br><sub>Setting the sheet scale</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#bom"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/drawing-package/test_insert_bom_table_lists_both_parts.gif" alt="A BOM on an assembly drawing" width="100%"></a><br><sub>A BOM on an assembly drawing</sub></td>
+</tr>
+<tr>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#insert-model-dimensions"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/drawing-dimensions/test_insert_model_dimensions_shows_each_dimension_once.gif" alt="Each model dimension shown once" width="100%"></a><br><sub>Each model dimension shown once</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#arrange-dimensions"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/drawing-dimensions/test_arrange_dimensions_clears_every_overlap.gif" alt="Clearing every overlap" width="100%"></a><br><sub>Clearing every overlap</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#material"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/engineering-data/test_material_applies_and_changes_mass.gif" alt="Material and mass" width="100%"></a><br><sub>Material and mass</sub></td>
+</tr>
+<tr>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#dimensions-and-measure"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/engineering-data/test_dimensions_list_and_measure.gif" alt="Listing dimensions and measuring a face" width="100%"></a><br><sub>Listing dimensions and measuring a face</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#flat-pattern"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/engineering-data/test_export_flat_pattern_writes_a_dxf.gif" alt="Flat pattern of a sheet-metal part" width="100%"></a><br><sub>Flat pattern of a sheet-metal part</sub></td>
+<td width="33%" valign="top"><a href="https://andrewbartels1.github.io/SolidworksMCP-python/demos/#custom-property"><img src="https://raw.githubusercontent.com/andrewbartels1/SolidworksMCP-python/main/docs/assets/demos/engineering-data/test_custom_property_round_trip.gif" alt="Custom properties" width="100%"></a><br><sub>Custom properties</sub></td>
+</tr>
+</table>
+
+**[See every demo in the docs](https://andrewbartels1.github.io/SolidworksMCP-python/demos/)**: what each one shows, its prompt, every tool call with its arguments (all 58 for the demo at the top), and how to run them yourself.
+
+## Supported Today
+
+- Windows + SolidWorks COM automation for the main CAD lifecycle.
+- Tested on SolidWorks 2026. Earlier versions may work but are untested; if you try one, please [open an issue](https://github.com/andrewbartels1/SolidworksMCP-python/issues/new/choose) with what worked.
+- Modeling, sketching, drawing, analysis, export, automation, templates, and macro tools.
+
+## Not Yet / Simulated
+
+- Mock adapter output is simulated and should not be treated as engineering truth.
+- Live 3D viewport streaming in a UI.
+- Checkpoint-level interference validation.
+- Simple simulation and fluid workflows
+- Simple Topology Optimization via SimulationXpress etc.
+
+## Install
+
+You need Windows 10 or 11 and SolidWorks (opened at least once). In PowerShell, install [uv](https://docs.astral.sh/uv/), then open a new PowerShell window and run setup:
+
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+uvx solidworks-mcp-python setup
+```
+
+uv fetches Python 3.13 and the server from PyPI by itself; nothing to clone. The guided setup then:
+
+1. finds your SolidWorks version and the MCP clients on your PC: Claude Desktop, Claude Code, VS Code, Cursor and LM Studio;
+2. lets you pick which clients to connect;
+3. starts the server once to check that it lists its tools (in mock mode, so SolidWorks isn't touched);
+4. adds a `solidworks` entry to each client you picked, then tells you what to restart.
+
+Nothing needs a login or an API key, and the server runs only on your PC. Setup changes only the `solidworks` entry in each client's config. It backs the file up first and never shows or changes your other servers. Other entries that start this server the old way (`run-mcp.ps1` and the like) are offered for removal, so tools don't load twice.
+
+**To check it worked:** open SolidWorks, restart your client, and ask *"What model is open in SolidWorks?"*
+
+The package is `solidworks-mcp-python`. `uvx solidworks-mcp` installs a different project. To work on the server itself, [install from a clone](https://andrewbartels1.github.io/SolidworksMCP-python/getting-started/installation/#install-from-source). More fixes are in [Troubleshooting](https://andrewbartels1.github.io/SolidworksMCP-python/getting-started/installation/#troubleshooting).
+
+## Connect your client
+
+Run setup again whenever you want to add a client:
+
+```powershell
+uvx solidworks-mcp-python setup
+```
+
+| Option | What it does |
+| --- | --- |
+| `--client claude-desktop` | Configure one client without the list. Repeat it for several (`claude-code`, `vscode`, `cursor`, `lmstudio`). |
+| `--dry-run` | Show what would change, and change nothing. |
+| `--yes` | Don't ask: configure every client found. |
+| `--remove` | Take the `solidworks` entry out again. |
+| `--replace-old` | Remove older entries for this server without asking. |
+| `--mock` | Configure mock mode, which answers without SolidWorks (for trying the tools). |
+
+To set up a client by hand instead, each one runs `uvx solidworks-mcp-python`. If a client can't find `uvx`, use its full path, from `(Get-Command uvx).Source`.
+
+<details>
+<summary><b>Claude Desktop</b></summary>
+
+Add this to `claude_desktop_config.json`, alongside anything already in it. Depending on how Claude Desktop was installed, the file is in one of:
+
+- `%LOCALAPPDATA%\Claude-Data\claude_<id>\` (current releases)
+- `%LOCALAPPDATA%\Packages\Claude_<id>\LocalCache\Roaming\Claude\`
+- `%APPDATA%\Claude\`
+
+```json
+{
+  "mcpServers": {
+    "solidworks": {
+      "command": "uvx",
+      "args": ["solidworks-mcp-python"]
+    }
+  }
+}
+```
+
+Quit Claude Desktop from the system tray (closing the window isn't enough) and reopen it. **Settings > Developer** should show `solidworks` as running.
+
+</details>
+
+<details>
+<summary><b>Claude Code</b></summary>
+
+```powershell
+claude mcp add --scope user solidworks -- uvx solidworks-mcp-python
+```
+
+Run `/mcp` in a new session to check that `solidworks` is connected.
+
+</details>
+
+<details>
+<summary><b>VS Code</b></summary>
+
+Add this to `%APPDATA%\Code\User\mcp.json`:
+
+```json
+{
+  "servers": {
+    "solidworks": {
+      "type": "stdio",
+      "command": "uvx",
+      "args": ["solidworks-mcp-python"]
+    }
+  }
+}
+```
+
+Run **MCP: List Servers** from the Command Palette and start `solidworks`. Its output should end with `Discovered 154 tools` (the count grows as tools are added).
+
+</details>
+
+<details>
+<summary><b>LM Studio</b></summary>
+
+Add this to `%USERPROFILE%\.lmstudio\mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "solidworks": {
+      "command": "uvx",
+      "args": ["solidworks-mcp-python"]
+    }
+  }
+}
+```
+
+Restart LM Studio and enable `solidworks` in the Program tab.
+
+</details>
+
+For mock mode, which needs no SolidWorks, use `"args": ["solidworks-mcp-python", "--mock"]`. Linux and WSL work for the docs, the tests and mock mode, but not for driving SolidWorks.
+
+<details>
+<summary><b>Optional features (environment variables)</b></summary>
+
+Set these in your client's `env` block for the server, or in the shell before starting it by hand. Every `SOLIDWORKS_MCP_<FIELD>` maps to the config field of the same name.
+
+**SolidWorks-as-Code session logging (off by default).** Logs every adapter tool call to a local SQLite database, so a session can be replayed or exported as a runnable Python script (see [docs/getting-started/solidworks-as-code.md](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started/solidworks-as-code.md)).
+
+| Variable | Default | Meaning |
+| --- | --- | --- |
+| `SOLIDWORKS_MCP_SOC_LOGGING_ENABLED` | `false` | Turn logging on. |
+| `SOLIDWORKS_MCP_SOC_SESSION_ID` | *(generated)* | Session name to log under. If unset while logging is on, a `soc-YYYYMMDD-HHMMSS` id is generated at startup. |
+| `SOLIDWORKS_MCP_SOC_DB_PATH` | `.solidworks_mcp/agent_memory.sqlite3` | Override the database file. |
+
+```powershell
+$env:SOLIDWORKS_MCP_SOC_LOGGING_ENABLED = "true"
+$env:SOLIDWORKS_MCP_SOC_SESSION_ID = "my-bracket"
+.\.venv\Scripts\solidworks-mcp.exe
+# ...work in your MCP client...
+.\.venv\Scripts\python.exe -m solidworks_mcp.agents.soc_exporter my-bracket my_bracket.py
+```
+
+It works only with the circuit-breaker adapter wrapper (the default for real SolidWorks); the mock adapter does not log.
+
+**API docs index auto-refresh (on by default).** The API-lookup tools (`lookup_api_interface`, `lookup_api_method`, `find_related_api_members`) and `search_solidworks_api_help` read a JSON index built by `discover_solidworks_docs`. When the index is older than the threshold, the next lookup rebuilds it.
+
+| Variable | Default | Meaning |
+| --- | --- | --- |
+| `SOLIDWORKS_MCP_DOCS_INDEX_AUTO_REFRESH` | `true` | Rebuild a stale index automatically. No-op without SolidWorks + win32com; a failed rebuild keeps serving the existing index. |
+| `SOLIDWORKS_MCP_DOCS_INDEX_MAX_AGE_DAYS` | `21` | Age after which the index counts as stale. |
+
+</details>
+
+## Contributing
+
+`install.ps1` gives you an editable install, so code changes take effect the next time a client starts the server. For the development tools, install the extras:
+
+```powershell
+.\.venv\Scripts\python.exe -m pip install -e ".[dev,test,docs]"
+```
+
+`.\dev-commands.ps1` lists the common workflows:
+
+- `dev-install`: install or update the local dev environment
+- `dev-test`: run the standard test suite (the CI-safe subset)
+- `dev-test-full`: run the full suite, including smoke and integration paths
+- `dev-lint` and `dev-format`: lint checks and formatting
+- `dev-docs-build`, `dev-docs-strict` and `dev-docs-audit`: build the docs, build them failing on warnings, or write an audit report to `.generated/docs`
+
+To mirror GitHub Actions CI locally (Ubuntu, the conda env from `solidworks_mcp.yml`, and `make test`), run `.\scripts\run-ci-local.ps1`. The first run builds the image; add `-NoBuild` to re-run tests without rebuilding.
+
+## Docs
+
+- Main docs site: <https://andrewbartels1.github.io/SolidworksMCP-python/>
+- Home/overview: [docs/index.md](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/index.md)
+
+Key docs sections:
+
+- Getting Started: [docs/getting-started](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started)
+- MCP Server Guide: [docs/user-guide](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/user-guide)
+- Tool Catalog: [docs/user-guide/tool-catalog](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/user-guide/tool-catalog)
+- Agents and Skills: [docs/agents](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/agents)
+- Planning/Roadmap: [docs/planning](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/planning)
+
+Direct links:
+
+- [Installation](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started/installation.md)
+- [Quick Start](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started/quickstart.md)
+- [Tutorial: U-Joint Assembly Build](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started/tutorials/u-joint-assembly-build.md)
+- [Tutorial Tracks](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started/tutorial-tracks.md)
+- [VS Code MCP Setup](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/getting-started/vscode-mcp-setup.md)
+- [Architecture](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/user-guide/architecture.md)
+- [Agents and Prompt Testing](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/agents/agents-and-testing.md)
+- [PydanticAI and Schemas](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/docs/agents/pydantic-ai-and-schemas.md)
+
+## License
+
+MIT License. See [LICENSE](https://github.com/andrewbartels1/SolidworksMCP-python/blob/main/LICENSE).