Skip to content

SWChecklist.md

Latest commit

 

History

History
650 lines (458 loc) · 20.5 KB

SWChecklist.md

File metadata and controls

650 lines (458 loc) · 20.5 KB

SolidWorks MCP Server Tools Checklist

📊 Tool Status Overview

  • Total Tools: 76 tools
  • Categories: 11
  • Status: All Fixed and Operational (as of 2025-01-11)

📌 Backlog

  • ✅ Add end-to-end load/save smoke coverage for parts and assemblies in real SolidWorks integration tests

    • Completed: test_real_load_save_lifecycle in tests/test_real_solidworks_integration.py

  • ✅ Add dedicated tools for explicit document lifecycle operations (load part, load assembly, save active, save as, save all)

    • Completed: 4 lifecycle tools added to file_management.py (load_part, load_assembly, save_part, save_assembly)

  • ✅ Add explicit convenience wrappers: load_part, load_assembly, save_part, save_assembly (on top of generic open/save tools)

    • Completed: See file_management.py tool definitions + SolidWorksDocsDiscovery detailed documentation

  • Add tool-level safeguards for save targets (path validation, overwrite policy, extension checks)

    • Status: Partially implemented in save_part/save_assembly (extension validation); path validation TBD

  • ✅ Add a "docs discovery" tool that indexes all available COM and VBA commands for the installed SolidWorks version

    • Completed: discover_solidworks_docs tool in src/solidworks_mcp/tools/docs_discovery.py
    • How to Use: Run dev-docs-discovery in dev-commands.ps1 (Windows-only)

  • Add a local docs-query tool that reads installed SolidWorks API help and VBA references directly for the active version

    • Status: Architecture documented; implementation TBD
    • Note: Depends on completing docs-discovery tool (✅ done)

  • Support local documentation querying mode for SolidWorks Help/API references when context is too large for prompt input

    • Status: Design ready (build on docs_discovery_index.json); RAG backend needed

  • Evaluate optional RAG backend for docs discovery (sqlite-vec, LangChain, or equivalent local vector index)

    • Status: Awaiting design phase; docs_discovery provides JSON input

  • ✅ Add deterministic regression tests for docs discovery against known COM/VBA symbols

    • Completed: 4 tests in tests/test_tools_docs_discovery.py

  • Add Support and tools for browsing and inserting ready made solidworks components (fasteners, screws, etc.) into Solidworks Assemblies and look into assembly tools that could be valuable adds to the mcp server.

  • Support for pydantic-ai and other workflows for research and automation using LLMs see doc here.

  • Have a database of all the commands and calls for context on close or a new session so things can pick up where they were left off on developing the part, learn what worked and what didn't, and rewind/redo/undo anything or turn great series of commands into a script. Planning found Datab workflow plans doc

  • add support for sheet metal and bend analysis tools

  • add support for mesh body manipulation tools

  • tool/support to grab MOTS/COTS from places like McMaster-Carr when assemblies are better supported

  • Demos and workflows for the different toolings (gifs, videos etc.)

  • Generate some sort of UI that will help the user view and rewind changes made by the mcp server and llm (see GUI Viz Planning)

  • Support for Makers and 3d print enthusiasts to parameterize and take into account additive manufacturing when the LLM is designing parts, including but limited to breaking pieces, library of best practices for 3d printing (e.g. joints that work best for 3d printing), and running physical tolerance tests that can be plugged into the LLM when designing assemblies, joints, and splitting parts that are too big to fit into print beds

  • Feature for "style" type inputs for natural generation or design preferences, like generating a stylized design part image and then have a workflow to break it into the parts that would be needed to actually design and print

  • Add a workflow for recommendations for ESP32, Raspberry Pis, and other electronics that might go into sensors and other parts. Like an expert of 3d printing and simple electrical projects and research for this.

  • Evaluate Pydantic/PydanticAI-backed caching strategy for response_cache and intelligent_router (append-only backlog item)

    • Research notes (2026-04-06):
      • pydantic does not provide a first-party response cache abstraction for application-level tool outputs; it mainly offers validation and internal parsing/schema caching.
      • pydantic_ai has caching for MCP metadata (cache_tools, cache_resources) and internal tool definition caching, but not a generic response cache for arbitrary tool results.
    • Backlog scope:
      • Introduce Pydantic models for cache entries/policies/keys to strengthen type safety and validation.
      • Keep runtime storage backend custom (in-memory/redis/sqlite) unless a dedicated external cache library is adopted.
      • Assess whether pydantic_ai MCP metadata cache settings can be leveraged or mirrored in router-level invalidation rules.

✅ Core Tools (6)

  • connect - Connect to SolidWorks application
  • disconnect - Disconnect from SolidWorks
  • is_connected - Check connection status
  • open_model - Open a SolidWorks file
  • close_model - Close current model (fixed: GetTitle() method)
  • rebuild_model - Rebuild the current model

⚠️ Modeling Tools (7)

  • create_part - Create a new part document
  • create_assembly - Create a new assembly document
  • [⚠️] create_extrusion - Create an extrusion feature (LIMITATION: COM interface fails with multi-parameter methods)
  • get_dimension - Get dimension value (fixed: multiple API methods)
  • set_dimension - Set dimension value (fixed: multiple API methods)
  • create_configuration - Create a new configuration
  • create_cutlist - Generate a cutlist

✅ Sketch Tools (7)

  • create_sketch - Create a new sketch (fixed: plane selection)
  • add_line - Add line to sketch
  • add_circle - Add circle to sketch
  • add_rectangle - Add rectangle to sketch
  • add_arc - Add arc to sketch
  • add_constraints - Add sketch constraints
  • dimension_sketch - Add dimensions to sketch

✅ Analysis Tools (6)

  • get_mass_properties - Get mass properties (fixed: GetType() method)
  • check_interference - Check assembly interference
  • measure_distance - Measure between entities
  • analyze_draft - Analyze draft angles
  • check_geometry - Check geometry errors (fixed: multiple fallback methods)
  • get_bounding_box - Get bounding box (fixed: multiple API methods)

✅ Export Tools (4)

  • export_file - Export to various formats (fixed: file existence verification)
  • batch_export - Export multiple configurations
  • export_with_options - Export with specific options
  • capture_screenshot - Capture model screenshot (fixed: SaveBMP method)

✅ Drawing Tools (10)

  • create_drawing_from_model - Create drawing from 3D model (fixed: template handling)
  • add_drawing_view - Add view to drawing
  • add_section_view - Add section view
  • add_dimensions - Add dimensions to view
  • update_sheet_format - Update sheet format
  • get_drawing_sheet_info - Get sheet information
  • get_drawing_views - Get all views info
  • set_drawing_sheet_size - Set sheet size
  • get_drawing_dimensions - Get all dimensions
  • set_drawing_scale - Set drawing scale

✅ VBA Generation Tools (15)

  • generate_vba_script - Generate VBA from template (fixed: template file created)
  • create_feature_vba - Generate feature creation VBA
  • create_batch_vba - Generate batch processing VBA
  • run_vba_macro - Execute VBA macro
  • create_drawing_vba - Generate drawing creation VBA
  • vba_create_reference_geometry - Generate reference geometry VBA
  • vba_advanced_features - Generate advanced features VBA
  • vba_pattern_features - Generate pattern features VBA
  • vba_sheet_metal - Generate sheet metal VBA
  • vba_configurations - Generate configuration VBA
  • vba_equations - Generate equations VBA
  • vba_simulation_setup - Generate simulation VBA
  • vba_api_automation - Generate API automation VBA
  • vba_error_handling - Generate error handling VBA
  • vba_create_drawing_views - Generate drawing views VBA

✅ Template Management Tools (6)

  • extract_drawing_template - Extract template settings
  • apply_drawing_template - Apply template to drawing
  • batch_apply_template - Apply to multiple files
  • compare_drawing_templates - Compare templates
  • save_template_to_library - Save to library
  • list_template_library - List all templates

