SolidWorks CAD助手和MCP服务器
    
用于SolidWorks自动化的Python MCP服务器，配备109个工具，以及用于AI辅助工作流的可选代理/提示测试层。
概述
⚠️ 项目状态： 该项目正在积极建设中。随着Python和UI实现的最终确定，功能、API、文档和设置步骤可能会发生变化。这是一个爱好/研究产品，如果您有任何问题或反馈，请随时提问！ ⚠️
该项目侧重于具有AI友好循环的实用SolidWorks自动化：
- 描述意图
- 制定计划
- 执行MCP工具
- 检查结果
- 迭代
它包括：
- SolidWorks工具执行的核心MCP运行时
- COM/VBA路由和适配器安全包装器
- 涵盖建模、草图绘制、绘图、分析、导出、自动化、模板和宏的工具
- 下的可选代理编排/测试实用程序
src/solidworks_mcp/agents/
今日支持
- Windows+SolidWorks COM自动化主要CAD生命周期。
- 建模、草图绘制、绘图、分析、导出、自动化、模板和宏工具。
- 将活动视口中的UI预览同步预制为PNG。
尚未/模拟
- 模拟适配器输出是模拟的，不应被视为工程真理。
- UI中的实时3D视口流。
- UI运行器中的检查点级干扰验证。
什么有效（已验证的Windows安装程序）
这是端到端验证的设置路径：
- 从Python.org（Windows安装程序）安装Python。
- 启用 将python.exe添加到PATH 在安装过程中。
- 将此项目安装到本地
.venv. - 从启动MCP
.venv\Scripts\python.exe（非WSL）。
如果这是正确的，启动日志将显示：
Platform: WindowsSolidWorks COM interface is availableRegistered ... SolidWorks tools（计数随工具的发展而变化）Connected to SolidWorks
需求
- Windows 10/11实现了SolidWorks COM的真正自动化。
- Python 3.11+来自Python.org。
- Git。
- SolidWorks至少安装并启动过一次。
Linux/WSL适用于docs/tests/mock模式，但不适用于直接的COM自动化。
快速入门（Windows，python.org）
git clone https://github.com/andrewbartels1/SolidworksMCP-python.git
cd SolidworksMCP-python
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install --upgrade pip setuptools wheel
.\.venv\Scripts\python.exe -m pip install -e .手动启动服务器：
.\.venv\Scripts\python.exe -m solidworks_mcp.server或者使用辅助脚本：
powershell -NoProfile -ExecutionPolicy Bypass -File .\run-mcp.ps1开发命令
使用常用工作流的辅助脚本：
.\dev-commands.ps1常用命令：
dev-install-安装/更新本地开发环境dev-test-运行标准测试套件（CI安全子集）dev-test-full-运行完整的测试套件（包括烟雾/集成路径）dev-lint-绒毛检查dev-format-格式代码dev-docs-build-一次构建文档站点dev-docs-strict-严格文档构建（警告失败）dev-docs-audit-在中生成文档审核报告.generated/docs
本地CI副本（Docker）
在本地镜像GitHub Actions CI（Ubuntu+conda env来自 solidworks_mcp.yml + make test)，运行：
.\run-ci-local.ps1第一次运行构建映像。仅执行测试时重新运行而不重建：
.\run-ci-local.ps1 -NoBuild预制UI仪表板
交互式CAD助手与GitHub Copilot集成和实时3D视口同步。
快速开始 （需要2个端子）：
- 终端1-后端API服务器：
.\.venv\Scripts\python.exe -m pip install -e ".[ui]" # one time
.\.venv\Scripts\python.exe -m uvicorn solidworks_mcp.ui.server:app --host 127.0.0.1 --port 8766 --reload后端是一个FastAPI应用程序，因此本地API文档可在 .
- 2号航站楼-预制前端：
.\.venv\Scripts\prefab.exe serve src/solidworks_mcp/ui/prefab_dashboard.py- 打开 在您的浏览器中。
布局：
- 左侧窗格 （更宽）：设计意图输入+家庭分类门
- 中间窗格：检查点队列+上下文窗口+证据表+手动同步
- 右侧窗格 （较大）：带方向按钮的三维模型视图（等轴测/前/顶部/当前）
主要特点：
- ✅ GitHub Copilot集成，用于目标明确和家族分类
- ✅ 具有SQLite会话持久性的检查点工作流
- ✅ Execute Next Checkpoint运行支持的适配器工具，并记录每个工具的结果
- ✅ 使用SolidWorks实时同步PNG预览
export_image(view_orientation=...) - ✅ 通过快照比较进行手动编辑检测
- 🔧 模拟:
check_interference从检查点运行器（直到工具层布线存在） - 🔧 模拟：实时3D视口流和STL嵌入UI（PNG同步是实时的）
- 📋 未来：更丰富的模型状态差异（特征级别和质量属性差异）
LLM要求：
GH_TOKEN或GITHUB_API_KEY环境变量（模型：读取范围）- OR：已认证
gh auth login会话
预览窗格：
- 每3分钟或手动刷新时从活动SolidWorks视口导出
- 支撑：等距、正面、顶部、当前方向
- 需要：SolidWorks运行+COM适配器可用
完整文档：
看 预制UI仪表板指南 用于按钮参考、架构说明和故障排除。
VS代码MCP配置（Windows）
设置用户MCP配置(%APPDATA%\Code\User\mcp.json)致：
{
"servers": {
"solidworks-mcp-server": {
"type": "stdio",
"command": "powershell",
"args": [
"-NoProfile",
"-ExecutionPolicy",
"Bypass",
"-File",
"C:\\path\\to\\SolidworksMCP-python\\run-mcp.ps1"
]
}
}
}将脚本路径替换为本地存储库路径。
LM Studio MCP配置（Windows）
将LM Studio MCP配置文件设置为包含此服务器（LM Studio需要 mcpServers):
{
"mcpServers": {
"solidworks-mcp-server": {
"command": "powershell",
"args": [
"-NoProfile",
"-ExecutionPolicy",
"Bypass",
"-File",
"C:\\Users\\andre\\OneDrive\\Documents\\GitHub\\SolidworksMCP-python\\run-mcp.ps1"
]
}
}
}替代的python直接入口：
{
"mcpServers": {
"solidworks-mcp-server": {
"command": "C:\\Users\\andre\\OneDrive\\Documents\\GitHub\\SolidworksMCP-python\\.venv\\Scripts\\python.exe",
"args": ["-m", "solidworks_mcp.server"]
}
}
}保存后，重新启动LM Studio，以便重新加载MCP服务器。
常见Windows修复程序
如果 python 未找到：
python --version如果此操作打开Microsoft Store或失败，请从Python.org重新安装Python并启用PATH。
如果启动失败 ModuleNotFoundError: solidworks_mcp:
.\.venv\Scripts\python.exe -m pip install -e .如果启动失败 ModuleNotFoundError: fastmcp:
.\.venv\Scripts\python.exe -m pip install -e .文档
- 主文档站点：
- 主页/概述： docs/index.md
关键文档部分：
- 入门指南： 文档/入门
- MCP服务器指南： 文档/用户指南
- 工具目录： 文档/用户指南/工具目录
- 代理人和技能： 文档/代理
- 规划/路线图： 文档/规划
直接链接：
许可证
MIT许可证。看 许可证.