Skip to main content

MCP server exposing KiCad PCB Editor functionality via IPC API

Project description

mcp-kicad — MCP server exposing KiCad PCB Editor functionality via IPC API.

PyPI Python Ruff

Install

pip install mcp-kicad

Requirements

  • KiCad 9.0 or higher with the IPC API server enabled
  • Go to Preferences > Plugins in KiCad and enable the API server

Usage

The MCP server communicates with a running KiCad instance via the IPC API. Start KiCad first, then run the server:

mcp-kicad

Or configure it in your MCP client:

{
  "mcpServers": {
    "mcp-kicad": {
      "command": "mcp-kicad",
      "env": {}
    }
  }
}

Tools

The server exposes the following tools:

  • Connection: connect_kicad, check_connection
  • Board: get_board_info, get_layers, get_board_design_settings
  • Footprints: list_footprints, get_footprint, search_footprints
  • Nets: list_nets, get_net, list_netclasses
  • Zones: list_zones
  • Tracks/Vias: list_tracks, list_vias
  • Pads: list_pads
  • Text: list_texts, get_text_extents
  • Project: get_project, get_version

Example

from mcp_kicad import mcp_server

# Connect to running KiCad
result = mcp_server.connect_kicad()

# Get board info
board_info = mcp_server.get_board_info()
print(board_info)

# List all footprints
footprints = mcp_server.list_footprints()
for fp in footprints:
    print(f"{fp['reference']}: {fp['value']}")

Development

git clone https://github.com/daedalus/mcp-kicad.git
cd mcp-kicad
pip install -e ".[test]"

# run tests
pytest

# format
ruff format src/ tests/

# lint
ruff check src/ tests/

# type check
mypy src/

mcp-name: io.github.daedalus/mcp-kicad

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_kicad-0.1.1.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_kicad-0.1.1-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_kicad-0.1.1.tar.gz.

File metadata

  • Download URL: mcp_kicad-0.1.1.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_kicad-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5f94e406d82e44d7c1c4bda23e8c99570087e184b365b4570862b20236b2f72a
MD5 5f886f13f7755f09ab9a476346c3708e
BLAKE2b-256 998a51cd73120bfb94afdeaf4a1ec57ff42c793f390275deb4f5d503fb61e40f

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_kicad-0.1.1.tar.gz:

Publisher: pypi-publish.yml on daedalus/mcp-kicad

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_kicad-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: mcp_kicad-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_kicad-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7388f9a145673c7284502d81f054275c0043afa3433d1d193b526abb08603eaf
MD5 494741a3914a93de414516c3237c46ee
BLAKE2b-256 5c07f49bf74d6cab51fb0ca1bf1e1285c1fd47bf12c8c2070b54fde1cc969c94

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_kicad-0.1.1-py3-none-any.whl:

Publisher: pypi-publish.yml on daedalus/mcp-kicad

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page