KiCad MCP Pro

KiCad MCP Pro is a Model Context Protocol server for KiCad EDA workflows. It exposes tools, resources, and prompts for schematic, PCB, validation, DFM, and manufacturing export automation.

The server now starts with the bounded default profile: 24 read-only review tools instead of the complete expert catalog. Use build with write mode for controlled edits, release with manufacturing mode for human-gated handoff, or expert/full only for advanced trusted clients. Current catalog counts and context-size estimates come from docs/evidence/progressive-disclosure-profile-snapshot.json; see docs/agents/progressive-disclosure.md.

Telemetry and error reporting are disabled by default. Opt-in OpenTelemetry configuration is documented in docs/configuration.md, and privacy rules are documented in docs/privacy.md.

Scope and honesty

KiCad MCP Pro is a professional first-pass design and review assistant, not an automated sign-off authority. ERC/DRC and the export pipeline drive KiCad's own engines. The signal-integrity, power-integrity, EMC, and thermal tools are first-order, closed-form estimates (typically ~5–10% accuracy) — fast first-pass review, not a substitute for a 2D/3D field solver, EM/FEA simulation, or formal sign-off. Live component sourcing uses the JLCPCB public catalog by default; Nexar, DigiKey, and Mouser are available only when their API credentials are configured. What fraction of KiCad's programmatic surface the server drives is tracked openly in the capability-parity matrix. Raw tool count and capability coverage are inventory metrics, not the headline product-quality measure. End-to-end task outcome, mutation recovery, corruption, required DRC execution, and manufacturing reproducibility are the outcome KPIs. The committed native-live example evidence intentionally reports insufficient_evidence; representative-corpus target attainment remains separate until the qualification work in #730 is complete.

Project identity

Quick Start

Desktop App

Download the latest installer from the GitHub releases page. The Tauri desktop app starts the Python dashboard server automatically and opens the GUI at http://127.0.0.1:3334/ui. Desktop releases launch the matching exact backend version and verify its desktop compatibility handshake before use; see Installation.

CLI

uvx kicad-mcp-pro quickstartuvx kicad-mcp-pro trayuvx kicad-mcp-pro dashboard --openuvx kicad-mcp-pro --transport streamable-http --port 3334

KiCad PCB Editor Companion (development preview)

The existing KiCad PCM Companion is being upgraded to a KiCad 10 IPC toolbar plugin in packages/kicad-plugin/. It reads the active PCB and links to the existing local dashboard. The IPC upgrade is read-only; live desktop acceptance and release are pending.

Web Dashboard

uvx kicad-mcp-pro dashboard --host 127.0.0.1 --port 3334 --open# http://127.0.0.1:3334/ui

Documentation

The documentation is organized from setup to operation:

1. Installation
2. Client configuration
3. Runtime configuration
4. Tool reference
5. Workflows
6. Release process
7. Security and privacy
8. KiCad capability parity — how much of KiCad's programmatic surface this server drives
9. Error code catalog — stable error codes, retry classes, and recovery
10. Work-order audit — current status of the hardening work order

The kicad_capability_parity() tool reports, per workflow domain, what fraction of KiCad's programmatically reachable surface this server can drive (currently 76.6%), keeping genuine gaps distinct from gui-only-no-api items that KiCad exposes no headless API for.

The published documentation site is available at https://oaslananka.github.io/kicad-mcp-pro/.

Transports

KiCad MCP Pro supports stdio and Streamable HTTP. Streamable HTTP is served at /mcp by default and can be moved with KICAD_MCP_MOUNT_PATH.

uvx kicad-mcp-pro --transport streamable-http --host 127.0.0.1 --port 3334

Streamable HTTP clients must send Accept: application/json, text/event-stream and Content-Type: application/json. The primary public MCP contract is 2026-07-28: modern clients send MCP-Protocol-Version: 2026-07-28, the method/name transport headers required by the final protocol, and the per-request client metadata envelope.

Backward-compatible 2025-11-25 clients remain supported through the SDK's legacy initialize negotiation. Those clients echo the negotiated protocol version on follow-up requests and, when KICAD_MCP_STATEFUL_HTTP=1, also echo MCP-Session-Id. Final 2026-07-28 traffic is stateless and does not create MCP sessions.

The deprecated HTTP+SSE fallback routes are disabled by default. Set KICAD_MCP_LEGACY_SSE=1 only for older clients that cannot use Streamable HTTP.

Install

Published packages:

uvx kicad-mcp-pro --helpnpx kicad-mcp-pro --help

