io.github.daedalus/mcp-kicad

Save the board to a file.

Delete an item from the board.

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. Args: socket_path: Optional path to IPC socket. If not provided, reads from KICAD_API_SOCKET environment variable or uses default platform path. kicad_token: Optional API token for authentication. timeout_ms: Connection timeout in milliseconds. Default 2000. Returns: Dictionary with connection status, KiCad version, and version match info. Example: >>> connect_kicad() {"connected": True, "version": "9.0.1", "version_match": True}

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}

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"}

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}]

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}

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", ...}]

Get detailed properties of a specific footprint by reference designator. Args: reference: Footprint reference designator (e.g., "U1", "R5"). Returns: Footprint object with all properties including pads, or None if not found. Example: >>> get_footprint("U1") {"reference": "U1", "value": "ATmega328P", "pads": [...]}

Search footprints by reference designator, value, or footprint name. Args: query: Search string to match against reference, value, or footprint name. Returns: List of matching footprints. Example: >>> search_footprints("ATmega") [{"reference": "U1", "value": "ATmega328P", ...}]

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", ...}]

Create a copper zone on the board.

Get detailed information about a specific net by name. Args: name: Net name (e.g., "GND", "VCC"). Returns: Net object with connected pads and item count, or None if not found. Example: >>> get_net("GND") {"name": "GND", "code": 0, "connected_pads": [...], "item_count": 42}

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, ...}]

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}]

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", ...}]

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"}]

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}, ...}]

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", ...}]

Calculate the bounding box of a text string. Args: text: The text string to measure. size: Font size in mm. Default 10. Returns: Dictionary with x, y, width, height of the bounding box. Example: >>> get_text_extents("Hello") {"x": 0, "y": 0, "width": 12.5, "height": 3.0}

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}

Get current project information. Returns: Dictionary with project name and path. Example: >>> get_project() {"name": "my_design", "path": "/path/to/my_design.pro"}

Create a new net on the board.

Create a track segment on the board.

Create a via on the board.

Create a text element on the board.

Create a circle on the board.

Create a rectangle on the board.

Create an arc on the board.

Create a line segment on the board.

Move an item to a new position.

Rotate an item.

Move a footprint to a new position by reference.

Rotate a footprint by reference.

Place a footprint on the board.

Add an item to the selection.

Clear the current selection.

Get the current selection.

Set the active layer.

Refill all zones on the board.

Get item details by ID.