Skip to main content
Glama

KiCad_MCP

MCP (Model Context Protocol) server for KiCad 10, built on the official kicad-python bindings and kicad-cli. One server covers the whole design-to-order loop: schematic analysis, netlist connectivity, ERC/DRC validation, transactional PCB and schematic editing, library search, mechanical and manufacturing checks, live IPC editing of the open board, and vendor part search / BOM purchase lists (DigiKey Korea, IC Mart, DeviceMart).

Repository: https://github.com/skfine24/KiCad_MCP

Current release: v0.8.1 — 91 tools, 4 resources. v0.8.1 is a maintenance release (UTF-8 enforcement, dead-code cleanup, standalone parts server removed); the feature set is the same as v0.8.0.

What's new in v0.8.0

The former standalone parts-purchase MCP server is merged into this package. There is no second process and no second opencode entry; part search and BOM purchasing are regular tools here.

  • Vendor search: search_parts, search_digikey, search_icmart, search_devicemart, compare_parts, get_part and per-site product lookups. DigiKey Korea returns KRW price tiers, stock, MOQ/order multiple and the exact DigiKey product number (Product Information V4 API).

  • BOM purchasing: bom_purchase_list prices BOM items against DigiKey/IC Mart/DeviceMart and recommends the cheapest available option; check_digikey_bom strictly requires an exact MPN or DigiKey product number for every non-module item.

  • DeviceMart guest cart: add_to_cart_devicemart, get_devicemart_cart, remove_from_cart_devicemart. No login, no checkout automation; the cart survives restarts via a persisted cookie file.

  • Modules (Pico/Pico W, VL53L0X/L1X/L5CX, TTP223 module, WS2812B strip) are excluded from the purchase BOM by default (include_modules=True to include them). KiCad BOM files are never modified by these tools.

  • Network tools are annotated openWorldHint; no request is made until a tool is called.

Everything from v0.6.0/v0.7.0 is unchanged: fresh netlists, structured DRC/ERC, transactional pcb_batch, schematic text editing, library search, mechanical checks and manufacturing manifests.

Related MCP server: KiCAD MCP Server

Requirements

  • KiCad 10.0.x (tested with 10.0.8, API 10.0.6)

  • Python 3.11+

  • uv/uvx for the one-command install (or pip)

  • For live IPC: KiCad GUI running with Preferences > Plugins > Enable KiCad API server on, and a PCB editor document open

  • For DigiKey search: an API credential file (see below). IC Mart and DeviceMart need no credentials.

Installation

Add this to ~/.config/opencode/opencode.jsonc:

{
  "mcp": {
    "kicad": {
      "type": "local",
      "command": [
        "uvx",
        "--from",
        "git+https://github.com/skfine24/KiCad_MCP.git@v0.8.1",
        "kicad-mcp"
      ],
      "enabled": true
    }
  }
}

Restart opencode. uvx builds the package from the tagged GitHub source and caches the environment; no local clone or virtualenv is required. Use @main instead of @v0.8.1 to track the latest commits.

If you previously had a separate parts MCP entry, remove it — v0.8.1 replaces it.

Install as a tool

uv tool install git+https://github.com/skfine24/KiCad_MCP.git@v0.8.1
kicad-mcp

pip

pip install "kicad-mcp @ git+https://github.com/skfine24/KiCad_MCP.git@v0.8.1"

Local development

git clone https://github.com/skfine24/KiCad_MCP.git
cd KiCad_MCP
uv venv
uv pip install -e ".[dev]"
.\.venv\Scripts\python.exe -m kicad_mcp

Windows note: an editable install on a network share whose path contains non-ASCII characters can make Python fail while reading the generated .pth file (UnicodeDecodeError: 'cp949' codec ...). Clone to a local ASCII path for development; the uvx install is unaffected because it builds a wheel.

Source encoding: all source, test and documentation files are UTF-8 without BOM. .editorconfig sets charset = utf-8, and tests/test_encoding.py fails the suite if any file is not valid UTF-8.

