
lamaalrajih/kicad-mcp
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
Сервер протокола Model Context Protocol для KiCad на Mac, Windows и Linux
Обзор
Это руководство поможет вам настроить сервер Model Context Protocol (MCP) для KiCad. Хотя примеры в этом руководстве часто ссылаются на Claude Desktop, сервер совместим с . Вы можете использовать его с Claude Desktop, собственными клиентами MCP или любым другим приложением, реализующим Model Context Protocol. - macOS, Windows или Linux — Python 3.10 или выше — KiCad 9.0 и выше — uv 0.8.0 или выше — Claude Desktop (или другой MCP-клиент) Сначала давайте установим зависимости и настроим нашу среду: Создайте файл .env, чтобы настроить место поиска сервера для ваших проектов KiCad: В файле .env добавьте свои собственные директории проектов: После настройки среды можно запустить сервер: Теперь настроим Claude Desktop для использования нашего MCP-сервера: 1. Создать или отредактировать конфигурационный файл Claude Desktop:
Обзор (машинный перевод)
Это руководство поможет вам настроить сервер Model Context Protocol (MCP) для KiCad. Хотя примеры в этом руководстве часто ссылаются на Claude Desktop, сервер совместим с любым MCP-совместимым клиентом. Вы можете использовать его с Claude Desktop, своими собственными MCP-клиентами или любым другим приложением, реализующим Model Context Protocol.
Содержание
- Предварительные требования
- Этапы установки
- Понимание компонентов MCP
- Основные моменты
- Взаимодействие естественного языка
- Документация
- Конфигурация
- Руководство по разработке.
- Устранение неисправностей
- Вклад
- Идеи будущего развития
- Лицензия
Предварительные требования
- macOS, Windows или Linux
- Python 3.10 или выше
- KiCad 9.0 или выше
- УФ 0.8.0 или выше
- Claude Desktop (или другой клиент MCP)
Этапы установки
1. Настройте свою Python-среду
Сначала давайте установим зависимости и настроим нашу среду:
2. Настройте свою среду
Создайте файл .env, чтобы настроить, где сервер ищет ваши проекты KiCad:
В файле .env добавьте свои собственные директории проектов:
3. Запусти сервер
После настройки среды можно запустить сервер:
4. Настройка MCP-клиента
Эта страница переведена автоматически. Технические детали смотрите в оригинале.
README
Показан фрагмент оригинального README. Открыть оригинал.
KiCad MCP Server
This guide will help you set up a Model Context Protocol (MCP) server for KiCad. While the examples in this guide often reference Claude Desktop, the server is compatible with any MCP-compliant client. You can use it with Claude Desktop, your own custom MCP clients, or any other application that implements the Model Context Protocol.
Table of Contents
- Prerequisites
- Installation Steps
- Understanding MCP Components
- Feature Highlights
- Natural Language Interaction
- Documentation
- Configuration
- Development Guide
- Troubleshooting
- Contributing
- Future Development Ideas
- License
Prerequisites
- macOS, Windows, or Linux
- Python 3.10 or higher
- KiCad 9.0 or higher
- uv 0.8.0 or higher
- Claude Desktop (or another MCP client)
Installation Steps
1. Set Up Your Python Environment
First, let’s install dependencies and set up our environment:
# Clone the repository
git clone https://github.com/lamaalrajih/kicad-mcp.git
cd kicad-mcp
# Install dependencies – `uv` will create a `.venv/` folder automatically
# (Install `uv` first: `brew install uv` on macOS or `pipx install uv`)
make install
# Optional: activate the environment for manual commands
source .venv/bin/activate
2. Configure Your Environment
Create a .env file to customize where the server looks for your KiCad projects:
# Copy the example environment file
cp .env.example .env
# Edit the .env file
vim .env
In the .env file, add your custom project directories:
# Add paths to your KiCad projects (comma-separated)
KICAD_SEARCH_PATHS=~/pcb,~/Electronics,~/Projects/KiCad
3. Run the Server
Once the environment is set up, you can run the server:
python main.py
4. Configure an MCP Client
Now, let’s configure Claude Desktop to use our MCP server:
- Create or edit the Claude Desktop configuration file:
# Create the directory if it doesn't exist
mkdir -p ~/Library/Application\ Support/Claude
# Edit the configuration file
vim ~/Library/Application\ Support/Claude/claude_desktop_config.json
- Add the KiCad MCP server to the configuration:
{
"mcpServers": {
"kicad": {
"command": "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/.venv/bin/python",
"args": [
"/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/main.py"
]
}
}
}
Replace /ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp with the actual path to your project directory.
5. Restart Your MCP Client
Close and reopen your MCP client to load the new configuration.
Understanding MCP Components
The Model Context Protocol (MCP) defines three primary ways to provide capabilities:
Установка
This server does not publish a one-line install command.
Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →Конфигурация
{
"mcpServers": {
"kicad": {
"command": "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/.venv/bin/python",
"args": [
"/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/main.py"
]
}
}
}