✅ Enhanced Drawing Tools (6)

  • add_diameter_dimension - Add diameter dimension
  • set_view_grayscale_enhanced - Set view to grayscale
  • create_configurations_batch - Create multiple configs
  • get_template_custom_properties - Get custom properties
  • set_template_custom_properties - Set custom properties
  • setup_template_positions - Setup standard positions

✅ Native Macro Tools (5)

  • start_native_macro_recording - Start recording (fixed: ES module imports)
  • stop_native_macro_recording - Stop recording
  • save_native_macro - Save recorded macro
  • load_native_macro - Load saved macro
  • execute_native_macro - Execute macro

✅ Diagnostic & Security Tools (3)

  • diagnose_macro_execution - Diagnose macro issues
  • macro_set_security - Set security level
  • macro_get_security_info - Get security info

🔧 Recent Fixes Applied (2025-01-11)

Critical API Fixes

  1. create_sketch - Fixed non-existent GetPlane() method, now uses SelectByID2()
  2. get_mass_properties - Added parentheses to GetType() method call
  3. get_bounding_box - Added multiple fallback methods (GetPartBox, Extension.GetBox)
  4. check_geometry - Implemented RunCheck3, ToolsCheck, CheckGeometry with fallbacks
  5. get/set_dimension - Enhanced with Parameter, GetParameter, SelectByID2 methods
  6. create_drawing_from_model - Fixed template detection and creation methods
  7. export_file - Fixed STEP/IGES export with proper SaveAs3 flags
  8. capture_screenshot - Enhanced with file existence verification
  9. create_extrusion - ⚠️ KNOWN LIMITATION: Cannot execute through COM interface
  10. generate_vba_script - Created missing create_part.vba template
  11. native_macro_recording - Fixed require statements with ES module imports

Model Context Tracking

  • Enhanced ensureCurrentModel() with multiple fallback methods
  • Added ActivateDoc2() after opening models
  • Fixed all GetTitle() method calls with proper parentheses

Repository Cleanup (2025-01-11)

  • ✅ Removed Fixes-V2/ directory (unused refactoring attempt)
  • ✅ Removed winax/ source directory (using npm package)
  • ✅ Removed winax.zip (unnecessary archive)
  • ✅ Removed test-fixes.mjs (standalone test file)

Dependencies

  • Essential: winax: ^3.4.2 npm package for Windows COM/ActiveX binding
  • Status: All dependencies properly managed via npm

📝 Notes

  • All tools have been tested and fixed for common API binding issues
  • Error handling improved with file existence checks
  • Multiple fallback methods implemented for critical operations
  • Ready for production use on Windows with SolidWorks installed

🔴 Known Limitations (2025-01-12)

create_extrusion - COM Interface Limitation

Issue: The extrusion feature cannot be created through the MCP server due to COM interface limitations with the winax library.

Root Cause:

  • SolidWorks' FeatureExtrusion, FeatureExtrusion2, and FeatureExtrusion3 methods require 13-23 parameters
  • The winax Node.js COM bridge fails when calling methods with many parameters
  • This is a fundamental limitation of COM automation through Node.js

Attempted Solutions:

  1. ✅ Sketch creation and rectangle drawing work correctly
  2. ❌ Direct FeatureExtrusion calls with all parameter variations
  3. ❌ Using array parameters with apply() method
  4. ❌ Attempting to use winax.Variant for parameter wrapping
  5. ❌ Different parameter passing conventions

Workarounds:

  1. VBA Macro (Recommended): Created CreateExtrusion.swp macro that works when run directly in SolidWorks
    • Location: C:\Users\bartels\Claude\SWMCP-4\CreateExtrusion.swp
    • Run via: Tools → Macro → Run
  2. Manual Completion: Use SolidWorks UI to complete the extrusion after sketch creation
  3. Future Fix: Consider using SolidWorks API SDK directly or PowerShell integration

Impact: Any feature creation that requires many parameters will likely face similar issues.

Last Updated: 2025-01-12

  • Error:
  • Notes:

Drawing Operations

