nearxos/kicad-mcp-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2c35ff40a77293ecb9cfec18b9a49c9f9bd91fa1
kicad-mcp-server/docs/INDEX.md
Eugene Mikhantyev 7d50fa1d4c style: apply Prettier formatting to TS/JS/JSON/MD files 
Add Prettier as a dev dependency with .prettierrc.json config and
.prettierignore. Hook added via mirrors-prettier in pre-commit config.
All TypeScript, JSON, Markdown, and YAML files auto-formatted.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-29 13:05:50 +01:00

4.9 KiB
Raw Blame History

Documentation Index

KiCAD MCP Server -- AI-assisted PCB design via Model Context Protocol

Version: 2.2.3 | Tools: 122 | Last Updated: 2026-03-21

Getting Started

Document Description
README Project overview, installation, configuration, quick start
Client Configuration MCP client setup (Claude Desktop, Cline, Claude Code)
Platform Guide Linux vs Windows vs macOS differences
PCB Design Workflow End-to-end design guide from project creation to manufacturing

Tool References

Document Description
Tool Inventory Complete list of all 122 tools with access types
Schematic Tools Reference 27 schematic tools -- components, wiring, analysis, export
Routing Tools Reference 13 routing tools -- traces, vias, differential pairs, zones
Footprint and Symbol Creator Guide 8 tools for creating custom footprints and symbols
Freerouting Guide 4 autorouter tools -- setup, usage, Docker support
SVG Import Guide Import SVG logos onto PCB layers
Datasheet Tools Guide Datasheet enrichment via LCSC

Integration Guides

Document Description
JLCPCB Integration JLCPCB parts catalog, pricing, component selection
JLCPCB Usage Guide Detailed JLCPCB setup and usage
Library Integration Footprint and symbol library setup
IPC Backend Status Real-time KiCAD UI synchronization (experimental)

Workflows

Document Description
Realtime Workflow Working with IPC backend for live updates
Visual Feedback UI visual feedback guide
UI Auto Launch Automatic KiCAD UI launch feature
Router Guide Tool router pattern usage
Router Architecture Router pattern design
Router Quick Start Quick start for the router pattern

Troubleshooting

Document Description
Known Issues Current issues and workarounds
Windows Troubleshooting Windows-specific problems
Linux Compatibility Audit Linux platform details

Project Information

Document Description
Status Summary Current project status and feature matrix
Roadmap Development roadmap and planned features
Changelog Detailed release notes for all versions

For Contributors

Document Description
Contributing How to contribute to the project
Architecture System architecture and adding new tools

Archive

Historical planning documents are preserved in docs/archive/.