Repository navigation
docs(readme): SolidWorks COM API coverage audit + license-tier compatibility tags #79
Description
Goal
Add two things to the README (and keep them current as tools are added):
- A SolidWorks COM API coverage table — what API domains exist vs. what MCP tools cover them
-
- License-tier tags on each tool so users know upfront what SolidWorks license they need
SolidWorks COM API coverage audit (current state)
Audited against the SolidWorks API object model (ISldWorks → IModelDoc2 hierarchy) and the current 109-tool surface as of this writing.
| API Domain | Key SW Interfaces | MCP Tools | Coverage |
|---|---|---|---|
| Core app / document | ISldWorks, IModelDoc2 | open_model, close_model, save_file, get_model_info | ✅ Good |
| Part modeling | IFeatureManager, IFeature | create_extrusion, create_cut_extrude, create_revolve, create_sweep, create_loft, mirror_feature, pattern_circular, suppress_feature, delete_feature | ✅ Good |
| Sketch | ISketchManager, ISketch | create_sketch, add_line/arc/circle/rectangle/polygon/ellipse/spline, add_fillet, sketch_offset/mirror/pattern, add_sketch_constraint/dimension, exit_sketch | ✅ Good |
| Sketch (topology-robust) | ISketchManager.SketchUseEdge3 | — | ❌ Missing (#77) |
| Thin extrude | IFeatureManager.FeatureExtrusion3 | — | ❌ Missing (#77) |
| Assembly | IAssemblyDoc, IComponent2, IMate2 | create_assembly, load_assembly, insert_component, add_mate, list_components, check_interference | ✅ Partial |
| Drawing | IDrawingDoc, ISheet, IView | create_drawing, add_drawing_view, create_section_view, create_detail_view, add_dimension/annotation/note, export_pdf/dwg | ✅ Good |
| File I/O | IModelDoc2.SaveAs, Import | export_step/iges/stl/pdf/dwg/image, convert_file_format, batch_export | ✅ Good |
| Properties / metadata | ICustomPropertyMgr | get_file_properties, manage_file_properties | ✅ Good |
| Configuration | IConfigurationMgr | list_configurations | |
| Design table | IDesignTable | manage_design_table | ✅ Partial |
| Equations / global vars | IEquationMgr | — | ❌ Missing (#23) |
| Selection | ISelectionMgr | — | ❌ No direct tool |
| Geometry query | IFace2, IEdge, IBody2 | analyze_geometry, calculate_mass_properties, get_mass_properties | |
| Sheet metal | ISheetMetalFeatureData | — | ❌ Missing (#57) |
| Surface modeling | ISurface, IBody2 (surface) | — | ❌ Missing |
| Weldments | IWeldmentFeatureData | — | ❌ Missing |
| BOM / cut lists | ITableAnnotation, IBomTable | — | ❌ Missing |
| Macro / VBA | ISldWorks.RunMacro2 | execute_macro, generate_vba_*, start/stop_macro_recording | ✅ Good |
| Simulation (paid add-in) | CWStudyManager, CWStudy, CWMesh, CWResults | — | ❌ Missing (#78) |
| SimulationXpress | No COM API (GUI-only) | — | N/A |
| Motion Study | IMotionStudyManager | — | ❌ Missing |
| PhotoView / Visualize | IRenderManager | export_image (partial) | |
| Routing | IRoutingManager | — | ❌ Missing |
| Mold tools | IMoldToolsFeatureData | — | ❌ Missing |
Summary: ~8 domains well-covered, ~4 partially covered, ~9 domains completely missing.
License-tier tags for README
Each tool (or tool group) should be tagged with the minimum SolidWorks license required:
| Tag | Meaning |
|---|---|
[Maker] |
Works with SolidWorks Maker personal-use plan (~$10/mo) |
[Standard] |
Requires SolidWorks Standard (commercial) |
[Professional] |
Requires SolidWorks Professional |
[Simulation] |
Requires paid Simulation add-in |
[PDM] |
Requires PDM add-in |
Most existing tools should be [Maker] or [Standard]. The Simulation COM API tools (#78) would be [Simulation].
Action: Verify against the most recent SolidWorks Maker plan feature list at https://www.solidworks.com/solution/market/makers and update this table. As of the last check, Maker includes Standard features + SimulationXpress + DriveWorksXpress + PhotoViewXpress.
README section proposal
Add a new section to README.md:
## SolidWorks API Coverage
> Tags: `[Maker]` `[Standard]` `[Professional]` `[Simulation]`
>
> Each tool is tagged with the minimum SolidWorks license tier required.
> Most tools work with the free SolidWorks Maker plan.
> Tools tagged `[Simulation]` require the paid SolidWorks Simulation add-in.
[Link to full coverage table →](docs/api-coverage.md)And create docs/api-coverage.md with the full table above, kept in sync as new tools land.
Related
- Proposal: phased expansion of MCP tool surface (assembly mates, reference geometry, parametrics, BOM, measurement) #23 — equations/global variables (currently ❌ missing)
-
- feat(tools): sheet metal feature support (flanges, sketched bend, flat pattern) #57 — sheet metal (currently ❌ missing)
-
-
- feat(tools): sketch_from_face_loop + thin_extrude #77 — sketch_from_face_loop + thin_extrude (currently ❌ missing)
-
-
-
-
- feat(tools): SolidWorks Simulation COM API wrapper — parent for cheapo-topo #76 Option B #78 — Simulation COM API (currently ❌ missing, requires paid add-in)
-
-
Activity
fix(docs): repair broken inline-code spans, fix dead docs/api-coverag…
docs(planning): add roadmap, OpenSpec proposal-auditor skill, and the…
fix(docs): repair broken inline-code spans, fix dead docs/api-coverag…
docs(planning): add roadmap, OpenSpec proposal-auditor skill, and the…
docs(planning): add roadmap, OpenSpec proposal-auditor skill, and the…
feat(analysis): verify_model, and measured change on extrude, revolve…