mcp-kicad
Provides tools to interact with KiCad's PCB Editor via IPC API, enabling board information retrieval, footprint management, net/zone/track/via/pad/text listing, and project version access.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@mcp-kicad list all footprints on the current board"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
mcp-kicad — MCP server exposing KiCad PCB Editor functionality via IPC API.
Install
pip install mcp-kicadRelated MCP server: kicad-mcp
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-kicadOr configure it in your MCP client:
{
"mcpServers": {
"mcp-kicad": {
"command": "mcp-kicad",
"env": {}
}
}
}Tools
The server exposes the following tools:
Connection:
connect_kicad,check_connectionBoard:
get_board_info,get_layers,get_board_design_settingsFootprints:
list_footprints,get_footprint,search_footprintsNets:
list_nets,get_net,list_netclassesZones:
list_zonesTracks/Vias:
list_tracks,list_viasPads:
list_padsText:
list_texts,get_text_extentsProject:
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
Available Tools
41 toolsadd_to_selectionC
Add an item to the selection.
Inputs: item_id (required). Returns: object
check_connectionA
Check if currently connected to KiCad.
Returns connection status, KiCad version, and whether versions match.
Returns: Dictionary with connection status and version info.
Example: >>> check_connection() {"connected": True, "version": "9.0.1", "version_match": True}
Inputs: no named parameters. Returns: object
clear_selectionA
Clear the current selection.
Inputs: no named parameters. Returns: object
connect_kicadA
Connect to a running KiCad instance via the IPC API.
This must be called before any other operations. Ensure KiCad is running with the API server enabled in Preferences > Plugins.
Inputs: socket_path, kicad_token, timeout_ms. Returns: object
create_arcC
Create an arc on the board.
Inputs: center_x (required), center_y (required), start_x (required), start_y (required), +4 more. Returns: object
create_circleC
Create a circle on the board.
Inputs: x (required), y (required), radius (required), layer, +2 more. Returns: object
create_footprintD
Place a footprint on the board.
Inputs: reference (required), value (required), footprint (required), x (required), +3 more. Returns: object
create_lineC
Create a line segment on the board.
Inputs: start_x (required), start_y (required), end_x (required), end_y (required), +2 more. Returns: object
create_netC
Create a new net on the board.
Inputs: name (required), netclass. Returns: object
create_rectangleC
Create a rectangle on the board.
Inputs: x (required), y (required), width (required), height (required), +4 more. Returns: object
create_textC
Create a text element on the board.
Inputs: text (required), x (required), y (required), layer, +3 more. Returns: object
create_trackC
Create a track segment on the board.
Inputs: start_x (required), start_y (required), end_x (required), end_y (required), +3 more. Returns: object
create_viaC
Create a via on the board.
Inputs: x (required), y (required), diameter, drill, +2 more. Returns: object
create_zoneC
Create a copper zone on the board.
Inputs: net (required), layer, boundary_points, priority. Returns: object
delete_itemC
Delete an item from the board.
Inputs: item_id (required). Returns: object
get_board_design_settingsA
Get board design rules and constraints.
Returns: Dictionary with design settings (track widths, clearances, via specs).
Example: >>> get_board_design_settings() {"track_width": 0.2, "via_diameter": 0.6, "via_drill": 0.3}
Inputs: no named parameters. Returns: object
get_board_infoB
Get board metadata (title, date, company, revision, comments).
Returns: Dictionary with board metadata fields.
Example: >>> get_board_info() {"title": "My PCB", "date": "2025-01-01", "company": "", "revision": "1.0"}
Inputs: no named parameters. Returns: object
get_footprintA
Get detailed properties of a specific footprint by reference designator.
Inputs: reference (required). Returns: result
get_item_by_idC
Get item details by ID.
Inputs: item_id (required). Returns: result
get_layersA
List all PCB layers with their properties.
Returns: List of layer objects with id, name, type, visible, enabled.
Example: >>> get_layers() [{"id": 0, "name": "Copper", "type": "signal", "visible": True, "enabled": True}]
Inputs: no named parameters. Returns: result
get_netA
Get detailed information about a specific net by name.
Inputs: name (required). Returns: result
get_projectA
Get current project information.
Returns: Dictionary with project name and path.
Example: >>> get_project() {"name": "my_design", "path": "/path/to/my_design.pro"}
Inputs: no named parameters. Returns: object
get_selectionA
Get the current selection.
Inputs: no named parameters. Returns: result
get_text_extentsA
Calculate the bounding box of a text string.
Inputs: text (required), size. Returns: object
get_versionA
Get KiCad version and API version information.
Returns: Dictionary with version strings and version match status.
Example: >>> get_version() {"version": "9.0.1", "api_version": "9.0", "version_match": True}
Inputs: no named parameters. Returns: object
list_footprintsA
List all footprints on the board.
Returns: List of footprint objects with reference, value, footprint type, position.
Example: >>> list_footprints() [{"reference": "U1", "value": "ATmega328P", "footprint": "Package:DIP-8", ...}]
Inputs: no named parameters. Returns: result
list_netclassesA
List all netclasses on the board.
Returns: List of netclass objects with name and properties.
Example: >>> list_netclasses() [{"name": "Default", "clearance": 0.2, "track_width": 0.25, ...}]
Inputs: no named parameters. Returns: result
list_netsA
List all nets on the board.
Returns: List of net objects with name, code, and netclass.
Example: >>> list_nets() [{"name": "GND", "code": 0, "netclass": "Default"}, {"name": "VCC", ...}]
Inputs: no named parameters. Returns: result
list_padsA
List all pads across all footprints.
Returns: List of pad objects with footprint reference, number, net, position, size.
Example: >>> list_pads() [{"footprint": "U1", "number": "1", "net": "VCC", "position": {"x": 0, "y": 0}, ...}]
Inputs: no named parameters. Returns: result
list_textsA
List all text elements on the board.
Returns: List of text objects with content, type, layer, position, size.
Example: >>> list_texts() [{"text": "PCB Title", "type": "PCB_TEXT", "layer": "Silkscreen", ...}]
Inputs: no named parameters. Returns: result
list_tracksA
List all tracks on the board.
Returns: List of track objects with start/end positions, layer, net, width.
Example: >>> list_tracks() [{"start": {"x": 0, "y": 0}, "end": {"x": 100, "y": 0}, "net": "VCC", ...}]
Inputs: no named parameters. Returns: result
list_viasA
List all vias on the board.
Returns: List of via objects with position, diameter, drill, net, layers.
Example: >>> list_vias() [{"position": {"x": 100, "y": 50}, "diameter": 0.6, "drill": 0.3, "net": "GND"}]
Inputs: no named parameters. Returns: result
list_zonesA
List all zones (copper areas) on the board.
Returns: List of zone objects with name, net, layer, fill mode, priority.
Example: >>> list_zones() [{"name": "GND", "net": "GND", "layer": "Copper", "priority": 0}]
Inputs: no named parameters. Returns: result
move_footprintC
Move a footprint to a new position by reference.
Inputs: reference (required), x (required), y (required). Returns: object
move_itemC
Move an item to a new position.
Inputs: item_id (required), x (required), y (required). Returns: object
refill_zonesB
Refill all zones on the board.
Inputs: no named parameters. Returns: object
rotate_footprintC
Rotate a footprint by reference.
Inputs: reference (required), angle (required). Returns: object
rotate_itemC
Rotate an item.
Inputs: item_id (required), angle (required), center_x, center_y. Returns: object
save_boardC
Save the board to a file.
Inputs: path. Returns: object
search_footprintsB
Search footprints by reference designator, value, or footprint name.
Inputs: query (required). Returns: result
set_active_layerC
Set the active layer.
Inputs: layer (required). Returns: object
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 41 tools
Each tool targets a distinct action and object (e.g., create_arc vs create_line, list_nets vs list_tracks). Overlaps are minimal and descriptions clarify differences.
All tools follow a consistent verb_noun pattern in snake_case (e.g., create_arc, list_footprints, get_board_info). No mixing of conventions.
41 tools is high, but the domain (PCB design) requires many operations. Some redundancy exists (check_connection vs get_version), and a few tools could be merged (e.g., move_footprint and move_item).
The toolset covers creation, listing, and basic manipulation but lacks update/modify operations for existing items, no netclass creation, and no design rule checking. Significant gaps for a full PCB workflow.
Maintenance
Related MCP Connectors
Headless CAD engine & MCP server for 2D/3D drafting, solids, DXF/SVG export, and automation.
MCP server to assist with JxBrowser development.
MCP server wrapping the Tesla Fleet API and TeslaMate API
MCP server for progressive tool usage at any scale (see https://klavis.ai)
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceA Model Context Protocol (MCP) server that exposes KiCad PCB design automation tools to AI assistants and other MCP clients.-
- AlicenseNot gradedqualityDmaintenanceAn MCP server that gives AI agents end-to-end control of KiCad 9+ for rule checks, manufacturing exports, production-readiness certification, and live PCB editor control.MIT
- AlicenseAqualityBmaintenanceMCP server for KiCad 10 that provides live PCB access, file-based schematic handling, symbol search, schematic generation from pinouts, and a Python scripting escape hatch.233MIT
- AlicenseNot gradedqualityCmaintenanceAn MCP server for controlling KiCad EDA software, enabling schematics, PCB design, manufacturing outputs, design checks, and library management through any MCP-compatible AI assistant.MIT