Vendor part search setup

DigiKey credentials are read from C:\Users\skfin\.config\opencode\parts-purchase\digikey.json by default (outside the repository):

{
  "client_id": "...",
  "client_secret": "...",
  "customer_id": "..."
}

Override the path with PARTS_MCP_DIGIKEY_CREDENTIALS. The file must not be committed.

DeviceMart guest-cart cookies are persisted in C:\Users\skfin\.config\opencode\parts-purchase\state\devicemart_cookies.json so the cart survives server restarts. Override the directory with KICAD_MCP_PARTS_STATE_DIR.

Tools (91)

Category

Tools

Project

create_project, list_projects

Schematic analysis

read_schematic, list_components, sch_revision

Connectivity

export_netlist, list_nets, trace_net (fresh export by default; refresh, expected_revision, mtime/hash metadata)

Validation

run_erc, run_drc (structured severity/type/net/items, offset/limit, filters, report SHA-256), find_duplicate_tracks, find_isolated_islands

PCB inspection

get_board_info (KiCad 10 pad-level nets, thickness, stackup, netclasses, unconnected pads, optional schematic net merge), pcb_revision, render_pcb

PCB editing

add_tracks, add_via, delete_tracks, trim_track, prune_dangling, refill_zones, pcb_batch (one transaction, dry-run, rollback, expected revision, local staging + atomic save), set_pad_net, set_footprint_value, replace_footprint, place_footprint, set_zone_connection, add_zone, add_keepout, set_zone_priority, remove_islands, delete_zone

Schematic editing

sch_add_wire, sch_add_label, sch_add_no_connect, sch_set_value, sch_set_property, sch_add_symbol (embeds/flattens lib_symbols, supports extends), sch_delete_item

Library

search_symbols, search_footprints, get_pinout, get_footprint_info, list_libraries

Mechanical

mechanical_check, check_courtyard, check_3d_models, board_edge_clearance

Manufacturing

export_gerbers (optional standard profile), export_drill, export_bom, export_pos, export_step, export_pdf, manufacturing_profile (standard layers + drill/POS/BOM/STEP/PDF + SHA-256 manifest), verify_manufacturing_output

BOM

bom_enrich (MPN/Manufacturer/Supplier/Stock/Alternate + database merge), bom_validate_mpn

Vendor part search

search_parts (digikey default, icmart, devicemart, both, all), search_digikey, search_icmart, search_devicemart, compare_parts, get_part, get_digikey_product, get_icmart_product, get_devicemart_product

BOM purchasing

bom_purchase_list (per-item options, recommended option, availability, estimated KRW total), check_digikey_bom (strict MPN/stock check)

DeviceMart cart

add_to_cart_devicemart (confirm=True), get_devicemart_cart, remove_from_cart_devicemart (confirm=True)

Staged editing

edit_begin, edit_commit (atomic commit with backup/revision)

Live IPC

ipc_open_board, ipc_board_info, ipc_get_schematic, ipc_list_nets, ipc_list_items, ipc_get_selection, ipc_items_at_point, ipc_add_track, ipc_add_via, ipc_batch (one undo step via begin/push/drop commit), ipc_delete_items, ipc_save, ipc_refill_zones, ipc_set_active_layer

Status

get_kicad_version, doctor, self_test

Resources: kicad://board (live IPC), kicad://schematic (live IPC), kicad://schematic-file/{path*}, kicad://project/{path*}.

BOM item shape for purchasing

bom_purchase_list accepts a list of objects:

[
  {"name": "Schottky diode", "mpn": "SB540-E3/54", "digikey_pn": "SB540-E3/54GICT-ND", "qty": 2},
  {"name": "100nF", "mpn": "K104K15X7RF5TH5", "qty": 9},
  {"name": "10k", "mpn": "CFR-25JB-52-10K", "qty": 10}
]

