Skip to content

docs(readme): end-to-end demo GIF - prompt to SolidWorks part to reproduction script #147

Open

Description

@andrewbartels1

Goal

The README is a wall of text. Show what the MCP server can do with an end-to-end demo: a prompt goes in, the model calls tools, SolidWorks builds the part, and a Python script that reproduces it comes out.

The demo

One recorded session, shown as a GIF (or short video) at the top of the README:

  1. Prompt. Something like "Design a mounting bracket for a NEMA 17 motor, 3D-printable." Show which model ran it.
  2. Specs. The model asks for what's missing (wall thickness, hole clearance, printer) and the user answers.
  3. Tool calls. Each call, with its input and result, next to SolidWorks after that step: sketch, extrude, holes, fillets, material, mass check.
  4. Drawing. A drawing with model dimensions, laid out without overlaps (insert_model_dimensions, arrange_dimensions, feat(tools): drawing-dimension tools from #117 (insert_model_dimensions, arrange_dimensions) #146), exported to PDF.
  5. Script. The Python script that reproduces the part, from the session's tool calls.

Aim for a sequence that uses as many tool groups as makes sense (modeling, sketching, features, engineering data, drawings, export) without dragging.

Building on what exists

The live demo capture added in #139 and #146 already does most of this:

  • tests/live/evidence.py captures the SolidWorks window at each step and adds a caption with the tool call and its colour-coded result.
  • tests/scripts/make_demo_gif.py turns those frames into a GIF.

Still needed:

  • evidence() takes prompt and model fields and shows them on the first frame.
  • A way to record a real session (Claude Code or Claude Desktop): the prompt, the model, every tool call and its result. One option is to log them from the server's tool boundary.
  • Generate the reproduction script from that log, or from a VBA/Python generator tool.
  • Pick the demo part and its prompt, then run it live and check every step.
  • README: put the GIF near the top, followed by a short capability tour (a few smaller GIFs or stills per tool group), with the tool list after.

Related

Activity

  1. andrewbartels1 commented on Oct 29, 2026

    @andrewbartels1
    OwnerAuthor

    Scope update: build a small bracket assembly from one prompt instead of a single part, then

    1. read every component and the assembly back with the read tools (features, mass, mates, interference);
    2. check the result against the prompt's requirements with the verify tool (feat(tools): verify a part or assembly against expected values #173);
    3. list the gaps found in the PR, each linked to an issue. The shortfalls are part of the demo.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions