SolidWorks MCP Server

A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with SolidWorks CAD software, providing automated design capabilities, macro recording, design tables with SQL integration, VBA generation, and PDM configuration management.

🎯 Quick Start

⚠️ Windows Users: Local Installation Required

Due to the winax native module dependency, this package cannot be installed via npm global install. You must build it locally on your Windows machine.

Installation Steps:

# 1. Clone the repository to your Windows machine
git clone https://github.com/vespo92/SolidworksMCP-TS
cd SolidworksMCP-TS

# 2. Install dependencies (this compiles winax for your system)
npm install

# 3. Build the TypeScript files
npm run build

Configure Claude Desktop

After installation, add the local path to your Claude Desktop config (see detailed instructions below).

Then in Claude Desktop:

"Generate VBA to batch export all parts in my folder to STEP format"
"Create a parametric design table for a configurable bracket"
"Check for interferences in my assembly"

🚀 Key Features

Core Capabilities

• Full SolidWorks Control - Open, create, modify, and analyze CAD models
• Macro Recording & Playback - Record operations and generate reusable macros
• Design Tables with SQL - Create parametric designs driven by database data
• PDM Integration - Configure and manage SolidWorks PDM vaults
• VBA Script Generation - Generate VBA scripts from templates with AI assistance
• State Management - Persistent resource states with auto-save
• Resource-Based Architecture - Modular, extensible design pattern

New in v2.1.0 - Comprehensive VBA Generation Suite

⚠️ IMPORTANT: VBA script generation features are NOT WORKING in the current iteration and require additional testing

• 🔧 Part Modeling VBA - Advanced features, patterns, sheet metal, surfaces
• 🏗️ Assembly Automation - Mates, components, interference analysis
• 📐 Drawing Generation - Views, dimensions, annotations, tables
• 📁 File & PDM Operations - Batch processing, custom properties, vault management
• ⚙️ Advanced Features - Configurations, equations, simulation setup
• 🎯 100+ VBA Tools - Generate production-ready VBA without coding knowledge

Enterprise Features (v2.0)

• 🎯 Macro Recording System - Record actions and export to VBA
• 📊 SQL-Driven Design Tables - Connect to databases for parametric designs
• 🗄️ PDM Configuration - Manage vault operations, workflows, and automation
• 💾 State Persistence - Track and restore resource states
• 🏗️ Resource Registry - Dynamic resource type management
• 📝 Enhanced Logging - Comprehensive operation tracking

📋 Prerequisites

• Windows 10/11
• SolidWorks 2021-2025 (licensed installation)
• Node.js 20 or higher
• Claude Desktop
• Optional: SQL Server or PostgreSQL for design tables
• Optional: SolidWorks PDM for vault operations

🛠️ Installation

1. Install the MCP Server

Local Installation (Required for Windows):

# Clone to your Windows machine
git clone https://github.com/vespo92/SolidworksMCP-TS
cd SolidworksMCP-TS

# Install and build
npm install  # Compiles winax native module for your system
npm run build  # Compiles TypeScript to JavaScript

Note: The npm install step will compile the winax native module specifically for your Windows system. This is why global npm installation doesn't work - each Windows machine needs its own compiled version.

2. Configure Claude Desktop

⚠️ IMPORTANT: Windows Installation Issue

Due to the nature of the winax native module (which provides COM/ActiveX support for Windows), the npm global installation method will not work. The winax module must be compiled locally for your specific Windows system.

Required: Local Installation Method

1. Download or clone this repository to your Windows machine
2. Install dependencies locally:

cd C:\path\to\SolidworksMCP-Final
npm install  # This will compile winax for your system
npm run build  # Build the TypeScript files

3. Configure Claude Desktop to use the local installation:

{
  "mcpServers": {
    "solidworks": {
      "command": "node",
      "args": ["C:\\path\\to\\SolidworksMCP-Final\\dist\\index.js"]
    }
  }
}

Why This Is Necessary

• winax is a C++ native module that interfaces with Windows COM/ActiveX
• Native modules cannot be pre-compiled for all Windows configurations
• Each system needs its own compiled version matching its Node.js version and architecture
• This is a limitation of native modules, not the MCP server itself

Future Solutions (In Development)

We're exploring options to simplify installation:

• Pre-built binaries for common Windows configurations
• Automatic winax installation script
• Docker container with pre-configured environment
• Electron-based standalone application

3. Environment Configuration

Create a .env file for advanced configuration:

# SolidWorks Configuration
SOLIDWORKS_PATH=C:/Program Files/SOLIDWORKS Corp/SOLIDWORKS
SOLIDWORKS_VERSION=2024

# Feature Flags
ENABLE_MACRO_RECORDING=true
ENABLE_PDM=true

# Database Configuration (for Design Tables)
SQL_CONNECTION=mssql://localhost:1433/solidworks_db

# PDM Configuration
PDM_VAULT=Engineering

# State Management
STATE_FILE=.solidworks-state.json

# Logging
LOG_LEVEL=info

🚀 Usage Examples

Macro Recording

"Start recording a macro called 'CreateBracket'"
"Create a sketch on the front plane"
"Add a rectangle 100mm x 50mm"
"Extrude 25mm"
"Stop recording and export to VBA"

Design Tables with SQL

"Create a design table for parametric box configurations from SQL database"
"Use query: SELECT * FROM box_configurations"
"Map columns: length, width, height to dimensions"
"Generate all configurations"

PDM Operations

"Configure PDM vault 'Engineering' for automatic check-in/check-out"
"Set up workflow transition from 'Work in Progress' to 'Released'"
"Create folder structure with permissions for project team"

Advanced VBA Generation (v2.1.0)

Part Modeling

"Generate VBA to create a parametric bracket with:
- Reference planes offset by 50mm
- Sweep feature along a 3D curve
- Linear pattern with 5 instances
- Sheet metal conversion with 2mm thickness"

Assembly Automation

"Generate VBA for assembly that:
- Inserts components from a folder
- Creates coincident and distance mates
- Checks for interferences
- Exports mass properties to Excel"

Batch Operations

"Generate VBA to process all files in C:\Parts that:
- Opens each SLDPRT file
- Updates custom properties (Part Number, Revision)
- Exports to STEP format
- Checks into PDM vault with comment"

Drawing Automation

"Generate VBA to create drawings that:
- Creates standard 3-view layout
- Adds section view A-A
- Dimensions all features
- Inserts BOM table
- Exports to PDF"

🔧 Available Tools

Macro Tools

• macro_start_recording - Begin recording operations
• macro_stop_recording - End recording and save
• macro_export_vba - Export macro to VBA code ⚠️ NOT WORKING - Requires additional testing
• macro_execute - Run recorded macro

Design Table Tools

• design_table_create - Create parametric design table
• design_table_refresh - Update from SQL source
• design_table_add_config - Add configuration
• design_table_export - Export configurations

PDM Tools

• pdm_configure - Set up vault configuration
• pdm_checkin - Check in files with comments
• pdm_checkout - Check out for editing
• pdm_workflow - Execute workflow transitions
• pdm_create_structure - Set up folder hierarchy

Resource Management

• resource_create - Create new resource
• resource_list - List all resources
• resource_get - Get resource details
• resource_update - Update resource properties
• resource_delete - Remove resource

Existing Tools

All original tools remain available:

• Modeling tools (create, modify, analyze)
• Drawing tools (views, dimensions, annotations)
• Export tools (STEP, IGES, STL, PDF, etc.)
• VBA tools ⚠️ NOTE: VBA script generation is NOT WORKING in the current iteration and requires additional testing
• Analysis tools (mass properties, interference)

📚 API Reference

Resource Types

Design Table Resource

{
  type: 'design-table',
  tableName: string,
  parameters: Array<{
    name: string,
    type: 'dimension' | 'feature' | 'configuration',
    dataType: 'number' | 'string' | 'boolean',
    sqlColumn?: string,
    formula?: string
  }>,
  dataSource?: {
    type: 'sql' | 'file' | 'api',
    connectionString?: string,
    query?: string
  }
}

PDM Configuration Resource

{
  type: 'pdm-configuration',
  vaultName: string,
  operations: {
    checkIn?: { enabled: boolean, comment?: string },
    checkOut?: { enabled: boolean, getLatestVersion?: boolean },
    workflow?: { 
      enabled: boolean,
      transitions: Array<{
        name: string,
        fromState: string,
        toState: string
      }>
    }
  }
}

🧪 Development

Building from Source

git clone https://github.com/vespo92/SolidworksMCP-TS
cd solidworks-mcp-server
npm install
npm run build

Running Tests

npm test                  # Run all tests
npm run test:unit        # Unit tests only
npm run test:integration # Integration tests

Adding Custom Resources

Create a new resource type:

import { SolidWorksResource } from './resources/base';

export class CustomResource extends SolidWorksResource {
  readonly type = 'custom-type';
  
  async execute(api: SolidWorksAPI) {
    // Implementation
  }
  
  toVBACode(): string {
    // Generate VBA
  }
}

Register the resource:

resourceRegistry.register({
  type: 'custom-type',
  name: 'Custom Resource',
  schema: CustomSchema,
  factory: (id, name, props) => new CustomResource(id, name, props)
});

🐛 Troubleshooting

Macro Recording Issues

• Ensure macro recording is enabled in environment
• Check that actions are supported for recording
• Verify VBA export permissions

SQL Connection Problems

• Verify connection string format
• Check database permissions
• Ensure SQL drivers are installed

PDM Integration

• Confirm PDM client is installed
• Verify vault access permissions
• Check network connectivity to PDM server

State Management

• Check write permissions for state file
• Clear corrupted state with resource_clear
• Verify auto-save is enabled

📊 Performance Considerations

• Batch Operations: Use macro recording for repetitive tasks
• SQL Queries: Optimize queries for large datasets
• State Storage: Periodically clean old states
• PDM Operations: Use batch check-in/check-out

🔒 Security

• SQL connections use secure authentication
• PDM credentials are not stored in state
• Macro execution requires explicit permission
• State files can be encrypted (configure in .env)

📄 License

MIT License - see LICENSE file

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Areas for Contribution

• Additional resource types
• Enhanced SQL integrations
• More VBA templates
• PDM workflow automation
• Testing improvements

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

🚀 Roadmap

v2.1 (Q2 2024)

• [ ] Real-time collaboration features
• [ ] Cloud storage integration
• [ ] Advanced simulation tools
• [ ] Custom property management

v2.2 (Q3 2024)

• [ ] AI-powered design suggestions
• [ ] Automated testing framework
• [ ] Performance optimization tools
• [ ] Extended PDM capabilities

📖 Changelog

See CHANGELOG.md for version history.

Built with ❤️ for the SolidWorks community