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