Kicad MCP Server

🚀 KiCAD 设计自动化协议 (MCP) 中文文档

KiCAD 设计自动化协议 (MCP) 提供了一种借助命令行接口控制 KiCAD 软件开展 PCB 设计的途径。该协议与 Claire（Claude）工具集成，支持用户通过自定义命令达成 PCB 设计的自动化，极大提升设计效率。

主要功能

• 创建、打开和保存 KiCAD 项目，方便项目的全生命周期管理。
• 管理 PCB 层和设计规则，确保设计符合规范。
• 自动化布线和组件布局，提高设计的准确性和一致性。
• 批量导出 Gerber 文件等设计文档，便于后续生产。

🚀 快速开始

KiCAD 设计自动化协议 (MCP) 为 PCB 设计自动化提供了强大支持。你可以通过以下步骤快速上手：

1. 了解协议的通信和命令结构。
2. 根据需求选择合适的命令进行 PCB 设计操作。
3. 参考实现细节进行服务器端和客户端的开发。

✨ 主要特性

• 项目管理：支持创建、打开、保存和关闭项目，实现项目的高效管理。
• PCB 设计：可设置板尺寸、管理层和修改层属性，满足多样化设计需求。
• 组件管理：能放置、批量放置、移动和旋转组件，灵活调整组件布局。
• 布线功能：可添加导线、过孔、创建差分对和定义网络类，完成复杂布线任务。

📦 安装指南

文档未提及安装步骤，暂不提供相关内容。

💻 使用示例

基础用法

# 创建新项目
import kicad_interface as ki

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

高级用法

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

📚 详细文档

协议结构

MCP 通信协议

1. 请求格式：JSON 格式命令包

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

2. 响应格式：JSON 格式结果包

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

3. 错误处理：

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

命令结构

命令分为以下几类：

• 项目管理
  • project_new：创建新项目
  • project_open：打开已有项目
  • project_save：保存当前项目
  • project_close：关闭项目
• PCB 设计
  • board_size：设置板尺寸
  • add_layer：添加新层
  • remove_layer：删除指定层
  • set_layer_properties：修改层属性
• 组件管理
  • component_place：放置组件
  • components_array：批量放置组件
  • move_component：移动组件位置
  • rotate_component：旋转组件方向
• 布线功能
  • route_trace：添加导线
  • add_via：添加过孔
  • create_differential_pair：创建差分对
  • set_net_class：定义网络类

🔧 技术细节

服务器端实现 (Node.js)

• 主要文件
  • kicad-server.ts：MCP 协议主服务
  • command_handler.ts：命令处理中心
• 功能模块
  • 命令解析与路由
  • 错误处理机制
  • 连接状态管理

客户端实现 (Python)

• 主要文件
  • kicad_interface.py：接口适配器
  • 各命令处理模块 (project.py, board.py, etc.)

📄 许可证

本项目采用 MIT 许可证，具体内容如下：

MIT License

Copyright (c) 2023 KiCAD-MCP 开发团队

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.

📞 联系方式

• 项目官网：https://github.com/kiCad-MCP
• 邮件联系：support@kicad-mcp.org
• 讨论论坛：Discussions Page

⚠️ 故障排除

常见问题

• 项目创建失败
  • 检查权限设置
  • 确保磁盘空间充足
• 组件无法放置
  • 核对组件库路径
  • 检查 footprint 定义
• 布线错误
  • 查看设计规则检查 (DRC)
  • 确认层配置正确

🤝 开发指南

贡献指南

欢迎社区贡献代码：

• 提交 ISSUE 报告问题
• Fork 仓库进行开发
• 创建 Pull Request