Skip to main content
plugin CX Codex

solidworks-gpt-plugin — Claude Code plugin: what it does

The solidworks-gpt-plugin plugin for Claude Code uses five skills to take SolidWorks work from requirements through modeling to a measured, validated model and session report.

MIT ★ 1,596 updated 2026-10-29

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add hashgraph-online/awesome-codex-plugins
/plugin install solidworks-gpt-plugin@awesome-codex-plugins
Open on GitHub

What solidworks-gpt-plugin does

The work is split across five skills. solidworks-design runs a request through requirements, planning, modeling and delivery; sw-pre-start loads conventions and the rules currently active in the project; sw-kb-api queries catalog parts, published build instructions, macros and known errors. Two more handle feedback: sw-learner assembles a corrected report from the live SolidWorks session, and sw-session-reporter asks for consent before anything leaves the machine.

Units, dimensions, material, tolerances and expected outputs are confirmed before geometry changes. A document passes only when rebuild state, feature tree, mass, bounding box and validate_document all line up. The knowledge base defaults to https://sw-plugin.ideep.org; point SW_KB_HOST somewhere else to override it. An outage gets logged and CAD work carries on.

Actual modeling requires Windows with SolidWorks installed plus an automation surface Codex can already reach, such as an MCP/COM bridge. No MCP server ships here, so without that bridge you end up with a plan and rule checks but no geometry. curl covers knowledge-base calls, and Python 3.9+ runs the optional session utilities along with scripts/doctor.py, which inspects the local setup and makes no network requests.

What it helps with

  • confirm units, material and tolerances before touching geometry
  • turn a shaft specification into a saved part with a STEP export
  • check a model against rebuild state, mass and bounding box
  • reuse published build instructions and macros instead of rewriting them
  • submit session lessons only after the user agrees

Example prompts for the agent

  • Model a stepped shaft in SolidWorks in millimetres, material AISI 1045, 160 long, bearing seats 25 h6 by 30 at each end. Give me the saved part, a STEP export, mass and bounding box.
  • Run validate_document on the open part and report the rebuild state and feature tree.
  • Put the session lessons together and ask me whether to send them.

How to install solidworks-gpt-plugin

Plugin marketplace

/plugin marketplace add hashgraph-online/awesome-codex-plugins
/plugin install solidworks-gpt-plugin@awesome-codex-plugins

Step by step, with commands for each platform: Claude Code plugins: marketplaces, installing, and building your own

Questions about solidworks-gpt-plugin

How do I install solidworks-gpt-plugin in Claude Code?

Add the marketplace with /plugin marketplace add hashgraph-online/awesome-codex-plugins, then run /plugin install solidworks-gpt-plugin@awesome-codex-plugins. Start a new task afterwards so the skills load.

What does solidworks-gpt-plugin do?

It runs SolidWorks design work as one sequence: requirements and pre-start checks, knowledge-base lookup, feature planning, modeling, then measured validation. At the end it builds a session report and submits it only with consent.

Do I need an MCP server for it to model anything?

Yes, one has to be available already. The plugin supplies the workflow and knowledge lookup, not the SolidWorks automation surface, so plan on a working MCP/COM bridge on Windows with SolidWorks installed.

Source text

solidworks-GPT-plugin · MIT
# solidworks-GPT-plugin