mpn, digikey_product_number, digikey_pn, digikey_mpn, icmart_id and devicemart_no are optional for bom_purchase_list; when absent the server searches the selected site. Use exact MPNs or known product ids for deterministic results. check_digikey_bom requires an exact MPN or DigiKey product number for every non-module item; generic value-only items are rejected so a fuzzy match is never reported as orderable.

Safety

  • KICAD_MCP_SAFE_MODE=1 requires confirm=True on destructive tools.

  • dry_run is available on PCB/schematic edit tools; pcb_batch rolls back on failure and checks expected_revision.

  • Cart writes always require confirm=True; checkout/payment is not automated.

  • Credentials and cookies live outside the repository.

Live IPC connection (optional)

get_kicad_version reports a live IPC connection when:

  1. KiCad GUI is running

  2. Preferences > Plugins > "Enable KiCad API server" is on

  3. A PCB editor document is open

Without it, all file-based tools still work headless via kicad-cli.

The KiCad IPC API has no open-document command. ipc_open_board therefore launches pcbnew.exe with the PCB path when no PCB editor is running, and waits until the document appears in IPC. If pcbnew.exe is already running it does not launch a second editor; open the board manually in that case.

Tests

uv run --with pytest pytest -q            # 29 unit tests (core + vendor parsers + UTF-8 guard)
python tests/integration_test.py          # 19 tool-level checks against a real KiCad demo project
python tests/stdio_test.py                # MCP stdio handshake, tools/list (91), sample calls
python tests/smoke_live_parts.py          # live read-only DigiKey/IC Mart/DeviceMart smoke test

The unit tests need no network and no KiCad install. integration_test.py copies the KiCad pic_programmer demo project into a temp directory; override KICAD_DEMO_DIR and KICAD_MCP_TEST_DIR if KiCad is installed elsewhere. smoke_live_parts.py performs read-only searches and product lookups; DigiKey requires the credential file above.

Known limits

  • Schematic editing is text-level (.kicad_sch S-expression editing); KiCad has no official schematic API. Re-run ERC after edits.

  • get_board_info parses .kicad_pcb directly (fast); for design-rule-precise data prefer run_drc.

  • Live IPC tools require the KiCad GUI, the API server, and an open PCB document.

  • IC Mart and DeviceMart adapters parse server-rendered HTML/SSE; a site redesign can break them. DigiKey uses a stable JSON API.

  • DigiKey API quotas apply; requests are rate-limited and tokens cached.

  • Module parts are excluded from purchase BOMs by default and are not orderable through these tools.

  • No login, checkout or payment automation for any vendor.

Version history

Version

Change

0.8.1

Maintenance: UTF-8 enforcement, dead-code cleanup, standalone parts server removed

0.8.0

Vendor part search + BOM purchase lists + DeviceMart cart merged in (14 tools)

0.7.0

Version bump only (release marker for the DigiKey BOM workflow)

0.6.0

Fresh netlists, structured DRC/ERC, transactional PCB/schematic editing, library/mechanical/manufacturing/BOM tools

0.5.2

Deployable package, portable tests, opencode setup

0.5.1

IPC tool import fix, stdout JSON parse fix

License

MIT

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      D
      maintenance
      Enables AI assistants to read and modify KiCAD PCB designs through the KiCAD IPC API, providing tools for board queries, footprint placement, track creation, DRC, and export.
      14
      MIT
    • A
      license
      B
      quality
      C
      maintenance
      Enables AI assistants to interact with KiCAD for PCB design automation, including schematic editing, component placement, routing, DRC/ERC, and export.
      100
      38 npm
      2
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      Provides schematic/PCB analysis, authoring, and SPICE simulation through MCP, enabling direct KiCad file manipulation and verification without requiring KiCad for reading.
      18
      MIT
    • A
      license
      A
      quality
      C
      maintenance
      Enables AI assistants to lint, render, fix, inspect, and find free space in KiCad schematics and PCBs, providing visual feedback and safe automated text fixes.
      10
      MIT