# 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](../README.md)                          | Project overview, installation, configuration, quick start     |
| [Client Configuration](CLIENT_CONFIGURATION.md) | MCP client setup (Claude Desktop, Cline, Claude Code)          |
| [Platform Guide](PLATFORM_GUIDE.md)             | Linux vs Windows vs macOS differences                          |
| [PCB Design Workflow](PCB_DESIGN_WORKFLOW.md)   | End-to-end design guide from project creation to manufacturing |

---

## Tool References

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

---

## Integration Guides

| Document                                      | Description                                        |
| --------------------------------------------- | -------------------------------------------------- |
| [JLCPCB Integration](JLCPCB_INTEGRATION.md)   | JLCPCB parts catalog, pricing, component selection |
| [JLCPCB Usage Guide](JLCPCB_USAGE_GUIDE.md)   | Detailed JLCPCB setup and usage                    |
| [Library Integration](LIBRARY_INTEGRATION.md) | Footprint and symbol library setup                 |
| [IPC Backend Status](IPC_BACKEND_STATUS.md)   | Real-time KiCAD UI synchronization (experimental)  |

---

## Workflows

| Document                                      | Description                               |
| --------------------------------------------- | ----------------------------------------- |
| [Realtime Workflow](REALTIME_WORKFLOW.md)     | Working with IPC backend for live updates |
| [Visual Feedback](VISUAL_FEEDBACK.md)         | UI visual feedback guide                  |
| [UI Auto Launch](UI_AUTO_LAUNCH.md)           | Automatic KiCAD UI launch feature         |
| [Router Guide](mcp-router-guide.md)           | Tool router pattern usage                 |
| [Router Architecture](ROUTER_ARCHITECTURE.md) | Router pattern design                     |
| [Router Quick Start](ROUTER_QUICK_START.md)   | Quick start for the router pattern        |

---

## Troubleshooting

| Document                                                  | Description                    |
| --------------------------------------------------------- | ------------------------------ |
| [Known Issues](KNOWN_ISSUES.md)                           | Current issues and workarounds |
| [Windows Troubleshooting](WINDOWS_TROUBLESHOOTING.md)     | Windows-specific problems      |
| [Linux Compatibility Audit](LINUX_COMPATIBILITY_AUDIT.md) | Linux platform details         |

---

## Project Information

| Document                            | Description                               |
| ----------------------------------- | ----------------------------------------- |
| [Status Summary](STATUS_SUMMARY.md) | Current project status and feature matrix |
| [Roadmap](ROADMAP.md)               | Development roadmap and planned features  |
| [Changelog](../CHANGELOG.md)        | Detailed release notes for all versions   |

---

## For Contributors

| Document                           | Description                              |
| ---------------------------------- | ---------------------------------------- |
| [Contributing](../CONTRIBUTING.md) | How to contribute to the project         |
| [Architecture](ARCHITECTURE.md)    | System architecture and adding new tools |

---

## Archive

Historical planning documents are preserved in [docs/archive/](archive/README.md).
