Skip to content

docs(examples): prompt-to-SolidWorks tutorials + free SimulationXpress walkthroughs #80

Open

Description

@andrewbartels1

Goal

Make it easy for new users to go from a natural-language prompt to a working SolidWorks model/simulation using this MCP server. Builds on #31 ("SoC tutorial, end-to-end demo, and best-practices guide") by adding concrete worked examples and — critically — a free FEA section using SimulationXpress (included with every SolidWorks Standard / Professional / Maker license, no add-in purchase required).


Why this matters

Right now a new user has to reverse-engineer how to chain tool calls from the source code. Examples lower that barrier dramatically and demonstrate the value of the MCP server to potential contributors.


Proposed docs/tutorials/ structure

docs/tutorials/
  01_first_part.md          # Hello-world: create a simple extruded part from a prompt
  02_assembly_with_mates.md # Load parts, add mates, check interference
  03_drawing_export.md      # Auto-generate a drawing + export PDF/DWG
  04_simulationxpress.md    # FREE FEA: stress + safety factor, no paid add-in
  05_parametric_variants.md # Global variables + configurations (#27   06_topo_opt_loop.md       # Cheapo topo-opt via parametric cuts (#76)

Tutorial 04 — SimulationXpress (FREE, [Maker] compatible)

SimulationXpress is bundled with SolidWorks Standard / Professional / Maker. It requires no extra license or add-in beyond the base installation.

What SimulationXpress can do (GUI-only, no COM API)

  • Apply fixed geometry constraints
    • Apply force / pressure loads
      • Run a linear static FEA analysis
        • Show Von Mises stress + safety factor plots
          • Step 6 "Optimize": sweep one dimension variable over a range and find the value that keeps safety factor ≥ target (parametric, NOT topology optimization)

Workflow for tutorial 04

Since SimulationXpress has no COM API, the MCP-assisted workflow is:

  1. Prompt → Part (fully automated via MCP):
  2. "Create a 100×20×5 mm aluminum bracket with a 6 mm through-hole centered 15 mm from one end."
  3. MCP calls: create_part → create_sketch → create_extrusion → add_circle → create_cut_extrude → save_file
  4. Set up material (automated):
  5. "Apply 6061-T6 aluminum alloy to the bracket."
  6. MCP call: get_material_properties / material assignment
  7. Hand off to SimulationXpress (user-driven, GUI):
    • Open: Evaluate → SimulationXpress Analysis Wizard
    • Step 1 Fixtures: fix the hole face
    • Step 2 Loads: 500 N downward on the end face
    • Step 3 Material: confirm 6061-T6
    • Step 4 Run: click Analyze
    • Step 5 Results: view Von Mises stress, note safety factor
    • Step 6 Optimize (optional): select the bracket thickness dimension, sweep 3–10 mm, target SF ≥ 3×
  8. Interpret results (prompt → summary):
  9. The user screenshots or notes the max stress + SF, and prompts the MCP to update a global variable if needed.

Free SimulationXpress learning resources


Tutorial 06 — Cheapo topo-opt loop (references #76)

See #76 for the full spec. The tutorial should walk through the 3-phase workflow end-to-end with a real part (e.g., a TV-stand leg bracket) and show the mass-before / mass-after output.


Acceptance criteria

  • docs/tutorials/01_first_part.md — hello-world part creation with prompt snippets
  • - [ ] docs/tutorials/04_simulationxpress.md — free FEA walkthrough, clearly marked [Maker] compatible
  • - [ ] Each tutorial lists the license tier required at the top ([Maker] / [Standard] / [Simulation])
  • - [ ] README links to docs/tutorials/ index
  • - [ ] At least one tutorial includes expected MCP tool-call sequence + sample output

Related

Activity

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