Kicad PCB Designer

🚀 KiCAD MCP Usage Guide

KiCAD MCP (Microcontroller Protocol) is an interface protocol based on Node.js and Python for automating PCB design. Users can control KiCAD operations by sending JSON commands.

🚀 Quick Start

📦 Installation

Environment Requirements

• Node.js version >= v18.x.x
• KiCAD 9.0 or higher
• KiCAD installation with Python support

Configuration Steps

1. Clone the project repository:

   git clone https://github.com/your-repository/kicad-mcp.git
   cd kicad-mcp
   

2. Install dependencies:

   npm install
   

3. Start the service:

   npm run build && npm start
   

✨ Features

Project Management

• Create, open, and save KiCAD projects.
• Manage project configuration files.
• Retrieve project metadata.

PCB Design

• Set the board size and units.
• Add custom borders (rectangles, rounded rectangles, circles, etc.).
• Create and manage layers.
• Add mounting holes, text annotations, etc.

Component Operations

• Place components and specify package types.
• Create component arrays (grid or circular layout).
• Adjust component positions and rotation parameters.
• Align and distribute components.
• Copy components and modify attributes.

Signal Routing

• Create and manage networks.
• Draw traces automatically or manually.
• Add vias (blind vias, buried vias, etc.).
• Arrange differential pairs.
• Create copper pours (power and ground planes).

Design Rule Check

• Set global design specifications (spacing, line width, etc.).
• Define special rules for network categories.
• Perform DRC checks.
• Manage the list of violations.

Output Files

• Generate Gerber files.
• Export PDF documents.
• Create SVG graphics.
• Generate 3D models.
• Create BOM lists.

🔧 Technical Details

The project adopts a layered architecture design, specifically including:

Node.js MCP Server

• kicad-server.ts: Implements the core service of the MCP protocol.
• Uses the STDIO transmission protocol.
• Manages Python processes.
• Handles command queues and error recovery.

Python Interface

• kicad_interface.py: The main functions include:

  • Parse JSON commands received from standard input.
  • Forward instructions to dedicated processors.
  • Return results in JSON format.
  • Gracefully handle various errors.

• Function components divided by module:

  • commands/project.py: Handles operations such as project creation, opening, and saving.
  • commands/board/: Contains multiple functional sub - modules:
    • size.py: Manages the board size.
    • layers.py: Controls layer configuration.
    • outline.py: Adds borders.
    • view.py: Provides visual display.
  • commands/component.py: Handles component placement and editing.
  • commands/routing.py: Implements routing functions.
  • commands/design_rules.py: Manages design rule checks.
  • commands/export.py: Outputs files in different formats.

This architecture ensures that each PCB design step is handled by a dedicated module while maintaining the consistency and simplicity of the interface.

📚 Documentation

Common Issues and Solutions

Issue 1: KiCAD MCP does not appear in the Claude tool

• Ensure that the Cline MCP settings take effect after restarting VSCode.
• Check if the paths in the configuration file are correct.
• Confirm that the npm run build command is executed successfully.

Issue 2: Failed to start the service

• Check if the Node.js version meets the requirements.
• Ensure that KiCAD has Python support installed.
• Check the error information output in the console.

Project Contribution

Welcome to submit Pull Requests to help improve this project! Contributing Guidelines

📄 License

MIT License