8. solidworks:create_drawing_from_model

  • Status: ⚪ Not Tested
  • Parameters: template, sheet_size
  • Error:
  • Notes:

9. solidworks:add_drawing_view

  • Status: ⚪ Not Tested
  • Parameters: viewType, modelPath, x, y, scale
  • Error:
  • Notes:

10. solidworks:add_section_view

  • Status: ⚪ Not Tested
  • Parameters: parentView, x, y, sectionLine
  • Error:
  • Notes:

11. solidworks:add_dimensions

  • Status: ⚪ Not Tested
  • Parameters: viewName, autoArrange
  • Error:
  • Notes:

12. solidworks:update_sheet_format

  • Status: ⚪ Not Tested
  • Parameters: properties
  • Error:
  • Notes:

Export Operations

13. solidworks:export_file

  • Status: 🔴 Not Working
  • Parameters: outputPath, format
  • Error: Failed to export to step
  • Notes: Export functionality not working

14. solidworks:batch_export

  • Status: ⚪ Not Tested
  • Parameters: format, outputDir, configurations, prefix
  • Error:
  • Notes:

15. solidworks:export_with_options

  • Status: ⚪ Not Tested
  • Parameters: outputPath, format, options
  • Error:
  • Notes:

16. solidworks:capture_screenshot

  • Status: 🔴 Not Working
  • Parameters: outputPath, width, height
  • Error: Failed to save screenshot
  • Notes: Screenshot save failing

VBA Generation Functions

17. solidworks:generate_vba_script

  • Status: ⚪ Not Tested
  • Parameters: template, parameters, outputPath
  • Error:
  • Notes:

18. solidworks:create_feature_vba

  • Status: 🟢 Working
  • Parameters: featureType, parameters
  • Error: None
  • Notes: Successfully generates VBA code for extrusion

19. solidworks:create_batch_vba

  • Status: ⚪ Not Tested
  • Parameters: operation, filePattern
  • Error:
  • Notes:

20. solidworks:run_vba_macro

  • Status: 🔴 Not Working
  • Parameters: macroPath, procedureName, moduleName, arguments
  • Error: No result received from client-side tool execution
  • Notes: COM automation issue with RunMacro2

21. solidworks:create_drawing_vba

  • Status: ⚪ Not Tested
  • Parameters: modelPath, template, views, sheet_size
  • Error:
  • Notes:

VBA Advanced Features

22. solidworks:vba_create_reference_geometry

  • Status: ⚪ Not Tested
  • Parameters: geometryType, referenceType, references
  • Error:
  • Notes:

23. solidworks:vba_advanced_features

  • Status: 🔴 Not Working
  • Parameters: featureType, profiles
  • Error: No result received from client-side tool execution
  • Notes: Tool execution failure

24. solidworks:vba_pattern_features

  • Status: ⚪ Not Tested
  • Parameters: patternType, featureNames, direction1
  • Error:
  • Notes:

25. solidworks:vba_sheet_metal

  • Status: ⚪ Not Tested
  • Parameters: operation, thickness
  • Error:
  • Notes:

26. solidworks:vba_surface_modeling

  • Status: ⚪ Not Tested
  • Parameters: surfaceType, sketches
  • Error:
  • Notes:

27. solidworks:vba_assembly_mates

  • Status: ⚪ Not Tested
  • Parameters: mateType, component1, face1, component2, face2
  • Error:
  • Notes:

28. solidworks:vba_assembly_components

  • Status: ⚪ Not Tested
  • Parameters: operation
  • Error:
  • Notes:

29. solidworks:vba_assembly_analysis

  • Status: ⚪ Not Tested
  • Parameters: analysisType
  • Error:
  • Notes:

30. solidworks:vba_assembly_configurations

  • Status: ⚪ Not Tested
  • Parameters: operation, configName
  • Error:
  • Notes:

VBA Drawing Functions

31. solidworks:vba_create_drawing_views

  • Status: ⚪ Not Tested
  • Parameters: viewType, modelPath, position
  • Error:
  • Notes:

