4d7843c03a
Promotes BOM / sourcing fields (MPN, Manufacturer, DigiKey_PN, LCSC,
JLCPCB_PN, Voltage, Tolerance, Dielectric, ...) to first-class citizens
on placed schematic symbols.
New MCP tools:
- set_schematic_component_property: add or update one custom property
on a component (convenience wrapper around edit_schematic_component).
- remove_schematic_component_property: delete one custom property.
The four built-in fields (Reference, Value, Footprint, Datasheet) are
protected and rejected.
edit_schematic_component enhancements:
- New `properties` parameter: map of property name to either a string
value or a full spec object { value, x?, y?, angle?, hide?, fontSize? }.
Adds the property when missing, otherwise updates the existing field
(and optionally its label position / visibility). Lets a single tool
call attach an entire BOM payload to a component.
- New `removeProperties` parameter: list of custom property names to
delete in the same call.
- Property values are now backslash-escaped so descriptions containing
a double-quote or a backslash no longer corrupt the .kicad_sch file.
- New properties default to (hide yes) so they appear in BOM exports
without cluttering the schematic canvas.
get_schematic_component description clarified to highlight that it
already returns every field on the symbol, including custom ones.
New MCP prompt component_sourcing_properties guides agents through the
conventional property names recognised by downstream BOM tooling and
the recommended call sequence.
Implementation (python/kicad_interface.py):
- _PROTECTED_PROPERTY_FIELDS frozenset
- _escape_sexpr_string / _find_matching_paren static helpers
- _set_property_in_block / _set_hide_on_property /
_remove_property_from_block surgical text-level edits that preserve
formatting and the property's UUID
- _handle_edit_schematic_component rewritten to orchestrate
add/update/remove and return a per-property summary
- New handlers _handle_set_schematic_component_property and
_handle_remove_schematic_component_property registered in the
command dispatch table
Tests (tests/test_schematic_component_properties.py):
32 tests covering escape helper, paren matcher, add/update/remove
(single + batched), full spec dicts, default position, default
(hide yes), special-character escaping, UUID preservation, protected
built-in field rejection, no-op removal, both new convenience tools,
and input validation. All 590 tests in the project still pass.
Docs: README, SCHEMATIC_TOOLS_REFERENCE, TOOL_INVENTORY, CHANGELOG.
353 lines
21 KiB
Markdown
353 lines
21 KiB
Markdown
# KiCAD MCP Server - Complete Tool Inventory
|
|
|
|
**Version:** 2.2.3
|
|
**Total Tools:** 124 (18 direct + 65 routed + 4 router + 37 additional)
|
|
**Last Updated:** 2026-04-20
|
|
|
|
## How Tools Are Organized
|
|
|
|
The server uses a **router pattern** to reduce AI context usage. Tools fall into three groups:
|
|
|
|
- **Direct tools** - Always visible to the AI. High-frequency operations used in most sessions.
|
|
- **Routed tools** - Organized into categories. Discovered via the router tools (`list_tool_categories`, `get_category_tools`, `search_tools`) and invoked via `execute_tool`.
|
|
- **Additional tools** - Registered directly (always visible) but not part of the router categories.
|
|
|
|
---
|
|
|
|
## Project Management (5 tools)
|
|
|
|
_Source: `src/tools/project.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------ | ---------------------------------------------------------------- | ------ |
|
|
| `create_project` | Create a new KiCAD project (.kicad_pro, .kicad_pcb, .kicad_sch) | Direct |
|
|
| `open_project` | Open an existing KiCAD project | Direct |
|
|
| `save_project` | Save the current project | Direct |
|
|
| `get_project_info` | Get project metadata and information | Direct |
|
|
| `snapshot_project` | Save a named checkpoint snapshot (renders PDF, saves step label) | Direct |
|
|
|
|
---
|
|
|
|
## Board Management (12 tools)
|
|
|
|
_Source: `src/tools/board.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------- | ----------------------------------------------------------------- | -------------- |
|
|
| `set_board_size` | Set PCB dimensions (width, height, unit) | Direct |
|
|
| `add_board_outline` | Add board outline (rectangle, circle, polygon, rounded_rectangle) | Direct |
|
|
| `get_board_info` | Get board metadata and properties | Direct |
|
|
| `add_layer` | Add copper/technical/signal layer | Routed (board) |
|
|
| `set_active_layer` | Change the active working layer | Routed (board) |
|
|
| `get_layer_list` | List all layers on the board | Routed (board) |
|
|
| `add_mounting_hole` | Add mounting hole with optional pad | Routed (board) |
|
|
| `add_board_text` | Add text annotation to board | Routed (board) |
|
|
| `add_zone` | Add copper zone/pour with clearance settings | Routed (board) |
|
|
| `get_board_extents` | Get bounding box of board | Routed (board) |
|
|
| `get_board_2d_view` | Render 2D board view (PNG/JPG/SVG) | Routed (board) |
|
|
| `import_svg_logo` | Import SVG file as polygons on silkscreen layer | Additional |
|
|
|
|
---
|
|
|
|
## Component Management (16 tools)
|
|
|
|
_Source: `src/tools/component.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| -------------------------- | ------------------------------------------------------------- | ------------------ |
|
|
| `place_component` | Place footprint on PCB (position, rotation, reference, value) | Direct |
|
|
| `move_component` | Move component to new position | Direct |
|
|
| `rotate_component` | Rotate component (absolute angle) | Routed (component) |
|
|
| `delete_component` | Remove component from board | Routed (component) |
|
|
| `edit_component` | Edit component properties (reference, value, footprint) | Routed (component) |
|
|
| `find_component` | Search components by reference or value | Routed (component) |
|
|
| `get_component_properties` | Get all properties of a component | Routed (component) |
|
|
| `add_component_annotation` | Add annotation/comment to component | Routed (component) |
|
|
| `group_components` | Group multiple components together | Routed (component) |
|
|
| `replace_component` | Replace component with different footprint | Routed (component) |
|
|
| `get_component_pads` | Get all pad information for a component | Additional |
|
|
| `get_component_list` | List all components with optional filters | Additional |
|
|
| `get_pad_position` | Get precise position of a specific pad | Additional |
|
|
| `place_component_array` | Place array of components (rows x columns) | Additional |
|
|
| `align_components` | Align components (horizontal, vertical, grid) | Additional |
|
|
| `duplicate_component` | Duplicate component with offset | Additional |
|
|
|
|
---
|
|
|
|
## Routing (13 tools)
|
|
|
|
_Source: `src/tools/routing.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------------- | ---------------------------------------------------- | ---------------- |
|
|
| `add_net` | Create a new net on the PCB | Direct |
|
|
| `route_trace` | Route trace segment between XY points (single layer) | Direct |
|
|
| `add_via` | Add via (through/blind/buried) | Routed (routing) |
|
|
| `add_copper_pour` | Add copper pour / ground plane | Routed (routing) |
|
|
| `delete_trace` | Delete traces by UUID, position, or bulk by net | Additional |
|
|
| `query_traces` | Query/filter traces by net, layer, or bounding box | Additional |
|
|
| `get_nets_list` | List all nets with statistics | Additional |
|
|
| `modify_trace` | Modify existing trace (width, layer, net) | Additional |
|
|
| `create_netclass` | Create net class with design rules | Additional |
|
|
| `route_differential_pair` | Route differential pair traces | Additional |
|
|
| `refill_zones` | Refill all copper zones | Additional |
|
|
| `route_pad_to_pad` | Route trace between two pads with auto-via insertion | Additional |
|
|
| `copy_routing_pattern` | Copy routing from source to target component groups | Additional |
|
|
|
|
---
|
|
|
|
## Design Rules and DRC (8 tools)
|
|
|
|
_Source: `src/tools/design-rules.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ----------------------- | ----------------------------------------------------------- | ------------ |
|
|
| `set_design_rules` | Set global design rules (clearance, track width, via sizes) | Routed (drc) |
|
|
| `get_design_rules` | Get current design rules | Routed (drc) |
|
|
| `run_drc` | Run design rule check | Routed (drc) |
|
|
| `add_net_class` | Add net class with custom rules | Routed (drc) |
|
|
| `assign_net_to_class` | Assign net to a net class | Routed (drc) |
|
|
| `set_layer_constraints` | Set layer-specific constraints | Routed (drc) |
|
|
| `check_clearance` | Check clearance between two items | Routed (drc) |
|
|
| `get_drc_violations` | Get DRC violation list (filter by severity) | Routed (drc) |
|
|
|
|
---
|
|
|
|
## Export (8 tools)
|
|
|
|
_Source: `src/tools/export.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ---------------------- | ------------------------------------------------- | --------------- |
|
|
| `export_gerber` | Export Gerber files for fabrication | Routed (export) |
|
|
| `export_pdf` | Export PDF with layer selection and page size | Routed (export) |
|
|
| `export_svg` | Export SVG vector graphics | Routed (export) |
|
|
| `export_3d` | Export 3D model (STEP, STL, VRML, OBJ) | Routed (export) |
|
|
| `export_bom` | Export Bill of Materials (CSV, XML, HTML, JSON) | Routed (export) |
|
|
| `export_netlist` | Export netlist (KiCad, Spice, Cadstar, OrcadPCB2) | Routed (export) |
|
|
| `export_position_file` | Export component position file for pick and place | Routed (export) |
|
|
| `export_vrml` | Export VRML 3D model | Routed (export) |
|
|
|
|
---
|
|
|
|
## Schematic (29 tools)
|
|
|
|
_Source: `src/tools/schematic.ts`_
|
|
|
|
### Component Operations
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------ |
|
|
| `add_schematic_component` | Add component to schematic (symbol from library) | Direct |
|
|
| `delete_schematic_component` | Remove component from schematic | Additional |
|
|
| `edit_schematic_component` | Edit footprint, value, reference, label positions, and **arbitrary custom properties** (MPN, Manufacturer, DigiKey, …) | Additional |
|
|
| `set_schematic_component_property` | Add or update a single custom property (BOM/sourcing field) on a component | Additional |
|
|
| `remove_schematic_component_property` | Delete a single custom property from a component | Additional |
|
|
| `get_schematic_component` | Get component info: built-in fields + all custom properties + label positions | Additional |
|
|
| `list_schematic_components` | List all components in schematic | Direct |
|
|
| `move_schematic_component` | Move component to new position | Routed (schematic) |
|
|
| `rotate_schematic_component` | Rotate component | Routed (schematic) |
|
|
| `annotate_schematic` | Auto-annotate reference designators | Direct |
|
|
|
|
### Wiring and Connections
|
|
|
|
| Tool | Description | Access |
|
|
| ----------------------------- | ------------------------------------------------ | ------------------ |
|
|
| `add_wire` | Add wire connection between two points | Routed (schematic) |
|
|
| `delete_schematic_wire` | Delete wire segment | Routed (schematic) |
|
|
| `add_schematic_connection` | Connect two component pins with wire | Routed (schematic) |
|
|
| `add_schematic_net_label` | Add net label to schematic | Direct |
|
|
| `delete_schematic_net_label` | Delete net label | Routed (schematic) |
|
|
| `connect_to_net` | Connect component pin to named net | Direct |
|
|
| `connect_passthrough` | Connect all matching pins between two connectors | Direct |
|
|
| `get_schematic_pin_locations` | Get pin locations for a component | Additional |
|
|
|
|
### Net Analysis
|
|
|
|
| Tool | Description | Access |
|
|
| ----------------------- | ----------------------------- | ------------------ |
|
|
| `get_net_connections` | Get all connections for a net | Routed (schematic) |
|
|
| `list_schematic_nets` | List all nets in schematic | Routed (schematic) |
|
|
| `list_schematic_wires` | List all wires in schematic | Routed (schematic) |
|
|
| `list_schematic_labels` | List all net labels | Routed (schematic) |
|
|
|
|
### Text Annotations
|
|
|
|
| Tool | Description | Access |
|
|
| ---------------------- | ------------------------------------------------ | ------------------ |
|
|
| `add_schematic_text` | Add free-form text annotation to schematic | Routed (schematic) |
|
|
| `list_schematic_texts` | List all text annotations (with optional filter) | Routed (schematic) |
|
|
|
|
### Schematic Creation and Export
|
|
|
|
| Tool | Description | Access |
|
|
| ---------------------- | -------------------------------- | ------------------ |
|
|
| `create_schematic` | Create a new schematic file | Routed (schematic) |
|
|
| `get_schematic_view` | Get schematic as image (PNG/SVG) | Routed (schematic) |
|
|
| `export_schematic_svg` | Export schematic to SVG | Routed (schematic) |
|
|
| `export_schematic_pdf` | Export schematic to PDF | Routed (schematic) |
|
|
|
|
### Validation and Synchronization
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------------- | ----------------------------------------------------- | ------------------ |
|
|
| `run_erc` | Run electrical rule check | Additional |
|
|
| `generate_netlist` | Generate netlist from schematic | Routed (schematic) |
|
|
| `sync_schematic_to_board` | Sync schematic components/nets to PCB (F8 equivalent) | Direct |
|
|
|
|
---
|
|
|
|
## Footprint Libraries (4 tools)
|
|
|
|
_Source: `src/tools/library.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------------- | ------------------------------------- | ---------------- |
|
|
| `list_libraries` | List all footprint libraries | Routed (library) |
|
|
| `search_footprints` | Search footprints across libraries | Routed (library) |
|
|
| `list_library_footprints` | List footprints in a specific library | Routed (library) |
|
|
| `get_footprint_info` | Get detailed footprint information | Routed (library) |
|
|
|
|
---
|
|
|
|
## Symbol Libraries (4 tools)
|
|
|
|
_Source: `src/tools/library-symbol.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ----------------------- | ----------------------------------------------- | ---------- |
|
|
| `list_symbol_libraries` | List all symbol libraries from sym-lib-table | Additional |
|
|
| `search_symbols` | Search symbols by name, LCSC ID, or description | Additional |
|
|
| `list_library_symbols` | List symbols in a specific library | Additional |
|
|
| `get_symbol_info` | Get detailed symbol information | Additional |
|
|
|
|
---
|
|
|
|
## Footprint Creator (4 tools)
|
|
|
|
_Source: `src/tools/footprint.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ---------------------------- | ------------------------------------------------------------------------ | ---------- |
|
|
| `create_footprint` | Create custom .kicad_mod footprint (SMD/THT pads, courtyard, silkscreen) | Additional |
|
|
| `edit_footprint_pad` | Edit pad in existing footprint (size, position, drill, shape) | Additional |
|
|
| `register_footprint_library` | Register .pretty library in fp-lib-table | Additional |
|
|
| `list_footprint_libraries` | List available .pretty libraries | Additional |
|
|
|
|
---
|
|
|
|
## Symbol Creator (4 tools)
|
|
|
|
_Source: `src/tools/symbol-creator.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------------- | ------------------------------------------------------------- | ---------- |
|
|
| `create_symbol` | Create custom .kicad_sym symbol (pins, rectangles, polylines) | Additional |
|
|
| `delete_symbol` | Remove symbol from library | Additional |
|
|
| `list_symbols_in_library` | List all symbols in a .kicad_sym file | Additional |
|
|
| `register_symbol_library` | Register library in sym-lib-table | Additional |
|
|
|
|
---
|
|
|
|
## Datasheet Tools (2 tools)
|
|
|
|
_Source: `src/tools/datasheet.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------- | --------------------------------------------------- | ---------- |
|
|
| `enrich_datasheets` | Fill missing datasheet URLs using LCSC part numbers | Additional |
|
|
| `get_datasheet_url` | Get LCSC datasheet URL for a component | Additional |
|
|
|
|
---
|
|
|
|
## JLCPCB Integration (5 tools)
|
|
|
|
_Source: `src/tools/jlcpcb-api.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ----------------------------- | ------------------------------------------------------- | ---------- |
|
|
| `download_jlcpcb_database` | Download 2.5M+ parts catalog to local SQLite database | Additional |
|
|
| `search_jlcpcb_parts` | Search parts by specs (category, package, library type) | Additional |
|
|
| `get_jlcpcb_part` | Get detailed part info with pricing | Additional |
|
|
| `get_jlcpcb_database_stats` | Get database statistics | Additional |
|
|
| `suggest_jlcpcb_alternatives` | Find cheaper or in-stock alternatives | Additional |
|
|
|
|
---
|
|
|
|
## Freerouting Autorouter (4 tools)
|
|
|
|
_Source: `src/tools/freerouting.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ------------------- | ---------------------------------------------------------- | ------------------ |
|
|
| `autoroute` | Run Freerouting autorouter (export DSN, route, import SES) | Routed (autoroute) |
|
|
| `export_dsn` | Export Specctra DSN file for manual routing | Routed (autoroute) |
|
|
| `import_ses` | Import routed SES file back into PCB | Routed (autoroute) |
|
|
| `check_freerouting` | Check Java and Freerouting JAR availability | Routed (autoroute) |
|
|
|
|
---
|
|
|
|
## UI Management (2 tools)
|
|
|
|
_Source: `src/tools/ui.ts`_
|
|
|
|
| Tool | Description | Access |
|
|
| ----------------- | ----------------------------------------- | -------------- |
|
|
| `check_kicad_ui` | Check if KiCAD UI is running | Direct |
|
|
| `launch_kicad_ui` | Launch KiCAD UI (optionally with project) | Routed (board) |
|
|
|
|
---
|
|
|
|
## Router Tools (4 tools)
|
|
|
|
_Source: `src/tools/router.ts`_
|
|
|
|
These meta-tools provide discovery and execution of routed tools:
|
|
|
|
| Tool | Description |
|
|
| ---------------------- | ------------------------------------ |
|
|
| `list_tool_categories` | Browse all available tool categories |
|
|
| `get_category_tools` | View tools in a specific category |
|
|
| `search_tools` | Find tools by keyword |
|
|
| `execute_tool` | Run any routed tool with parameters |
|
|
|
|
---
|
|
|
|
## Summary by Access Type
|
|
|
|
| Access Type | Count | Description |
|
|
| ----------- | ------- | --------------------------------------------------- |
|
|
| Direct | 18 | Always visible, no router needed |
|
|
| Routed | 65 | Discovered via router, invoked via `execute_tool` |
|
|
| Router | 4 | Meta-tools for discovering and running routed tools |
|
|
| Additional | 35 | Always visible, registered directly |
|
|
| **Total** | **122** | |
|
|
|
|
## Summary by Category
|
|
|
|
| Category | Tool Count |
|
|
| -------------------- | ---------- |
|
|
| Project Management | 5 |
|
|
| Board Management | 12 |
|
|
| Component Management | 16 |
|
|
| Routing | 13 |
|
|
| Design Rules / DRC | 8 |
|
|
| Export | 8 |
|
|
| Schematic | 27 |
|
|
| Footprint Libraries | 4 |
|
|
| Symbol Libraries | 4 |
|
|
| Footprint Creator | 4 |
|
|
| Symbol Creator | 4 |
|
|
| Datasheet | 2 |
|
|
| JLCPCB Integration | 5 |
|
|
| Freerouting | 4 |
|
|
| UI Management | 2 |
|
|
| Router | 4 |
|
|
| **Total** | **122** |
|
|
|
|
## Token Impact
|
|
|
|
**Before Router Pattern:** All 122 tools in context = ~80K+ tokens
|
|
**With Router Pattern:** 18 direct + 35 additional + 4 router = 57 always-visible tools
|
|
**On-Demand:** 65 routed tools loaded only when their category is requested
|