[![Validate plugin](https://github.com/Erfouni/solidworks-GPT-plugin/actions/workflows/validate.yml/badge.svg)](https://github.com/Erfouni/solidworks-GPT-plugin/actions/workflows/validate.yml)
[![Python 3.9+](https://img.shields.io/badge/Python-3.9%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
[![Needs a SolidWorks MCP/COM bridge](https://img.shields.io/badge/needs-SolidWorks%20MCP%2FCOM%20bridge-7C3AED)](#requirements)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

An installable Codex plugin that ports the knowledge workflow of
[`solidworks-claude-plugin`](https://github.com/mesutfd/solidworks-claude-plugin)
to OpenAI Codex.

It adds five coordinated skills:

- `solidworks-design` orchestrates requirements, planning, modeling, validation, and delivery.
- `sw-pre-start` loads conventions, active design rules, relevant references, and initial rule checks.
- `sw-kb-api` looks up catalog parts, published build instructions, macros, known errors, and lessons.
- `sw-learner` builds a complete, corrected feedback payload from the current SolidWorks session.
- `sw-session-reporter` asks for consent and submits feedback to the knowledge base.

<p align="center">
  <img src="assets/workflow-demo.svg" alt="SolidWorks GPT Plugin conceptual workflow from engineering requirements to validated delivery" width="100%">
</p>
<p align="center"><sub>Conceptual workflow preview—not a recorded CAD result. Every reported model still has to pass the measured validation gates shown above.</sub></p>

## What the workflow guarantees

This plugin is designed for engineering work where a plausible answer is not
enough. It makes requirements, knowledge lookup, modeling, and validation
explicit parts of one workflow:

```mermaid
flowchart LR
    A[Design request] --> B[Requirements and pre-start checks]
    B --> C[Standards and knowledge lookup]
    C --> D[Feature and datum plan]
    D --> E[SolidWorks modeling]
    E --> F{validate_document passes?}
    F -- No --> G[Inspect and repair]
    G --> E
    F -- Yes --> H[Save, export, and report evidence]
    H --> I[Build session lessons]
    I --> J{User consent?}
    J -- Yes --> K[Submit validated feedback]
    J -- No --> L[Keep the session local]
```

| Boundary | Behavior |
|---|---|
| Engineering inputs | Units, dimensions, material, tolerances, and outputs are confirmed before geometry changes. |
| Knowledge | Standards, proven build instructions, macros, errors, and lessons are retrieved before modeling. |
| CAD validation | Rebuild state, feature tree, mass, bounding box, and `validate_document` determine pass or fail. |
| Privacy | Feedback is local by default and is submitted only with explicit or previously saved consent. |

## 60-second tour

After installing the plugin, start a new Codex task with a concrete engineering
request. For example:

```text
Design a metric stepped shaft in SolidWorks.
Units: mm
Material: AISI 1045
Overall length: 160
Bearing seats: 25 h6 x 30 long at both ends
Center section: 35 mm diameter
Output: saved part, STEP export, mass, bounding box, validation report
```

The workflow will stop for any geometry-changing requirement that is still
ambiguous, retrieve applicable standards and known patterns, plan the model,
build each document, and report measured validation evidence. A knowledge-base
outage is recorded but does not block local CAD work.

The default knowledge base is `https://sw-plugin.ideep.org`. Override it with
the `SW_KB_HOST` environment variable. Read-only runtime endpoints are public;
session feedback is sent only after the user chooses **Yes, send now** or has
previously chosen **Always send**.

## Install from GitHub

```powershell
codex plugin marketplace add Erfouni/solidworks-GPT-plugin
codex plugin add solidworks-gpt-plugin@solidworks-gpt
```

Restart the ChatGPT desktop app or start a new Codex task after installation so
the new plugin skills are loaded.

For a local checkout, replace the GitHub shorthand in the first command with
the absolute path to this repository.

## Requirements

- Windows with SolidWorks installed for actual CAD work.
- A SolidWorks automation surface already available to Codex (for example a
  SolidWorks MCP/COM integration). This plugin supplies the design and knowledge
  workflow; it does not bundle an MCP server or install SolidWorks itself.
- `curl` for knowledge-base calls.
- Python 3.9+ for the optional deterministic session and feedback utilities.

Knowledge-base outages never block CAD work. The skills record the outage and
continue with the available SolidWorks tooling and engineering context.

## Diagnose local readiness

Run the bundled doctor before the first CAD task:

```powershell
python plugins/solidworks-gpt-plugin/scripts/doctor.py
```

It validates Python, the installed manifest/skills/schema, `SW_KB_HOST` syntax,
`curl`, and the local SolidWorks COM registration. It makes zero network
requests and never launches SolidWorks. Missing optional dependencies are
reported as warnings; require the complete CAD and feedback environment with:

```powershell
python plugins/solidworks-gpt-plugin/scripts/doctor.py --strict
```

For CI, support packets, or reproducible installation evidence, use `--json`.
Host output is credential-free, and endpoint reachability is deliberately not
claimed.

For release notes and project questions, see the
[latest release](https://github.com/Erfouni/solidworks-GPT-plugin/releases/latest),
the [changelog](CHANGELOG.md), and
[GitHub Discussions](https://github.com/Erfouni/solidworks-GPT-plugin/discussions).

## Privacy and local state

- `.sw-learner-state.json` stores the current session ID and submission metadata
  in the working directory.
- `~/.sw-feedback-pref` contains `always` only after the user explicitly chooses
  **Always send**.
- Feedback may include build instructions, generated macros, resolved errors,
  lessons, and model images. The payload is never submitted without consent
  unless the saved `always` preference is present.

## Validate the plugin

From this repository root:

```powershell
python plugins/solidworks-gpt-plugin/scripts/run_checks.py
```

The repository also includes the original porting specification and the KB
admin OpenAPI reference under `plugins/solidworks-gpt-plugin/docs/`.

## Contributing

Bug reports, documentation improvements, and focused pull requests are
welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md), use the structured issue
templates, and run the repository checks before opening a pull request.

## License

MIT. See [LICENSE](LICENSE) and [NOTICE](NOTICE) for upstream attribution.

© Erfouni · MIT · hashgraph-online/awesome-codex-plugins

Similar plugins

All plugins for Agent setup: memory, context, orchestration →

From the same set391

The whole set →

Project sponsors

Companies that keep this analytics open