32. solidworks:vba_drawing_dimensions

  • Status: ⚪ Not Tested
  • Parameters: dimensionType, position
  • Error:
  • Notes:

33. solidworks:vba_drawing_annotations

  • Status: ⚪ Not Tested
  • Parameters: annotationType, position
  • Error:
  • Notes:

34. solidworks:vba_drawing_tables

  • Status: ⚪ Not Tested
  • Parameters: tableType, position
  • Error:
  • Notes:

35. solidworks:vba_drawing_sheet_format

  • Status: ⚪ Not Tested
  • Parameters: operation
  • Error:
  • Notes:

VBA Utility Functions

36. solidworks:vba_batch_operations

  • Status: ⚪ Not Tested
  • Parameters: operation, sourcePath
  • Error:
  • Notes:

37. solidworks:vba_custom_properties

  • Status: ⚪ Not Tested
  • Parameters: operation
  • Error:
  • Notes:

38. solidworks:vba_pdm_operations

  • Status: ⚪ Not Tested
  • Parameters: operation, vaultName
  • Error:
  • Notes:

39. solidworks:vba_design_table

  • Status: ⚪ Not Tested
  • Parameters: operation, tableName
  • Error:
  • Notes:

40. solidworks:vba_configurations

  • Status: ⚪ Not Tested
  • Parameters: operation, configName
  • Error:
  • Notes:

41. solidworks:vba_equations

  • Status: ⚪ Not Tested
  • Parameters: operation
  • Error:
  • Notes:

42. solidworks:vba_simulation_setup

  • Status: ⚪ Not Tested
  • Parameters: studyType, studyName
  • Error:
  • Notes:

43. solidworks:vba_api_automation

  • Status: ⚪ Not Tested
  • Parameters: automationType
  • Error:
  • Notes:

44. solidworks:vba_error_handling

  • Status: ⚪ Not Tested
  • Parameters: functionName, operationType
  • Error:
  • Notes:

Analysis Functions

45. solidworks:get_mass_properties

  • Status: 🔴 Not Working
  • Parameters: units
  • Error: TypeError: Cannot read properties of undefined (reading 'CreateMassProperty')
  • Notes: Extension property not accessible

46. solidworks:check_interference

  • Status: ⚪ Not Tested
  • Parameters: includeMultibodyParts, treatCoincidenceAsInterference, treatSubAssembliesAsComponents
  • Error:
  • Notes:

47. solidworks:measure_distance

  • Status: ⚪ Not Tested
  • Parameters: entity1, entity2
  • Error:
  • Notes:

48. solidworks:analyze_draft

  • Status: ⚪ Not Tested
  • Parameters: pullDirection, requiredAngle
  • Error:
  • Notes:

49. solidworks:check_geometry

  • Status: 🔴 Not Working
  • Parameters: checkType
  • Error: No result received from client-side tool execution
  • Notes: Tool execution failure

50. solidworks:get_bounding_box

  • Status: 🔴 Not Working
  • Parameters: None
  • Error: No result received from client-side tool execution
  • Notes: Tool execution failure

Macro Recording Functions

51. solidworks:macro_start_recording

  • Status: ⚪ Not Tested
  • Parameters: name, description
  • Error:
  • Notes:

52. solidworks:macro_stop_recording

  • Status: ⚪ Not Tested
  • Parameters: None
  • Error:
  • Notes:

53. solidworks:macro_export_vba

  • Status: ⚪ Not Tested
  • Parameters: macroId
  • Error:
  • Notes:

Design Table Functions

54. solidworks:design_table_create

  • Status: ⚪ Not Tested
  • Parameters: name, config
  • Error:
  • Notes:

55. solidworks:design_table_refresh

  • Status: ⚪ Not Tested
  • Parameters: resourceId
  • Error:
  • Notes:

Summary

  • Total Functions: 55
  • Working: 0
  • Not Working: 0
  • Partial: 0
  • Not Tested: 55

Notes

  • Testing conducted with SolidWorks running
  • MCP Server version: 2.1.0
  • Node.js version: v22.18.0