Skip to content
Back to search

KiCad_MCP

MCP server for KiCad 10: schematic analysis, validation, manufacturing exports, live IPC PCB editing

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 17 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/skfine24/KiCad_MCP with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/skfine24/KiCad_MCP'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/skfine24--kicad-mcp/badge.svg)](/listings/skfine24--kicad-mcp)

HTML

<a href="/listings/skfine24--kicad-mcp"><img src="/api/listings/skfine24--kicad-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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

{
  "mcp": {
    "kicad": {
      "type": "local",
      "command": [
        "uvx",
        "--from",
        "git+https://github.com/skfine24/KiCad_MCP.git@v0.5.2",
        "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.

To use the latest `main` instead of the tag, replace `@v0.5.2` with `@main`.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 135 lines
  1. # KiCad_MCP
  2. MCP (Model Context Protocol) server for KiCad 10, built on the official
  3. `kicad-python` bindings and `kicad-cli`. It provides schematic analysis,
  4. netlist connectivity, ERC/DRC validation, manufacturing exports, PCB
  5. inspection/editing, and live IPC editing of the board open in KiCad.
  6. Repository: https://github.com/skfine24/KiCad_MCP
  7. ## Requirements
  8. - KiCad 10.0.x (tested with 10.0.8, API 10.0.6)
  9. - Python 3.11+
  10. - `uv`/`uvx` for the one-command install (or `pip`)
  11. - For live IPC: KiCad GUI running with **Preferences > Plugins > Enable KiCad
  12. API server** on, and a PCB editor document open
  13. ## Quick start (opencode)
  14. Add this to `~/.config/opencode/opencode.jsonc`:
  15. ```jsonc
  16. {
  17. "mcp": {
  18. "kicad": {
  19. "type": "local",
  20. "command": [
  21. "uvx",
  22. "--from",
  23. "git+https://github.com/skfine24/KiCad_MCP.git@v0.5.2",
  24. "kicad-mcp"
  25. ],
  26. "enabled": true
  27. }
  28. }
  29. }
  30. ```
  31. Restart opencode. `uvx` builds the package from the tagged GitHub source and
  32. caches the environment; no local clone or virtualenv is required.
  33. To use the latest `main` instead of the tag, replace `@v0.5.2` with `@main`.
  34. ## Install as a tool
  35. ```powershell
  36. uv tool install git+https://github.com/skfine24/KiCad_MCP.git@v0.5.2
  37. kicad-mcp
  38. ```
  39. ## Local development
  40. ```powershell
  41. git clone https://github.com/skfine24/KiCad_MCP.git
  42. cd KiCad_MCP
  43. uv venv
  44. uv pip install -e ".[dev]"
  45. ```
  46. Run the server directly over stdio:
  47. ```powershell
  48. .\.venv\Scripts\python.exe -m kicad_mcp
  49. ```
  50. ## Tools
  51. v0.6.0 adds fresh-netlist revisions, structured/paginated DRC/ERC, transactional
  52. PCB batches, schematic text editing, library search, mechanical checks,
  53. manufacturing manifests and BOM enrichment.
  54. | Category | Tools |
  55. |---|---|
  56. | Project | `create_project`, `list_projects` |
  57. | Schematic analysis | `read_schematic`, `list_components`, `sch_revision` |
  58. | Connectivity | `export_netlist`, `list_nets`, `trace_net` (fresh export by default; `refresh`, `expected_revision`, mtime/hash metadata) |
  59. | Validation | `run_erc`, `run_drc` (structured severity/type/net/items, `offset`/`limit`, filters, report SHA-256), `find_duplicate_tracks`, `find_isolated_islands` |
  60. | PCB inspection | `get_board_info` (KiCad 10 pad-level nets, thickness, stackup, netclasses, unconnected pads, optional schematic net merge), `pcb_revision` |
  61. | 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` |
  62. | 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` |
  63. | Library | `search_symbols`, `search_footprints`, `get_pinout`, `get_footprint_info`, `list_libraries` |
  64. | Mechanical | `mechanical_check`, `check_courtyard`, `check_3d_models`, `board_edge_clearance` |
  65. | 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` |
  66. | BOM | `bom_enrich` (MPN/Manufacturer/Supplier/Stock/Alternate + database merge), `bom_validate_mpn` |
  67. | Staged editing | `edit_begin`, `edit_commit` (atomic commit with backup/revision) |
  68. | 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` |
  69. | Status | `get_kicad_version`, `doctor`, `self_test` |
  70. Resources: `kicad://board` (live IPC), `kicad://schematic` (live IPC),
  71. `kicad://schematic-file/{path*}`, `kicad://project/{path*}`.
  72. Safe mode: set `KICAD_MCP_SAFE_MODE=1` to require `confirm=True` on destructive
  73. tools. `dry_run` is available on PCB/schematic edit tools.
  74. ## Live IPC connection (optional)
  75. `get_kicad_version` reports a live IPC connection when:
  76. 1. KiCad GUI is running
  77. 2. Preferences > Plugins > "Enable KiCad API server" is on
  78. 3. A PCB editor document is open
  79. The IPC path enables live PCB inspection and editing of the board open in the
  80. GUI. Without it, all file-based tools still work headless via `kicad-cli`.
  81. The KiCad IPC API has no open-document command. `ipc_open_board` therefore
  82. launches `pcbnew.exe` with the PCB path when no PCB editor is running, and waits
  83. until the document appears in IPC. If `pcbnew.exe` is already running it does
  84. not launch a second editor; open the board manually in that case.
  85. Note: `kicad-cli api-server` (headless IPC) is not available in KiCad 10.0.6
  86. stable; it exists in kipy for newer builds.
  87. ## Tests
  88. ```powershell
  89. python tests/integration_test.py # 19 tool-level checks against a real KiCad demo project
  90. python tests/stdio_test.py # MCP stdio protocol handshake + tool calls
  91. ```
  92. The tests copy the KiCad `pic_programmer` demo project from
  93. `C:\Program Files\KiCad\10.0\share\kicad\demos` into a temp directory. Override
  94. `KICAD_DEMO_DIR` and `KICAD_MCP_TEST_DIR` if KiCad is installed elsewhere.
  95. ## Known limits
  96. - Schematic editing has no official API in KiCad; this server is read-only for
  97. schematics by design
  98. - `get_board_info` parses `.kicad_pcb` directly (fast); for design-rule-precise
  99. data prefer `run_drc`
  100. - Live IPC tools require the KiCad GUI, the API server, and an open PCB document
  101. ## License
  102. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.