Kicad MCP Server

🚀 KiCAD Design Automation Protocol (MCP) English Documentation

KiCAD Design Automation Protocol (MCP) provides a method to control KiCAD software for PCB design through a command-line interface. This protocol integrates with the Claire (Claude) tool, enabling users to automate PCB design via custom commands.

The main features include:

• Create, open, and save KiCAD projects.
• Manage PCB layers and design rules.
• Automate wiring and component layout.
• Batch export design documents such as Gerber files.

🚀 Quick Start

KiCAD Design Automation Protocol (MCP) offers a seamless way to automate PCB design tasks. By integrating with the Claire (Claude) tool, users can leverage custom commands to streamline their design process.

✨ Features

• Project Management: Create, open, save, and close KiCAD projects effortlessly.
• PCB Design: Manage PCB layers, set board sizes, and define design rules.
• Component Management: Place, move, and rotate components with ease.
• Routing Functions: Add traces, vias, and differential pairs, and define network classes.
• Batch Export: Export Gerber files and other design documents in bulk.

📦 Installation

No specific installation steps are provided in the original document.

💻 Usage Examples

Basic Usage

Create a New Project

import kicad_interface as ki

result = ki.project_new("my_project")
print(result)
# Output: {'status': 'success', 'project_path': '/path/to/my_project.kicad_pro'}

Place a Component

result = ki.component_place(
    component_id="C1",
    footprint="DIP-8",
    position=(50, 60)
)
print(result)
# Output: {'status': 'success', 'message': 'Component placed successfully'}

📚 Documentation

Protocol Structure

MCP Communication Protocol

1. Request Format: JSON-formatted command packets

{
  "command": "pcb_new",
  "params": {
    "project_name": "my_project"
  }
}

2. Response Format: JSON-formatted result packets

{
  "status": "success",
  "result": {
    "project_path": "/path/to/my_project.kicad_pro"
  }
}

3. Error Handling:

{
  "status": "error",
  "message": "Failed to create project: Permission denied"
}

Command Structure

Commands are categorized as follows:

Project Management

• project_new: Create a new project.
• project_open: Open an existing project.
• project_save: Save the current project.
• project_close: Close the project.

PCB Design

• board_size: Set the board size.
• add_layer: Add a new layer.
• remove_layer: Delete a specified layer.
• set_layer_properties: Modify layer properties.

Component Management

• component_place: Place a component.
• components_array: Place components in batches.
• move_component: Move a component.
• rotate_component: Rotate a component.

Routing Functions

• route_trace: Add a trace.
• add_via: Add a via.
• create_differential_pair: Create a differential pair.
• set_net_class: Define a network class.

Implementation Details

Server-side Implementation (Node.js)

• Main Files:
  • kicad-server.ts: The main MCP protocol service.
  • command_handler.ts: The command processing center.
• Functional Modules:
  • Command parsing and routing.
  • Error handling mechanism.
  • Connection status management.

Client-side Implementation (Python)

• Main Files:
  • kicad_interface.py: The interface adapter.
  • Command processing modules (project.py, board.py, etc.).

🔧 Technical Details

Server-side Implementation (Node.js)

The server-side implementation of MCP in Node.js consists of two main files: kicad-server.ts and command_handler.ts. The kicad-server.ts file serves as the main service for the MCP protocol, while the command_handler.ts file acts as the command processing center.

The functional modules include command parsing and routing, error handling, and connection status management. These modules ensure the smooth operation of the MCP protocol and provide a reliable interface for clients to interact with the KiCAD software.

Client-side Implementation (Python)

The client-side implementation of MCP in Python includes the kicad_interface.py file, which serves as the interface adapter, and various command processing modules such as project.py and board.py. These modules allow users to send commands to the server and receive responses, enabling seamless automation of PCB design tasks.

📄 License

This project is licensed under the MIT License. The full text of the license is as follows:

MIT License

Copyright (c) 2023 KiCAD-MCP Development Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contact Information

• Project Website: https://github.com/kiCad-MCP
• Email: support@kicad-mcp.org
• Discussion Forum: Discussions Page