Fresh source checkout on supported Linux hosts:

./scripts/bootstrap-dev.shsource .dev-env.shpnpm run dev:doctor -- --ci

The repository bootstrap installs checksum-pinned Python, uv/uvx, Node.js, pnpm, Task, and Rust tooling into ignored checkout-local roots and performs frozen dependency installation. It does not modify global tool directories. See the reproducible bootstrap guide for --core-only, --check, cleanup, upgrade, and KiCad capability modes.

Package metadata

The canonical metadata inputs are pyproject.toml for package version and repository identity, and compatibility.yaml for KiCad and MCP support policy. server.json is the generated registry manifest. pnpm run metadata:sync renders the public surfaces, and pnpm run metadata:check verifies them in CI and release validation.

Fast local setup

Open a terminal in a KiCad project directory and run:

uvx kicad-mcp-pro quickstart

This detects a supported local agent, configures its MCP entry in read-only mode, installs bundled skills where supported, backs up existing settings, and verifies the saved launch command over stdio. Cloud login is optional and is not required for local use. See the installation guide for details and explicit agent selection.

Usage

Use kicad-mcp-pro --help to inspect CLI commands and docs/client-configuration.md to configure an MCP client. The generated tool catalog is available in docs/tools-reference.generated.md.

Agent plugin and skills

This repository owns the product-level agent plugin and KiCad-specific skills for KiCad MCP Pro. The central agent-tools repository should catalog this plugin, but the manifest and workflow instructions live here so they stay synchronized with the actual MCP server tools.

Agent setup

KiCad MCP Pro can be launched with the published Python package, npm wrapper, or the container metadata declared in server.json. Common local starts are:

uvx kicad-mcp-pro --transport stdiouvx kicad-mcp-pro --transport streamable-http --host 127.0.0.1 --port 3334npx kicad-mcp-pro --help

For source checkouts, run the normal repository validation path before publishing plugin changes:

corepack pnpm run metadata:checkpython3 -m json.tool .claude-plugin/plugin.json >/dev/null

Validation workflow

Before listing this plugin as active from agent-tools, verify at least one compatible agent runtime can:

1. Discover .claude-plugin/plugin.json.
2. Launch or connect to kicad-mcp-pro over stdio or Streamable HTTP.
3. Call kicad_get_server_info or kicad_get_project_info.
4. Load a skill from skills/ and follow the workflow without referencing missing tools.
5. Report ERC, DRC, DFM, export artifacts, assumptions, and human-review requirements separately.

KiCad MCP Pro is an engineering assistant, not an autonomous manufacturing sign-off authority. Generated PCB and fabrication outputs require qualified human review before fabrication or assembly.

Development

New contributors should start with ARCHITECTURE.md, which maps the five layers (transport → MCP protocol → orchestration → KiCad adapter seam → pure domain) and shows exactly how to add a new tool. The runtime model and quality-gate stack are documented in docs/development/architecture.md.

The project uses a Taskfile.yml for common development commands. After cloning the repository:

task install     # Install all dependencies (pnpm + uv)task verify      # Run the local quality gate: lint → format → typecheck → test → buildtask test        # Run unit tests onlytask lint        # Run lint and metadata checkstask format      # Auto-format the codebasetask typecheck   # Run strict static type checkingtask build       # Build release artifactstask ci          # Run the local equivalent of the full CI pipelinetask hooks       # Install repository-pinned Lefthook git hooks

All changes must pass task verify before opening a pull request.

Contributing

Read CONTRIBUTING.md before opening a pull request. All changes must pass the repository's format, lint, type-check, test, workflow, security, and package metadata gates.

Independent industry coverage

• JLCPCB (October 14, 2026) — KiCad MCP: How to Design a PCB with Claude Code documents a hands-on KiCad MCP Pro workflow for an XL4015/LM358 buck-converter design, including checks and limitations. The board was not fabricated or bench-tested. This is independent coverage, not a JLCPCB endorsement or partnership; reported issues are being evaluated in #1314.

Cite this software

If you use KiCad MCP Pro in research or a technical publication, cite the archived release via its DOI (see CITATION.cff for full metadata):

@software{aslan_kicad_mcp_pro,  author  = {Aslan, Osman},  title   = {KiCad MCP Pro},  license = {MIT},  url     = {https://github.com/oaslananka/kicad-mcp-pro},  doi     = {10.5281/zenodo.21283791}}

Every GitHub release is archived on Zenodo under this concept DOI, which always resolves to the most recent version.

License

KiCad MCP Pro is available under the MIT License.