Kicad MCP

🚀 KiCad MCP Server

KiCad MCP Server is a middleware that extends the functionality of KiCad, a popular open - source Electronic Design Automation (EDA) tool for creating Printed Circuit Boards (PCB). It enables interaction with clients via the MCP protocol.

🚀 Quick Start

KiCad MCP Server is a middleware designed to enhance KiCad, a well - known open - source EDA tool for PCB design. It allows interaction with clients through the MCP protocol.

To get started, follow these steps:

# Clone the repository
git clone https://github.com/your-repository/kicad-mcp.git
# Install dependencies
pip install -r requirements.txt
# Run the server
python main.py

✨ Features

• Resource Handling: Provides manual access to KiCad project files and data.
• Tool Support: Enhances KiCad's core functionality and adds new tools.
• Prompt Templates: Pre - defined prompt templates to help users interact with KiCad more effectively.
• Modular Structure: Well - organized code for easy extension and maintenance.

📦 Installation

1. Clone the repository:

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

2. Install dependencies:

pip install -r requirements.txt

3. Run the server:

python main.py

📚 Documentation

Configuration

KiCad MCP Server can be configured via environment variables or a .env file.

Key Configuration Options

For more configuration details, refer to the Configuration Guide.

Development Guide

Project Structure

KiCad MCP Server uses a modular structure:

kicad-mcp/
├── README.md                       # Project documentation
├── main.py                         # Entry point to run the server
├── requirements.txt                # Python dependencies
├── .env.example                    # Example environment configuration file
├── kicad_mcp/                      # Main package directory
│   ├── __init__.py
│   ├── server.py                   # MCP server setup
│   ├── config.py                   # Configuration constants and settings
│   ├── context.py                  # Lifecycle management and shared context
│   ├── resources/                  # Resource handlers
│   ├── tools/                      # Tool handlers
│   ├── prompts/                    # Prompt templates
│   └── utils/                      # Utility functions
├── docs/                           # Documentation
└── tests/                          # Unit tests

Adding New Features

To add new features to KiCad MCP Server, follow these steps:

1. Determine the category of the feature (resource, tool, or prompt).
2. Create a new file or modify an existing one in the corresponding directory.
3. Update requirements.txt and main.py to include the new feature.

Troubleshooting

Common Issues

• Issue: Unable to start the server.
  • Solution: Check if the dependencies are installed correctly and ensure there are no syntax errors.
• Issue: Connection to KiCad fails.
  • Solution: Verify the configuration parameters and ensure KiCad is installed correctly.

For more troubleshooting steps, refer to the Troubleshooting Guide.

The complete documentation, including detailed API documentation and usage tutorials, can be found on the GitHub Wiki.