0255064648
Add setup-macos.sh, a shell script that automates Claude Desktop MCP configuration on macOS. The script detects KiCad's bundled Python, resolves PYTHONPATH, generates the correct MCP server config, and safely merges it into the existing Claude Desktop configuration with backup support. Supports --verify, --dry-run, and --apply modes. Update README.md with documentation for the automated setup workflow, including usage examples, parameter reference, and post-setup steps. Extend docs/PLATFORM_GUIDE.md with macOS-specific sections covering installation, path handling, Python environment, troubleshooting, best practices, cross-platform migration, and support resources. Update docs/STATUS_SUMMARY.md to reflect the new macOS automation capabilities and bump the last-updated date.
176 lines
6.8 KiB
Markdown
176 lines
6.8 KiB
Markdown
# KiCAD MCP - Current Status Summary
|
|
|
|
**Date:** 2026-03-21
|
|
**Version:** 2.2.3 (package.json shows 2.1.0-alpha -- CHANGELOG is authoritative)
|
|
**Phase:** Active development with community contributions
|
|
|
|
---
|
|
|
|
## Quick Stats
|
|
|
|
| Metric | Value |
|
|
| -------------------- | --------------------------- |
|
|
| Total MCP Tools | 122 |
|
|
| Tool Categories | 16 |
|
|
| KiCAD 9.0 Compatible | Yes (verified) |
|
|
| Platforms | Linux, Windows, macOS |
|
|
| JLCPCB Parts Catalog | 2.5M+ components |
|
|
| Symbol Access | ~10,000 via dynamic loading |
|
|
| Footprint Libraries | 153+ auto-discovered |
|
|
| Contributors | 10+ |
|
|
| MCP Protocol Version | 2025-06-18 |
|
|
|
|
---
|
|
|
|
## Feature Completion Matrix
|
|
|
|
| Feature Category | Status | Tool Count | Details |
|
|
| ------------------- | -------- | ---------- | ----------------------------------------------------------------------- |
|
|
| Project Management | Complete | 5 | Create, open, save, info, snapshot |
|
|
| Board Setup | Complete | 12 | Size, outline, layers, mounting holes, zones, text, 2D view, SVG import |
|
|
| Component Placement | Complete | 16 | Place, move, rotate, delete, edit, find, pads, arrays, align, duplicate |
|
|
| Routing | Complete | 13 | Traces, vias, pad-to-pad, differential pairs, netclasses, copy pattern |
|
|
| Design Rules / DRC | Complete | 8 | Set/get rules, DRC, net classes, clearance checks |
|
|
| Export | Complete | 8 | Gerber, PDF, SVG, 3D, BOM, netlist, position file, VRML |
|
|
| Schematic | Complete | 27 | Components, wiring, net labels, connections, ERC, export, sync to board |
|
|
| Footprint Libraries | Complete | 4 | List, search, browse, info |
|
|
| Symbol Libraries | Complete | 4 | List, search, browse, info |
|
|
| Footprint Creator | Complete | 4 | Create custom footprints, edit pads, register libraries |
|
|
| Symbol Creator | Complete | 4 | Create custom symbols, register libraries |
|
|
| Datasheet Tools | Complete | 2 | LCSC datasheet enrichment |
|
|
| JLCPCB Integration | Complete | 5 | Local DB, search, part details, stats, alternatives |
|
|
| Freerouting | Complete | 4 | Autoroute, DSN export, SES import, availability check |
|
|
| UI Management | Complete | 2 | Check/launch KiCAD |
|
|
| Router Tools | Complete | 4 | Category browsing, tool search, execute |
|
|
|
|
---
|
|
|
|
## Architecture
|
|
|
|
### SWIG Backend (File-based) -- Default
|
|
|
|
- **Status:** Stable
|
|
- Direct pcbnew API access via KiCAD's Python bindings
|
|
- Requires manual KiCAD UI reload to see changes
|
|
- Works without KiCAD running
|
|
- Auto-saves after every board-modifying command
|
|
|
|
### IPC Backend (Real-time) -- Experimental
|
|
|
|
- **Status:** Functional, 21 commands implemented
|
|
- Real-time UI synchronization with KiCAD 9+
|
|
- Requires KiCAD running with IPC API enabled
|
|
- Automatic fallback to SWIG when unavailable
|
|
|
|
### Hybrid Approach
|
|
|
|
The server automatically selects the best backend:
|
|
|
|
- IPC when KiCAD is running with IPC enabled
|
|
- SWIG fallback when IPC is unavailable
|
|
- Some operations use both (e.g., footprint placement)
|
|
|
|
---
|
|
|
|
## Platform Support
|
|
|
|
### Linux -- Primary Platform
|
|
|
|
- KiCAD 9.0 detection: Working
|
|
- Process management: Working
|
|
- Library discovery: Working (153+ libraries)
|
|
- IPC backend: Working
|
|
|
|
### Windows -- Fully Supported
|
|
|
|
- Automated setup script (setup-windows.ps1)
|
|
- Process detection via Toolhelp32 API
|
|
- Library paths auto-detected
|
|
- Troubleshooting guide available (WINDOWS_TROUBLESHOOTING.md)
|
|
|
|
### macOS -- Community Supported
|
|
|
|
- Automated setup script (setup-macos.sh)
|
|
- Auto-detects KiCad Python and pcbnew
|
|
- Generates Claude Desktop configuration
|
|
- Process detection implemented
|
|
- Library paths auto-configured
|
|
- Needs community testing
|
|
|
|
---
|
|
|
|
## Recent Development Highlights
|
|
|
|
### v2.2.3 (2026-03-11)
|
|
|
|
- FFC/ribbon cable passthrough workflow (connect_passthrough, sync_schematic_to_board)
|
|
- Project snapshot system
|
|
- SVG logo import
|
|
- ERC validation
|
|
- Developer mode (KICAD_MCP_DEV=1)
|
|
- Critical B.Cu routing fixes
|
|
|
|
### v2.2.2-alpha (2026-03-01)
|
|
|
|
- route_pad_to_pad with auto-via insertion
|
|
- copy_routing_pattern for trace replication
|
|
- Project-local library resolution
|
|
|
|
### v2.2.1-alpha (2026-02-28)
|
|
|
|
- edit_schematic_component with field position support
|
|
- Footprint and symbol creator tools
|
|
|
|
### v2.2.0-alpha (2026-02-27)
|
|
|
|
- 13 new routing/component tools
|
|
- Datasheet enrichment tools
|
|
- SWIG/UUID bug fixes
|
|
|
|
### v2.1.0-alpha (2026-01-10)
|
|
|
|
- Complete schematic wiring system
|
|
- Dynamic symbol loading (~10,000 symbols)
|
|
- JLCPCB parts integration
|
|
- Router pattern (70% context reduction)
|
|
|
|
---
|
|
|
|
## Community Contributors
|
|
|
|
| Contributor | Key Contributions |
|
|
| ------------- | ------------------------------------------------------------------------------ |
|
|
| Kletternaut | Routing tools, footprint/symbol creators, passthrough workflow, template fixes |
|
|
| Mehanik | Schematic inspection/editing tools, component field positions |
|
|
| jflaflamme | Freerouting autorouter integration with Docker/Podman |
|
|
| l3wi | Local symbol library search, JLCPCB third-party library support |
|
|
| gwall-ceres | MCP protocol compliance, Windows compatibility |
|
|
| fariouche | Bug fixes |
|
|
| shuofengzhang | XDG relative path handling |
|
|
| sid115 | Windows setup script improvements |
|
|
| pasrom | MCP server bug fixes |
|
|
|
|
---
|
|
|
|
## Getting Help
|
|
|
|
**For Users:**
|
|
|
|
1. Check [README.md](../README.md) for installation
|
|
2. Review [KNOWN_ISSUES.md](KNOWN_ISSUES.md) for common problems
|
|
3. Check logs: `~/.kicad-mcp/logs/kicad_interface.log`
|
|
|
|
**For Contributors:**
|
|
|
|
1. Read [CONTRIBUTING.md](../CONTRIBUTING.md) for development setup
|
|
2. Check [ARCHITECTURE.md](ARCHITECTURE.md) for system design
|
|
3. Review the [Documentation Index](INDEX.md) for all available docs
|
|
|
|
**Issues:**
|
|
|
|
- Open an issue on GitHub with OS, KiCAD version, and error details
|
|
|
|
---
|
|
|
|
_Last Updated: 2026-04-11_
|