金大哥 - kicad-mcp MCP 详情

article

README

🚀 KiCad MCP 服务器

KiCad MCP 服务器是一款为流行的开源电子设计自动化（EDA）工具 KiCad 提供扩展功能的中间件。它允许通过 MCP 协议与客户端交互，能有效提升用户使用 KiCad 创建印刷电路板（PCB）的效率和体验。

🚀 快速开始

KiCad MCP 服务器的安装步骤如下：

克隆仓库：

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

安装依赖项：
```
pip install -r requirements.txt
```
运行服务器：
```
python main.py
```

✨ 主要特性

资源处理：提供对 KiCad 项目文件和数据的手动访问。
工具支持：增强 KiCad 的核心功能并添加新工具。
提示模板：预定义的提示模板，帮助用户更有效地与 KiCad 互动。
模块化结构：代码组织合理，便于扩展和维护。

📦 安装指南

安装步骤

克隆仓库：

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

安装依赖项：
```
pip install -r requirements.txt
```
运行服务器：
```
python main.py
```

📚 详细文档

配置

KiCad MCP 服务器可以通过环境变量或 .env 文件进行配置：

关键配置选项

| 属性 | 详情 | |------|------| | 环境变量 | 描述 | 示例 | | KICAD_SEARCH_PATHS | 要搜索的 KiCad 项目的目录列表，以逗号分隔 | ~/pcb,~/Electronics,~/Projects | | KICAD_USER_DIR | 覆盖默认的 KiCad 用户目录 | ~/Documents/KiCadProjects | | KICAD_APP_PATH | 覆盖默认的 KiCad 应用程序路径 | /Applications/KiCad7/KiCad.app |

更多配置细节请参考配置指南。

开发指南

项目结构

KiCad MCP 服务器采用模块化结构：

kicad-mcp/
├── README.md                       # 项目文档
├── main.py                         # 入口点，运行服务器
├── requirements.txt                # Python 依赖项
├── .env.example                    # 示例环境配置文件
├── kicad_mcp/                      # 主包目录
│   ├── __init__.py
│   ├── server.py                   # MCP 服务器设置
│   ├── config.py                   # 配置常量和设置
│   ├── context.py                  # 生命周期管理和共享上下文
│   ├── resources/                  # 资源处理程序
│   ├── tools/                      # 工具处理程序
│   ├── prompts/                    # 提示模板
│   └── utils/                      # 工具函数
├── docs/                           # 文档
└── tests/                          # 单元测试

添加新功能

要向 KiCad MCP 服务器添加新功能，请按照以下步骤操作：

确定功能所属的类别（资源、工具或提示）。
在相应目录中创建新文件或修改现有文件。
更新 requirements.txt 和 main.py 以包含新功能。

故障排除

常见问题

问题：无法启动服务器。
- 解决方法：检查依赖项是否正确安装，并确保没有语法错误。
问题：与 KiCad 的连接失败。
- 解决方法：验证配置参数并确保 KiCad 正确安装。

更多故障排除步骤请参考故障排除指南。

完整文档

完整的文档可以在 GitHub Wiki 找到，包括详细的 API 文档和使用教程。

kicad-mcp