編集の要約なし |
編集の要約なし |
||
| (同じ利用者による、間の4版が非表示) | |||
| 1行目: | 1行目: | ||
== 概要 == | == 概要 == | ||
KiCad MCPサーバは、電子回路設計ソフトウェア KiCadをMCP (Model Context Protocol) 経由でAIアシスタントに接続するサーバである。<br> | |||
2026年7月時点では、KiCad 10.0がリリースされており、実装の対応範囲と保守状態を確認して選択する必要がある。<br> | |||
<br> | |||
主要な6つのMCPサーバは、以下の通りである。<br> | |||
<br> | <br> | ||
* lamaalrajih/kicad-mcp | * lamaalrajih/kicad-mcp | ||
*: | *: FastMCPとSWIGの軽量なPython実装である。 | ||
*: | *: <u>KiCad 9.0以降向けだが、2025年10月以降は開発停止状態である。</u> | ||
* mixelpixx/KiCAD-MCP-Server | * mixelpixx/KiCAD-MCP-Server | ||
*: | *: PythonとTypeScriptの活発なハイブリッド実装である。 | ||
*: | *: v2.3.1で122ツール、16カテゴリ、KiCad 10対応を提供する。 | ||
* Seeed-Studio/kicad-mcp-server | |||
*: 回路図、PCB、ネットリストの分析と検証を中心にした実装である。 | |||
* oaslananka/kicad-mcp-pro | |||
*: stdioとStreamable HTTP、uvx、npx、Tauriを組み合わせた統合型実装である。 | |||
* belaszalontai/kipilot-mcp | |||
*: KiCad 10の公式kicad-python IPCバインディングだけを利用するPCB中心の実装である。 | |||
* mixelpixx/Konnect | |||
*: KiCad 10専用、v0.2.0 BETAのRust製スタンドアロンMCPサーバである。 | |||
<br> | |||
MCPの安定仕様は2025年6月18日であり、JSON-RPC 2.0、MCPの基本プロトコル、サーバ機能の順に構成される。<br> | |||
ツール、リソース、プロンプトを通じて、AIから設計情報の参照、検証、限定的な変更を行える。<br> | |||
<br> | <br> | ||
KiCadのファイルは設計資産であるため、変更を許可する前にバックアップ、パス制限、利用者の承認を設定する。<br> | |||
<br> | <br> | ||
STDIOでは標準出力をログに使用せず、ログは標準エラー出力へ送る。<br> | |||
<br><br> | <br><br> | ||
== | == MCPサーバの比較 == | ||
下表は、2026年7月時点で比較対象として整理した従来の5サーバの比較である。Konnectは後述のサーバ6で扱う。<br> | |||
Starsとコミット日は調査時点の値であり、将来変化する。<br> | |||
<br> | <br> | ||
<center> | <center> | ||
| 32行目: | 36行目: | ||
|+ KiCAD MCPサーバの比較 | |+ KiCAD MCPサーバの比較 | ||
|- | |- | ||
! | ! 項目 !! lamaalrajih !! mixelpixx !! Seeed-Studio !! oaslananka !! belaszalontai | ||
|- | |- | ||
| | | リポジトリ || kicad-mcp || KiCAD-MCP-Server || kicad-mcp-server || kicad-mcp-pro || kipilot-mcp | ||
|- | |- | ||
| | | Stars || 487 || 1,560 || 65 || 28 || 3 | ||
|- | |- | ||
| | | 言語 || Python 100% || Python 84.3% + TypeScript 14% || Python + Jinja || Python主体 + TypeScript/JS/HTML/Rust || Python 100% | ||
|- | |- | ||
| | | ライセンス || MIT || MIT || MIT || MIT || README記載なし | ||
|- | |- | ||
| | | KiCad対応 || 9.0+ || 9.0+ / 10.0 || 8.0+、9/10推奨 || 9.x / 10.x || 10.xのみ | ||
|- | |- | ||
| | | ツール数 || 基本セット || 122 || 25 || プロファイルで可変 || 読み取り・ガード付き変更 | ||
|- | |- | ||
| | | 最新リリース || なし || v2.3.1 || なし || v3.25.0 || v0.1.1 | ||
|- | |- | ||
| | | リリース日 || 開発停止 || 2026-07-06 || 2026-05-22コミット || 2026-07-10 || 2026-05-14 | ||
|- | |- | ||
| | | 主な接続 || STDIO || STDIO || STDIO || STDIO / Streamable HTTP || STDIO | ||
|- | |- | ||
| | | 主用途 || 基本PCB操作 || 総合設計 || 分析・検証 || 総合設計・解析 || KiCad 10 PCB検査 | ||
|} | |} | ||
</center> | </center> | ||
<br><br> | <br><br> | ||
== | == MCPサーバの選択 == | ||
MCPサーバの選択は、KiCadのバージョン、変更を許可する範囲、クライアントの接続方式で決める。<br> | |||
<br> | |||
<center> | |||
{| class="wikitable" | |||
|+ ユースケース別の選択マトリクス | |||
! ユースケース !! 第一候補 !! 理由 !! 注意点 | |||
|- | |||
| KiCad 10で総合操作 || mixelpixx/KiCAD-MCP-Server || 122ツールとハイブリッドバックエンド || 開発版機能の確認が必要 | |||
|- | |||
| KiCad 10でPCBを安全に検査 || belaszalontai/kipilot-mcp || 公式IPC、変更は初期状態で無効 || KiCad GUIが必要 | |||
|- | |||
| 解析と検証を優先 || Seeed-Studio/kicad-mcp-server || 分析カテゴリが明確 || KiCadバンドルPython推奨 | |||
|- | |||
| リモートまたは複数クライアント || oaslananka/kicad-mcp-pro || Streamable HTTP対応 || 認証とポート保護が必要 | |||
|- | |||
| KiCad 9の既存環境 || lamaalrajih/kicad-mcp || 導入が簡単でFastMCP中心 || 2025-10以降開発停止 | |||
|} | |||
</center> | |||
<br> | <br> | ||
==== lamaalrajih/kicad-mcpを選択する場合 ==== | ==== lamaalrajih/kicad-mcpを選択する場合 ==== | ||
| 65行目: | 86行目: | ||
* Python開発環境に精通している場合 | * Python開発環境に精通している場合 | ||
* 既存のFastMCPベースのツールを統合したい場合 | * 既存のFastMCPベースのツールを統合したい場合 | ||
* KiCad 9.0を固定して運用できる場合 | |||
<br> | <br> | ||
==== mixelpixx/KiCAD-MCP-Serverを選択する場合 ==== | ==== mixelpixx/KiCAD-MCP-Serverを選択する場合 ==== | ||
| 71行目: | 93行目: | ||
* リアルタイムUI同期を使用したい場合 | * リアルタイムUI同期を使用したい場合 | ||
* Windows環境での使用を想定している場合 | * Windows環境での使用を想定している場合 | ||
* | * JLCPCB、Freerouting、3Dモデルを1つにまとめたい場合 | ||
* | * KiCad 10とKiCad 9の両方を扱いたい場合 | ||
<br> | |||
==== Seeed-Studio/kicad-mcp-serverを選択する場合 ==== | |||
* 設計レビュー、ネットリスト検査、検証を中心にしたい場合 | |||
* KiCadバンドルPythonで完全なpcbnew分析を行える場合 | |||
* 回路図とPCBのコード生成を分析処理と組み合わせたい場合 | |||
<br> | |||
==== oaslananka/kicad-mcp-proを選択する場合 ==== | |||
* Streamable HTTPでリモート接続したい場合 | |||
* TauriのGUIとPythonダッシュボードを使いたい場合 | |||
* BOM、DFM、製造レビュー、1次近似の解析をまとめたい場合 | |||
<br> | |||
==== belaszalontai/kipilot-mcpを選択する場合 ==== | |||
* KiCad 10専用環境で公式IPCだけを使いたい場合 | |||
* まず読み取りを行い、変更は明示的に許可したい場合 | |||
* PCBのアウトライン、ネット、パッド、トラック、ゾーンを検査したい場合 | |||
<br><br> | |||
== KiCAD 10の新機能とMCPへの影響 == | |||
KiCad 10.0.0は、2026年3月に公開された。<br> | |||
<br> | |||
<u>MCPサーバを選択する場合は、新しいファイル形式とIPC APIの対応範囲を分けて考える必要がある。</u><br> | |||
<br> | |||
==== 設計機能の変更 ==== | |||
* PCB Design Blocks | |||
*: 回路図とPCBの設計ブロックをライブラリ化できる。MCPでは再利用可能な設計単位の検索やレビューに影響する。 | |||
* ピン交換とゲート交換 | |||
*: 回路図とPCBの前方・後方アノテーションを伴う交換を扱える。 | |||
* グラフィカルDRC | |||
*: カスタムデザインルールをGUIで作成でき、従来のCustom Rules言語と互換性がある。 | |||
* タイムドメイン制約 | |||
*: 長さだけでなく時間領域の制約で配線を調整できる。 | |||
* Allegro、PADS、gEDA / Leptonインポーター | |||
*: 外部設計の取り込み後にMCPで解析、検証する流れを作れる。 | |||
<br> | |||
==== ファイル形式とライブラリ ==== | |||
KiCad 10では、回路図関連のフォーマットバージョンが <u>20260101</u> になった。<br> | |||
<br> | |||
派生シンボルライブラリは <u>.kicad_symdir</u> にシャーディングされる。<br> | |||
この変更を認識しないサーバでは、シンボル検索や回路図解析が失敗する。<br> | |||
<br> | |||
==== IPC APIの範囲 ==== | |||
IPC APIはKiCad 9から継続して、KiCad 10で拡張と安定化が進んだ。<br> | |||
<br> | |||
PCBエディタのIPC APIは利用できるが、回路図エディタのIPC APIはまだ開発中で利用できない。<br> | |||
<br> | |||
IPC APIは稼働中のKiCad GUIインスタンスとの通信が必要である。<br> | |||
ヘッドレス対応は、KiCad 11で予定されている。<br> | |||
<br> | |||
プロットとエクスポートはIPC APIの範囲外であるため、必要に応じて <u>kicad-cli</u> を使用する。<br> | |||
<br> | |||
==== MCPへの実務上の影響 ==== | |||
* 読み取り専用レビューは、KiCad 10の新形式を解釈できるサーバを使用する。 | |||
* 回路図変更はIPCだけに依存せず、SWIGまたは回路図専用実装の対応範囲を確認する。 | |||
* エクスポート処理はIPCツールと <u>kicad-cli</u> の役割を分離する。 | |||
* 変更前にプロジェクトを複製し、AIのツール呼び出しを承認制にする。 | |||
<br><br> | <br><br> | ||
| 81行目: | 158行目: | ||
<br> | <br> | ||
以下の例では、PythonとFastMCPを使用したKiCAD MCPサーバの基本構造を示している。<br> | 以下の例では、PythonとFastMCPを使用したKiCAD MCPサーバの基本構造を示している。<br> | ||
<br> | |||
<syntaxhighlight lang="python"> | <syntaxhighlight lang="python"> | ||
from fastmcp import FastMCP | from fastmcp import FastMCP | ||
| 126行目: | 204行目: | ||
<br> | <br> | ||
KiCAD MCPサーバを構築・運用する場合は、以下に示す事柄に注意する。<br> | KiCAD MCPサーバを構築・運用する場合は、以下に示す事柄に注意する。<br> | ||
<br> | |||
* KiCAD Python APIのバージョン互換性の確認 | * KiCAD Python APIのバージョン互換性の確認 | ||
* STDIOトランスポートでは標準出力 (stdout) にログを出力しない (JSON-RPC通信が破損する) | * STDIOトランスポートでは標準出力 (stdout) にログを出力しない (JSON-RPC通信が破損する) | ||
| 134行目: | 213行目: | ||
* ツールのバージョン管理とドキュメントの維持 | * ツールのバージョン管理とドキュメントの維持 | ||
<br> | <br> | ||
==== | ==== MCPサーバ環境のインストール ==== | ||
まず、システムの更新を行う。<br> | まず、システムの更新を行う。<br> | ||
<br> | |||
# RHEL | # RHEL | ||
sudo dnf update | sudo dnf update | ||
| 147行目: | 227行目: | ||
<br> | <br> | ||
次に、Linuxサーバに必要な基本環境をインストールする。<br> | 次に、Linuxサーバに必要な基本環境をインストールする。<br> | ||
<br> | |||
# RHEL | # RHEL | ||
sudo dnf install curl wget git gcc-c++ make python3 python3-pip | sudo dnf install curl wget git gcc-c++ make python3 python3-pip | ||
| 158行目: | 239行目: | ||
==== KiCADのインストール ==== | ==== KiCADのインストール ==== | ||
インストールが完了したら、KiCADのバージョンを確認する。<br> | インストールが完了したら、KiCADのバージョンを確認する。<br> | ||
<br> | |||
kicad-cli version | kicad-cli version | ||
<br> | <br> | ||
===== RHEL ===== | ===== RHEL ===== | ||
RHELでは、EPELリポジトリを有効化してKiCADをインストールする。<br> | RHELでは、EPELリポジトリを有効化してKiCADをインストールする。<br> | ||
<br> | |||
sudo dnf install epel-release | sudo dnf install epel-release | ||
sudo dnf install kicad kicad-doc kicad-packages3d | sudo dnf install kicad kicad-doc kicad-packages3d | ||
| 167行目: | 250行目: | ||
===== SUSE ===== | ===== SUSE ===== | ||
SUSEでは、公式リポジトリからKiCADをインストールする。<br> | SUSEでは、公式リポジトリからKiCADをインストールする。<br> | ||
<br> | |||
sudo zypper install kicad kicad-doc kicad-packages3d | sudo zypper install kicad kicad-doc kicad-packages3d | ||
<br> | <br> | ||
===== Debian ===== | ===== Debian ===== | ||
Debianでは、公式リポジトリからKiCADをインストールする。<br> | Debianでは、公式リポジトリからKiCADをインストールする。<br> | ||
<br> | |||
sudo apt install kicad kicad-doc-ja kicad-libraries | sudo apt install kicad kicad-doc-ja kicad-libraries | ||
<br> | <br> | ||
KiCADの最新版をインストールする場合は、公式PPAを使用する。<br> | KiCADの最新版をインストールする場合は、公式PPAを使用する。<br> | ||
sudo add-apt-repository ppa:kicad/kicad- | <br> | ||
sudo add-apt-repository ppa:kicad/kicad-9.0-releases | |||
sudo apt update | sudo apt update | ||
sudo apt install kicad | sudo apt install kicad | ||
| 181行目: | 267行目: | ||
===== Python仮想環境の作成 ===== | ===== Python仮想環境の作成 ===== | ||
プロジェクトディレクトリを作成して、Python仮想環境を設定する。<br> | プロジェクトディレクトリを作成して、Python仮想環境を設定する。<br> | ||
<br> | |||
mkdir -p ~/kicad-mcp-server | mkdir -p ~/kicad-mcp-server | ||
cd ~/kicad-mcp-server | cd ~/kicad-mcp-server | ||
| 187行目: | 274行目: | ||
<br> | <br> | ||
Pythonの仮想環境をアクティベートする。<br> | Pythonの仮想環境をアクティベートする。<br> | ||
<br> | |||
# Bash / Zshの場合 | # Bash / Zshの場合 | ||
source venv/bin/activate | source venv/bin/activate | ||
| 194行目: | 282行目: | ||
<br> | <br> | ||
必要なPythonライブラリをインストールする。<br> | 必要なPythonライブラリをインストールする。<br> | ||
<br> | |||
pip install fastmcp | pip install fastmcp | ||
<br> | <br> | ||
| 201行目: | 290行目: | ||
<br> | <br> | ||
まず、KiCAD Python APIの場所を確認する。<br> | まず、KiCAD Python APIの場所を確認する。<br> | ||
<br> | |||
# KiCadのPythonバインディングが使用できるかどうかを確認する | |||
# KiCadのPythonモジュール <u>pcbnew</u> を読み込み、Python API (実ファイル) のパスを表示する | |||
# 続いて、<code>GetBuildVersion()</code> 関数で対応するKiCadのビルドバージョンを表示する | |||
python3 -c "import pcbnew; print(pcbnew.__file__); print(pcbnew.GetBuildVersion())" | |||
# Pythonのモジュール検索パス <code>sys.path</code> を取得して、その中からパス名に <u>kicad</u> を含むものだけを抽出する | |||
# もし、<u>[]</u> (空のリスト) が表示される場合は、パス名に <u>kicad</u> を含む検索先がないという意味である | |||
python3 -c "import sys; print([p for p in sys.path if 'kicad' in p.lower()])" | python3 -c "import sys; print([p for p in sys.path if 'kicad' in p.lower()])" | ||
<br> | |||
<br> | <br> | ||
通常、以下に示すディレクトリにインストールされている。<br> | 通常、以下に示すディレクトリにインストールされている。<br> | ||
* RHEL / SUSE | * RHEL / SUSE | ||
*: /usr/lib64/python3.x/site-packages/ | *: /usr/lib64/python3.x/site-packages/pcbnew.py | ||
* Debian | * Debian | ||
*: /usr/lib/python3/dist-packages/pcbnew.py | *: /usr/lib/python3/dist-packages/pcbnew.py | ||
<br> | <br> | ||
仮想環境からアクセスできるように設定する。<br> | 仮想環境からアクセスできるように設定する。<br> | ||
<br> | |||
# RHEL / SUSE | # RHEL / SUSE | ||
ln -s /usr/lib64/python3.x/site-packages/pcbnew.so venv/lib/python3.x/site-packages/ | ln -s /usr/lib64/python3.x/site-packages/pcbnew.so venv/lib/python3.x/site-packages/ | ||
| 217行目: | 318行目: | ||
<br> | <br> | ||
または、~/.profileファイル等に環境変数 <code>PYTHONPATH</code> を設定する方法もある。<br> | または、~/.profileファイル等に環境変数 <code>PYTHONPATH</code> を設定する方法もある。<br> | ||
<br> | |||
<syntaxhighlight lang="sh"> | <syntaxhighlight lang="sh"> | ||
# ~/.profileファイル等 | # ~/.profileファイル等 | ||
| 228行目: | 330行目: | ||
<br> | <br> | ||
KiCAD Python APIが正常にインポートできるか確認する。<br> | KiCAD Python APIが正常にインポートできるか確認する。<br> | ||
<br> | |||
python3 -c "import pcbnew; print(pcbnew.Version())" | python3 -c "import pcbnew; print(pcbnew.Version())" | ||
<br> | <br> | ||
| 241行目: | 344行目: | ||
<br> | <br> | ||
設定ファイルの内容を編集する。<br> | 設定ファイルの内容を編集する。<br> | ||
<br> | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
| 263行目: | 367行目: | ||
Claude Desktopを再起動して、KiCAD MCPサーバが利用可能であることを確認する。<br> | Claude Desktopを再起動して、KiCAD MCPサーバが利用可能であることを確認する。<br> | ||
<br> | <br> | ||
==== | ===== OpenCodeからの接続 ===== | ||
OpenCodeでは、プロジェクトルートの <u>opencode.json</u> または <u>opencode.jsonc</u> に設定を記述する。<br> | |||
全体設定を使用する場合は、Linuxでは <u>~/.config/opencode/opencode.json</u> を使用するる。<br> | |||
<br> | |||
設定はトップレベルの <code>mcp</code> フィールドに記述する。<br> | |||
<br> | |||
設定例を以下に示す。<br> | |||
* <code>command</code> | |||
*: 実行ファイルと引数を1つの配列にまとめる。 | |||
* <code>environment</code> | |||
*: 環境変数を記述する。 | |||
<br> | <br> | ||
===== 主要な設定オプション ===== | <syntaxhighlight lang="json"> | ||
<center> | { | ||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"kicad-server": { | |||
"type": "local", | |||
"command": [ | |||
"/home/<ユーザ名>/kicad-mcp-server/venv/bin/python", | |||
"/home/<ユーザ名>/kicad-mcp-server/server.py" | |||
], | |||
"environment": { | |||
"PYTHONPATH": "/usr/lib64/python3.x/site-packages" | |||
}, | |||
"enabled": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
RHEL / SUSEでは、環境変数 <code>PYTHONPATH</code> を使用する。<br> | |||
Debianでは、<u>/usr/lib/python3/dist-packages</u> に置き換える。<br> | |||
<br> | |||
必要に応じて、<code>cwd</code> で作業ディレクトリを指定して、<code>timeout</code> で接続待ち時間を設定できる。<br> | |||
<br> | |||
設定後、以下に示すコマンドでMCPサーバ一覧を確認する。<br> | |||
<br> | |||
opencode mcp list | |||
<br> | |||
接続の詳細を確認する場合は、<code>opencode mcp debug <サーバ名></code> コマンドを実行する。<br> | |||
<br> | |||
詳しい仕様は、[https://opencode.ai/docs/mcp-servers/ OpenCode公式MCPサーバ設定]を参照すること。<br> | |||
<br><br> | |||
==== 設定 ==== | |||
KiCAD MCPサーバは、環境変数 または <u>.env</u> ファイルを使用して設定することができる。<br> | |||
<br> | |||
===== 主要な設定オプション ===== | |||
<center> | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! 環境変数 | ! 環境変数 !! 説明 !! 例 | ||
! 説明 | |||
! 例 | |||
|- | |- | ||
| KICAD_SEARCH_PATHS | | <code>KICAD_SEARCH_PATHS</code> || KiCADプロジェクトを検索するディレクトリ<br>(カンマ区切りのリスト) || ~/pcb<br>~/Electronics<br>~/Projects | ||
| KiCADプロジェクトを検索するディレクトリ<br>(カンマ区切りのリスト) | |||
| ~/pcb | |||
|- | |- | ||
| KICAD_USER_DIR | | <code>KICAD_USER_DIR</code> || デフォルトのKiCADユーザディレクトリを上書きする。 || ~/Documents/KiCadProjects | ||
| デフォルトのKiCADユーザディレクトリを上書きする。 | |||
| ~/Documents/KiCadProjects | |||
|- | |- | ||
| KICAD_APP_PATH | | <code>KICAD_APP_PATH</code> || デフォルトのKiCADアプリケーションパスを上書きする。 || /Applications/KiCad9/KiCad.app | ||
| デフォルトのKiCADアプリケーションパスを上書きする。 | |||
| /Applications/KiCad9/KiCad.app | |||
|} | |} | ||
</center> | </center> | ||
| 290行目: | 431行目: | ||
環境設定ファイル (.envファイル) を作成する。<br> | 環境設定ファイル (.envファイル) を作成する。<br> | ||
<br> | <br> | ||
. | <u>.env</u> ファイルは、KiCAD MCPサーバのプロジェクトルートディレクトリに配置する。<br> | ||
したがって、<u>main.py</u> ファイル や <u>.env.example</u> ファイルと同じ階層、kicad-mcpディレクトリ直下に配置することが標準的である。<br> | |||
<br> | <br> | ||
* Linux | * Linux | ||
| 301行目: | 442行目: | ||
KICAD_APP_PATH=/usr/bin/kicad | KICAD_APP_PATH=/usr/bin/kicad | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<br> | *: <br> | ||
* Winodws | * Winodws | ||
*: <syntaxhighlight lang="powershell"> | *: <syntaxhighlight lang="powershell"> | ||
| 312行目: | 453行目: | ||
<br> | <br> | ||
==== プロジェクト構造 ==== | ==== プロジェクト構造 ==== | ||
KiCAD | KiCAD MCPサーバは、以下に示すモジュール構造で構成されている。<br> | ||
<br> | <br> | ||
kicad-mcp/ | kicad-mcp/ | ||
| 336行目: | 477行目: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! ディレクトリ | ! ディレクトリ !! 説明 | ||
! 説明 | |||
|- | |- | ||
| kicad_mcp/resources/ | | kicad_mcp/resources/ || KiCADプロジェクトファイル、回路図、PCBレイアウト等のリソースを処理するハンドラを格納する。<br>これらのハンドラは、MCPクライアントからのリソース要求に応答する。 | ||
| KiCADプロジェクトファイル、回路図、PCBレイアウト等のリソースを処理するハンドラを格納する。<br>これらのハンドラは、MCPクライアントからのリソース要求に応答する。 | |||
|- | |- | ||
| kicad_mcp/tools/ | | kicad_mcp/tools/ || KiCADの操作を実行するツールのハンドラを格納する。<br>各ツールは特定の機能 (DRCの実行、ガーバーファイルの出力等) を提供する。 | ||
| KiCADの操作を実行するツールのハンドラを格納する。<br>各ツールは特定の機能 ( | |||
|- | |- | ||
| kicad_mcp/prompts/ | | kicad_mcp/prompts/ || AIアシスタントが使用するプロンプトテンプレートを格納する。<br>これらのテンプレートは、特定のタスクに対して適切なコンテキストを提供する。 | ||
| AIアシスタントが使用するプロンプトテンプレートを格納する。<br>これらのテンプレートは、特定のタスクに対して適切なコンテキストを提供する。 | |||
|- | |- | ||
| kicad_mcp/utils/ | | kicad_mcp/utils/ || ファイル操作、パスの検証、ログ処理等の共通ユーティリティ関数を格納する。 | ||
| ファイル操作、パスの検証、ログ処理等の共通ユーティリティ関数を格納する。 | |||
|- | |- | ||
| docs/ | | docs/ || APIドキュメント、使用例、開発ガイド等の詳細なドキュメントを格納する。 | ||
| APIドキュメント、使用例、開発ガイド等の詳細なドキュメントを格納する。 | |||
|- | |- | ||
| tests/ | | tests/ || 各モジュールのユニットテストおよび統合テストを格納する。 | ||
| 各モジュールのユニットテストおよび統合テストを格納する。 | |||
|} | |} | ||
</center> | </center> | ||
| 477行目: | 611行目: | ||
@mcp.tool() | @mcp.tool() | ||
def export_gerber(kicad_pcb_path: str, output_dir: str) -> str: | def export_gerber(kicad_pcb_path: str, output_dir: str) -> str: | ||
""" | """ガーバーファイルを出力する""" | ||
try: | try: | ||
board = pcbnew.LoadBoard(kicad_pcb_path) | board = pcbnew.LoadBoard(kicad_pcb_path) | ||
| 509行目: | 643行目: | ||
plot_controller.ClosePlot() | plot_controller.ClosePlot() | ||
return f" | return f"ガーバーファイルを {output_dir} に出力しました" | ||
except Exception as e: | except Exception as e: | ||
return f"エラー: {str(e)}" | return f"エラー: {str(e)}" | ||
| 584行目: | 718行目: | ||
*: 基板外形の寸法を取得 | *: 基板外形の寸法を取得 | ||
* export_gerber | * export_gerber | ||
*: | *: ガーバーファイルの出力 | ||
<br> | <br> | ||
==== Systemdサービスファイルの作成 ==== | ==== Systemdサービスファイルの作成 ==== | ||
KiCAD | KiCAD MCPサーバをシステムサービスとして常時起動させる場合、Systemdユニットファイルを作成する。<br> | ||
<br> | <br> | ||
sudo vi /etc/systemd/system/kicad-mcp-server.service | sudo vi /etc/systemd/system/kicad-mcp-server.service | ||
| 627行目: | 761行目: | ||
<br> | <br> | ||
サービスの状態を確認する。<br> | サービスの状態を確認する。<br> | ||
<br> | |||
sudo systemctl status kicad-mcp-server | sudo systemctl status kicad-mcp-server | ||
<br> | <br> | ||
ログを確認する。<br> | ログを確認する。<br> | ||
<br> | |||
sudo journalctl -u kicad-mcp-server -f | sudo journalctl -u kicad-mcp-server -f | ||
<br> | <br> | ||
| 668行目: | 804行目: | ||
===== 入力データのバリデーション ===== | ===== 入力データのバリデーション ===== | ||
ツールのパラメータに対して、適切なバリデーションを行う。<br> | ツールのパラメータに対して、適切なバリデーションを行う。<br> | ||
<br> | |||
<syntaxhighlight lang="python"> | <syntaxhighlight lang="python"> | ||
import re | import re | ||
| 694行目: | 831行目: | ||
<br> | <br> | ||
<syntaxhighlight lang="sh"> | <syntaxhighlight lang="sh"> | ||
# backup-kicad-projects.shファイル | |||
#!/usr/bin/env sh | #!/usr/bin/env sh | ||
BACKUP_DIR="/var/backups/kicad-projects" | BACKUP_DIR="/var/backups/kicad-projects" | ||
DATE=$(date +%Y%m%d_%H%M%S) | DATE=$(date +%Y%m%d_%H%M%S) | ||
PROJECT_DIR="/home/ | PROJECT_DIR="/home/<ユーザ名>/kicad-projects" | ||
# バックアップディレクトリの作成 | # バックアップディレクトリの作成 | ||
| 714行目: | 852行目: | ||
<br> | <br> | ||
バックアップスクリプトを実行可能にする。<br> | バックアップスクリプトを実行可能にする。<br> | ||
<br> | |||
chmod u+x backup-kicad-projects.sh | chmod u+x backup-kicad-projects.sh | ||
<br> | <br> | ||
cronジョブとして設定する。<br> | cronジョブとして設定する。<br> | ||
<br> | |||
crontab -e | crontab -e | ||
<br> | <br> | ||
| 743行目: | 883行目: | ||
* STDIOトランスポートの場合、標準出力にログを出力していないか確認する。 | * STDIOトランスポートの場合、標準出力にログを出力していないか確認する。 | ||
<br> | <br> | ||
===== | ===== ガーバーファイルの出力に失敗する ===== | ||
* 出力ディレクトリの書き込み権限があるか確認する。 | * 出力ディレクトリの書き込み権限があるか確認する。 | ||
* ディスク容量が十分にあるか確認する。 | * ディスク容量が十分にあるか確認する。 | ||
| 802行目: | 942行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<br> | <br> | ||
==== | ==== 参考情報 ==== | ||
* [https://www.kicad.org/ KiCAD公式サイト] | * [https://www.kicad.org/ KiCAD公式サイト] | ||
* [https://docs.kicad.org/ KiCADドキュメント] | * [https://docs.kicad.org/ KiCADドキュメント] | ||
| 813行目: | 953行目: | ||
==== 概要 ==== | ==== 概要 ==== | ||
mixelpixx/KiCAD-MCP-Serverは、TypeScriptとPythonのハイブリッド実装による高度なKiCAD MCPサーバである。<br> | mixelpixx/KiCAD-MCP-Serverは、TypeScriptとPythonのハイブリッド実装による高度なKiCAD MCPサーバである。<br> | ||
MCP 2025-06- | MCP 2025-06-18仕様に対応し、122のツールを16カテゴリに分け、包括的なエラーハンドリングとクロスプラットフォーム対応を提供する。<br> | ||
<br> | <br> | ||
===== 主要な機能 ===== | ===== 主要な機能 ===== | ||
* | * 122のツール | ||
*: JSON Schemaによる完全なバリデーション | *: JSON Schemaによる完全なバリデーション | ||
* 8のリソース | * 8のリソース | ||
| 831行目: | 971行目: | ||
===== アーキテクチャ ===== | ===== アーキテクチャ ===== | ||
KiCAD-MCP-Serverは、3層構造で実装されている。<br> | KiCAD-MCP-Serverは、3層構造で実装されている。<br> | ||
<br> | |||
* TypeScriptサーバ層 (src/) | * TypeScriptサーバ層 (src/) | ||
*: MCP 2025-06-18プロトコルの実装、Pythonサブプロセスのライフサイクル管理、メッセージルーティング、ロギングとエラーリカバリ | *: MCP 2025-06-18プロトコルの実装、Pythonサブプロセスのライフサイクル管理、メッセージルーティング、ロギングとエラーリカバリ | ||
| 839行目: | 980行目: | ||
<br> | <br> | ||
===== 動作要件 ===== | ===== 動作要件 ===== | ||
* KiCAD 9. | * KiCAD 9.0以降 または KiCad 10.0 | ||
*: Python API (pcbnew) を含む | *: Python API (pcbnew) を含む | ||
* Node.js 18以上 | * Node.js 18以上 | ||
* Python 3. | * Python 3.9以上 | ||
* 必須Pythonパッケージ | * 必須Pythonパッケージ | ||
*: kicad-python (kipy) >= 0.5.0 (IPC API対応、オプション) | *: kicad-python (kipy) >= 0.5.0 (IPC API対応、オプション) | ||
| 855行目: | 996行目: | ||
==== インストール ==== | ==== インストール ==== | ||
===== Linux ===== | ===== Linux ===== | ||
KiCAD 9. | KiCAD 9.0以降および必要な依存関係をインストールする。<br> | ||
<br> | |||
# RHEL | # RHEL | ||
sudo dnf install epel-release | sudo dnf install epel-release | ||
| 869行目: | 1,011行目: | ||
<br> | <br> | ||
Node.jsをインストールする。<br> | Node.jsをインストールする。<br> | ||
<br> | |||
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - | curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - | ||
| 880行目: | 1,023行目: | ||
sudo apt install nodejs | sudo apt install nodejs | ||
<br> | <br> | ||
KiCAD-MCP-Serverのリポジトリをクローンしてビルドする。<br> | |||
<br> | |||
git clone https://github.com/mixelpixx/KiCAD-MCP-Server.git | git clone https://github.com/mixelpixx/KiCAD-MCP-Server.git | ||
cd KiCAD-MCP-Server | cd KiCAD-MCP-Server | ||
| 889行目: | 1,033行目: | ||
<br> | <br> | ||
インストールを検証する。<br> | インストールを検証する。<br> | ||
<br> | |||
python3 -c "import pcbnew; print(pcbnew.GetBuildVersion())" | python3 -c "import pcbnew; print(pcbnew.GetBuildVersion())" | ||
<br> | <br> | ||
===== Windows | ===== Windows ===== | ||
自動セットアップスクリプトを使用する。<br> | 自動セットアップスクリプトを使用する。<br> | ||
<br> | |||
git clone https://github.com/mixelpixx/KiCAD-MCP-Server.git | git clone https://github.com/mixelpixx/KiCAD-MCP-Server.git | ||
cd KiCAD-MCP-Server | cd KiCAD-MCP-Server | ||
| 899行目: | 1,045行目: | ||
<br> | <br> | ||
このスクリプトは以下の処理を自動的に実行する。<br> | このスクリプトは以下の処理を自動的に実行する。<br> | ||
<br> | |||
* KiCADのインストール検出 | * KiCADのインストール検出 | ||
* 前提条件の検証 | * 前提条件の検証 | ||
| 917行目: | 1,064行目: | ||
<br> | <br> | ||
設定内容は以下の通りである。<br> | 設定内容は以下の通りである。<br> | ||
<br> | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
| 935行目: | 1,083行目: | ||
プラットフォーム別の環境変数 <code>PYTHONPATH</code> の設定は、以下の通りである。<br> | プラットフォーム別の環境変数 <code>PYTHONPATH</code> の設定は、以下の通りである。<br> | ||
* Linux (RHEL / SUSE) | * Linux (RHEL / SUSE) | ||
*: /usr/lib64/python3.x/site-packages | *: <u>/usr/lib64/python3.x/site-packages</u> | ||
* Linux (Debian) | * Linux (Debian) | ||
*: /usr/lib/kicad/lib/python3/dist-packages | *: <u>/usr/lib/kicad/lib/python3/dist-packages</u> | ||
* Windows | * Windows | ||
*: C:\Program Files\KiCad\9.0\lib\python3\dist-packages | *: KiCad 9の場合 : <u>C:\Program Files\KiCad\9.0\lib\python3\dist-packages</u> | ||
*: KiCad 10の場合 : <u>C:\Program Files\KiCad\10.0\lib\python3\dist-packages</u> | |||
<br> | <br> | ||
===== | ===== OpenCode ===== | ||
OpenCodeでは、プロジェクトルートの <u>opencode.json</u> または <u>opencode.jsonc</u> にMCPサーバを設定する。<br> | |||
Linuxで全プロジェクトから使用する場合は、<u>~/.config/opencode/opencode.json</u> に設定する。<br> | |||
<br> | <br> | ||
Claude Desktopとは異なり、OpenCodeではトップレベルの <code>mcp</code> フィールドを使用する。<br> | |||
実行ファイルと引数は <code>command</code> 配列にまとめ、環境変数は <code>environment</code> に記述する。<br> | |||
<br> | <br> | ||
設定例を以下に示す。<br> | |||
<br> | <br> | ||
= | <syntaxhighlight lang="json"> | ||
{ | |||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"kicad": { | |||
"type": "local", | |||
"command": [ | |||
"node", | |||
"/path/to/KiCAD-MCP-Server/dist/index.js" | |||
], | |||
"environment": { | |||
"PATH": "/usr/bin:/usr/local/bin:/home/user/.local/bin", | |||
"PYTHONPATH": "/usr/lib64/python3.x/site-packages", | |||
"KICAD_PYTHON": "/usr/bin/python3" | |||
}, | |||
"enabled": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | <br> | ||
* グローバルMCPサーバとして追加する場合 (全てのプロジェクトで利用可能) | Windowsでは、<code>command</code> 配列の実行ファイルとパスを環境に合わせて変更する。<br> | ||
*: ~/.cursor/mcp.jsonファイルを編集する。 | <br> | ||
*: <syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | |||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"kicad": { | |||
"type": "local", | |||
"command": [ | |||
"node", | |||
"C:/path/to/KiCAD-MCP-Server/dist/index.js" | |||
], | |||
"environment": { | |||
"PYTHONPATH": "C:/Program Files/KiCad/10.0/lib/python3/dist-packages", | |||
"KICAD_PYTHON": "C:/Program Files/KiCad/10.0/bin/python.exe" | |||
}, | |||
"enabled": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
設定後、<code>opencode mcp list</code> コマンドを実行して、サーバが一覧に表示されることを確認する。<br> | |||
接続の詳細を確認する場合は、<code>opencode mcp debug kicad</code> コマンドを実行する。<br> | |||
<br> | |||
詳しい仕様は、[https://opencode.ai/docs/mcp-servers/ OpenCode公式MCPサーバ設定]を参照すること。<br> | |||
<br> | |||
===== Cline (VSCode) ===== | |||
Clineの設定ファイルを編集する。<br> | |||
<br> | |||
* ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json | |||
<br> | |||
設定内容は、Claude Desktopと同じフォーマットを使用する。<br> | |||
<br> | |||
===== Claude Code ===== | |||
Claude Codeは、カレントディレクトリ内のMCPサーバを自動的に検出するため、追加の設定は不要である。<br> | |||
<br> | |||
===== Cursor ===== | |||
Cursorでは、2つの方法でMCPサーバを追加できる。<br> | |||
<br> | |||
* グローバルMCPサーバとして追加する場合 (全てのプロジェクトで利用可能) | |||
*: ~/.cursor/mcp.jsonファイルを編集する。 | |||
*: <syntaxhighlight lang="json"> | |||
{ | { | ||
"mcpServers": { | "mcpServers": { | ||
| 965行目: | 1,172行目: | ||
"args": ["C:/path/to/kicad-mcp/dist/index.js"], | "args": ["C:/path/to/kicad-mcp/dist/index.js"], | ||
"env": { | "env": { | ||
"PYTHONPATH": "C:/Program Files/KiCad/10.0/lib/python3/dist-packages", | |||
"DEBUG": "mcp:*" | "DEBUG": "mcp:*" | ||
}, | }, | ||
| 975行目: | 1,182行目: | ||
*: <br> | *: <br> | ||
* プロジェクト固有のMCPサーバとして追加する場合 | * プロジェクト固有のMCPサーバとして追加する場合 | ||
*: プロジェクトディレクトリに .cursor/mcp. | *: プロジェクトディレクトリに <u>.cursor/mcp.json</u> ファイルを作成 | ||
<br> | <br> | ||
設定後、[Cursor Settings] - [MCP]で更新ボタンを押下する。<br> | 設定後、[Cursor Settings] - [MCP]で更新ボタンを押下する。<br> | ||
<br> | <br> | ||
==== 利用可能なツール ==== | ==== 利用可能なツール ==== | ||
KiCAD-MCP- | KiCAD-MCP-Server v2.3.1は122のツールを16カテゴリに分類している。<br> | ||
<br> | <br> | ||
===== | <center> | ||
* | {| class="wikitable" | ||
*: | |+ v2.3.1の122ツール内訳 | ||
* | ! カテゴリ !! ツール数 !! 内容 | ||
*: | |- | ||
* | | Project Management || 5 || プロジェクトの作成、読込、保存、情報管理 | ||
*: | |- | ||
* | | Board Operations || 12 || 基板外形、レイヤー、表示、ボード属性 | ||
*: | |- | ||
| Component Management || 16 || 部品配置、移動、回転、整列、属性 | |||
|- | |||
| Routing || 13 || ネット、配線、ビア、差動対、ゾーン | |||
|- | |||
| Schematic || 27 || 動的シンボルロードと最大10,000シンボル規模の処理 | |||
|- | |||
| Design Rules / DRC || 8 || デザインルールとDRC | |||
|- | |||
| Export || 8 || ガーバー、PDF、SVG、3D、BOM等 | |||
|- | |||
| Footprint Libraries || 4 || フットプリントライブラリ検索 | |||
|- | |||
| Symbol Libraries || 4 || シンボルライブラリ検索 | |||
|- | |||
| Footprint Creator || 4 || フットプリント生成 | |||
|- | |||
| Symbol Creator || 4 || シンボル生成 | |||
|- | |||
| Datasheet || 2 || データシート処理 | |||
|- | |||
| JLCPCB Integration || 5 || 250万以上の部品情報との統合 | |||
|- | |||
| Freerouting Autorouter || 4 || Freerouting自動配線 | |||
|- | |||
| UI Management || 2 || KiCad UIの状態と起動 | |||
|- | |||
| Router / Discovery || 3 || ルータとサーバ探索 | |||
|} | |||
</center> | |||
<br> | |||
===== v2.3.1の追加機能 ===== | |||
* <u>import_eagle_schematic</u> | |||
*: Eagleの <u>.sch</u> 回路図をインポートする。 | |||
* <u>add_component_3d_model</u> | |||
*: 部品へ3Dモデルを追加する。 | |||
* <u>remove_component_3d_model</u> | |||
*: 部品から3Dモデルを削除する。 | |||
* 対話型再読み込み | |||
*: Windowsでは、環境変数 <code>KICAD_INTERACTIVE_SCHEMATIC=1</code> を設定する。 | |||
* KiCad 10互換性 | |||
*: <u>kicad_symdir</u>、レジストリ経由のインストール検出、フォーマットバージョン <u>20260101</u> に対応する。 | |||
<br> | <br> | ||
===== | ===== Konnectの位置付け ===== | ||
Konnectは、mixelpixx/KiCAD-MCP-Serverの後継として公開されたKiCad 10専用の実装である。<br> | |||
<br> | |||
詳細な導入手順、対応範囲、配布物の違いは、[[#サーバ6 : mixelpixx/Konnect|サーバ6 : mixelpixx/Konnect]]を参照する。<br> | |||
<br> | |||
===== ツールカテゴリの概要 ===== | |||
v2.3.1では、122のツールが16カテゴリに分類されている。<br> | |||
<br> | |||
v2.1.0-alpha時点の内部インベントリでは137ツールが記録されていたが、その後のルーティング整理と統合により122に落ち着いた。<br> | |||
更に、未リリース部 (Unreleased) で7ツールの追加が進められている。<br> | |||
<br> | <br> | ||
= | <center> | ||
{| class="wikitable" | |||
|+ mixelpixx/KiCAD-MCP-Server v2.3.1 のツールカテゴリ | |||
|- | |||
! カテゴリ !! ツール数 !! 主な内容 | |||
|- | |||
| Project Management || 5 || プロジェクト作成、保存、メタデータ | |||
|- | |||
| Board Operations || 12 || ボードサイズ、外形、レイヤー、マウンティングホール、テキスト | |||
|- | |||
| Component Management || 16 || 配置、移動、回転、編集、配列、整列、複製 | |||
|- | |||
| Routing || 13 || トレース、ビア、ネット、ネットクラス、銅箔ポア、差動ペア | |||
|- | |||
| Schematic || 27 || 回路図作成、配線、動的シンボルロード (約10,000シンボル) | |||
|- | |||
| Design Rules / DRC || 8 || DRC設定、取得、実行、違反レポート | |||
|- | |||
| Export || 8 || ガーバー、PDF、SVG、3D (STEP/VRML)、BOM | |||
|- | |||
| Footprint Libraries || 4 || フットプリントライブラリの一覧、検索、詳細取得 | |||
|- | |||
| Symbol Libraries || 4 || シンボルライブラリの操作 | |||
|- | |||
| Footprint Creator || 4 || カスタムフットプリント作成 | |||
|- | |||
| Symbol Creator || 4 || カスタムシンボル作成 | |||
|- | |||
| Datasheet || 2 || データシート関連 | |||
|- | |||
| JLCPCB Integration || 5 || JLCPCB部品データベース (250万以上の部品) | |||
|- | |||
| Freerouting Autorouter || 4 || Freerouting連携 (Docker/Podman経由) | |||
|- | |||
| UI Management || 2 || KiCad UIの起動、検出 | |||
|- | |||
| Router / Discovery || 3 || バックエンド探索、IPC/SWIG自動切り替え | |||
|} | |||
</center> | |||
<br> | |||
以下に、主要カテゴリの代表的なツールを示す。<br> | |||
<br> | <br> | ||
<u>各カテゴリの全ツールはリポジトリのREADMEを参照すること。</u><br> | |||
<br> | <br> | ||
===== | ===== Project Management (5ツール) ===== | ||
* | * create_project | ||
*: | *: 新しいKiCADプロジェクトを初期化する | ||
* | * open_project | ||
*: | *: 既存のプロジェクトファイルを読み込む | ||
* | * save_project | ||
*: | *: 現在のプロジェクト状態を保存する | ||
* | * get_project_info | ||
*: | *: プロジェクトのメタデータを取得する | ||
<br> | <br> | ||
===== | ===== Board Operations (12ツール) ===== | ||
* | * set_board_size | ||
*: | *: PCBの寸法を設定する | ||
* | * add_board_outline | ||
*: | *: ボードエッジを作成する (矩形、円形、ポリゴン) | ||
* | * add_layer | ||
*: | *: レイヤースタックにカスタムレイヤーを追加する | ||
* | * set_active_layer | ||
*: | *: 作業レイヤーを切り替える | ||
* get_layer_list | |||
*: 全てのボードレイヤーをリストする | |||
* get_board_info | |||
*: ボードのプロパティを取得する | |||
* get_board_2d_view | |||
*: ボードのプレビュー画像を生成する | |||
* add_mounting_hole | |||
*: マウンティングホールを配置する | |||
* add_board_text | |||
*: テキスト注釈を追加する | |||
<br> | <br> | ||
===== | ===== Component Management (16ツール) ===== | ||
* | * place_component | ||
*: | *: フットプリントを指定して単一のコンポーネントを配置する | ||
* | * move_component | ||
*: | *: 既存のコンポーネントを再配置する | ||
* | * rotate_component | ||
*: | *: コンポーネントを指定角度で回転する | ||
* | * delete_component | ||
*: | *: ボードからコンポーネントを削除する | ||
* | * edit_component | ||
*: | *: コンポーネントのプロパティを変更する | ||
* get_component_properties | |||
*: コンポーネントの詳細を照会する | |||
* get_component_list | |||
*: 配置された全てのコンポーネントをリストする | |||
* place_component_array | |||
*: コンポーネントのグリッド/パターンを作成する | |||
* align_components | |||
*: 複数のコンポーネントを整列する | |||
* duplicate_component | |||
*: 既存のコンポーネントをコピーする | |||
<br> | <br> | ||
===== | ===== Routing (13ツール) ===== | ||
* create_schematic | * add_net | ||
*: 新しい回路図を初期化する | *: 電気ネットを作成する | ||
* load_schematic | * route_trace | ||
*: 既存の回路図を開く | *: 銅箔トレースをルーティングする | ||
* add_schematic_component | * add_via | ||
*: レイヤー遷移用のビアを配置する | |||
* delete_trace | |||
*: トレースを削除する | |||
* get_nets_list | |||
*: 全てのネットをリストする | |||
* create_netclass | |||
*: ルール付きのネットクラスを定義する | |||
* add_copper_pour | |||
*: 銅箔ゾーン/ポアを作成する | |||
* route_differential_pair | |||
*: 差動信号をルーティングする | |||
<br> | |||
===== Schematic (27ツール) ===== | |||
v2.1.0以降に拡張された回路図機能は、約10,000のKiCadシンボルへ動的アクセスを提供する。<br> | |||
代表ツールを以下に示す。<br> | |||
* create_schematic | |||
*: 新しい回路図を初期化する | |||
* load_schematic | |||
*: 既存の回路図を開く | |||
* add_schematic_component | |||
*: シンボルを配置する | *: シンボルを配置する | ||
* add_schematic_wire | * add_schematic_wire | ||
*: コンポーネントピンを接続する | *: コンポーネントピンを接続する | ||
* import_eagle_schematic | |||
*: Eagleの <code>.sch</code> ファイルをインポートする (v2.3.1新機能) | |||
* list_schematic_libraries | * list_schematic_libraries | ||
*: シンボルライブラリをリストする | *: シンボルライブラリをリストする | ||
| 1,098行目: | 1,383行目: | ||
*: 回路図PDFをエクスポートする | *: 回路図PDFをエクスポートする | ||
<br> | <br> | ||
===== | ===== Design Rules / DRC (8ツール) ===== | ||
* | * set_design_rules | ||
*: | *: DRCパラメータを設定する | ||
* | * get_design_rules | ||
*: | *: 現在のルールを取得する | ||
<br> | * run_drc | ||
==== | *: デザインルールチェックを実行する | ||
* get_drc_violations | |||
*: DRCエラーレポートを取得する | |||
<br> | |||
===== Export (8ツール) ===== | |||
* export_gerber | |||
*: ガーバー製造ファイルを生成する | |||
* export_pdf | |||
*: PDFドキュメントをエクスポートする | |||
* export_svg | |||
*: SVGベクターグラフィックスを作成する | |||
* export_3d | |||
*: 3Dモデルを生成する (STEP/VRML) | |||
* export_bom | |||
*: 部品表を作成する | |||
<br> | <br> | ||
===== Footprint Libraries / Symbol Libraries (各4ツール) ===== | |||
* | * list_libraries | ||
* | *: 利用可能なフットプリントライブラリをリストする | ||
* | * search_footprints | ||
* | *: フットプリントを検索する | ||
* list_library_footprints | |||
*: ライブラリ内のフットプリントをリストする | |||
* | * get_footprint_info | ||
* | *: フットプリントの詳細を取得する | ||
* | <br> | ||
* | ===== Footprint Creator / Symbol Creator (各4ツール) ===== | ||
カスタムフットプリント、カスタムシンボルを作成するツール群である。<br> | |||
<br> | |||
===== Datasheet (2ツール) ===== | |||
データシートの取得、参照に関するツールである。<br> | |||
<br> | <br> | ||
===== JLCPCB Integration (5ツール) ===== | |||
JLCPCBの部品データベース (250万以上の部品) と直接統合し、部品検索やBOM生成を自動化する。<br> | |||
デュアルモードアーキテクチャにより、ローカルとリモートの両方のシンボルライブラリを検索できる。<br> | |||
<br> | <br> | ||
===== Freerouting Autorouter (4ツール) ===== | |||
FreeroutingオートルータをDocker/Podman経由で呼び出し、Specctra DSN形式のラウンドトリップで自動配線を実行する。<br> | |||
v2.2.x系列で統合された機能である。<br> | |||
<br> | <br> | ||
= | ===== 3Dモデル関連 (v2.3.1新機能) ===== | ||
==== | * add_component_3d_model | ||
*: コンポーネントに3Dモデルを追加する | |||
* remove_component_3d_model | |||
*: コンポーネントから3Dモデルを削除する | |||
<br> | <br> | ||
===== | ===== UI Management (2ツール) ===== | ||
* check_kicad_ui | |||
*: KiCADが実行中かチェックする | |||
* launch_kicad_ui | |||
*: KiCADアプリケーションを起動する | |||
<br> | <br> | ||
===== | ===== Router / Discovery (3ツール) ===== | ||
バックエンドの探索、IPCとSWIGの自動切り替え、ルーティング制御を担う。<br> | |||
<br> | <br> | ||
= | 開発モードは、環境変数 <code>KICAD_MCP_DEV=1</code> で有効になる。<br> | ||
<br> | <br> | ||
=== | ==== リソース ==== | ||
KiCAD | KiCAD-MCP-Serverは、8つのリソースを提供し、プロジェクト状態への読み取り専用アクセスを提供する。<br> | ||
<br> | <br> | ||
* kicad://project/current/info | |||
*: プロジェクトのメタデータ | |||
* kicad://project/current/board | |||
*: ボードのプロパティ | |||
* kicad://project/current/components | |||
*: コンポーネントリスト (JSON形式) | |||
* kicad://project/current/nets | |||
*: 電気ネット | |||
* kicad://project/current/layers | |||
*: レイヤースタック設定 | |||
* kicad://project/current/design-rules | |||
*: 現在のDRC設定 | |||
* kicad://project/current/drc-report | |||
*: デザインルール違反 | |||
* kicad://board/preview.png | |||
*: ボードビジュアライゼーション (PNG形式) | |||
<br> | |||
これらのリソースを使用することにより、AIアシスタントはツールを実行せずにプロジェクトの状態を照会できる。<br> | |||
<br> | <br> | ||
==== IPC対応コマンド ==== | 使用例を以下に示す。<br> | ||
<br> | |||
* route_trace | # 現在のコンポーネントリストを表示する | ||
*: トレースのルーティング | 現在のコンポーネントリストを表示してください。 | ||
* add_via | |||
*: ビアの配置 | # 現在のデザインルールを確認する | ||
* place_component | 現在のデザインルールは何ですか? | ||
*: コンポーネントの配置 | |||
* move_component | # ボードプレビューを表示する | ||
*: コンポーネントの移動 | ボードのプレビューを表示してください。 | ||
* delete_component | |||
*: コンポーネントの削除 | # 全ての電気ネットをリストする | ||
* add_copper_pour | 全ての電気ネットをリストしてください。 | ||
*: 銅箔ポアの追加 | <br> | ||
* refill_zones | ==== 使用例 ==== | ||
*: ゾーンの再塗りつぶし | ===== 基本的なPCB設計ワークフロー ===== | ||
ドキュメントフォルダに「LEDBoard」という名前の新しいKiCADプロジェクトを作成してください。 | |||
ボードサイズを50mm x 50mmに設定して、矩形の外形線を追加してください。 | |||
各コーナーにマウンティングホールを配置してください。エッジから3mm、直径3mmです。 | |||
フロントシルクスクリーン上の位置x=25mm、y=45mmに「LED Controller v1.0」というテキストを追加してください。 | |||
<br> | |||
===== コンポーネント配置 ===== | |||
フットプリントLED_SMD:LED_0805_2012Metricを使用して、位置x=10mm、y=10mmにLEDを配置してください。 | |||
位置x=20mm、y=20mmから始まる4つの抵抗器 (R1-R4) のグリッドを5mm間隔で作成してください。 | |||
全ての抵抗器を水平に整列して、均等に配置してください。 | |||
<br> | |||
===== ルーティング ===== | |||
「LED1」という名前のネットを作成して、R1のパッド2からLED1のアノードまで0.3mmのトレースをルーティングしてください。 | |||
ボード全体を覆う底面レイヤーのGND用の銅箔ポアを追加してください。 | |||
USB_PとUSB_Nのための差動ペアを0.2mm幅と0.15mmギャップで作成してください。 | |||
<br> | |||
===== デザイン検証 ===== | |||
0.15mmのクリアランスと0.2mmの最小トラック幅のデザインルールを設定してください。 | |||
デザインルールチェックを実行して、違反がないか確認してください。 | |||
fabricationフォルダにガーバーファイルをエクスポートしてください。 | |||
<br> | |||
==== IPC API統合 (実験的) ==== | |||
KiCAD 9.0で導入されたIPC APIを使用することにより、リアルタイムUI同期が可能になる。<br> | |||
<br> | |||
==== IPC APIの有効化 ==== | |||
KiCADで IPC APIを有効化する。<br> | |||
<br> | |||
[設定]メニューバー - [設定...]メニュー - [プラグイン] - [KiCad APIを有効にする]チェックボックスにチェックを入力する。<br> | |||
<br> | |||
==== IPC対応コマンド ==== | |||
以下に示すコマンドがIPC APIに対応している。<br> | |||
<br> | |||
* route_trace | |||
*: トレースのルーティング | |||
* add_via | |||
*: ビアの配置 | |||
* place_component | |||
*: コンポーネントの配置 | |||
* move_component | |||
*: コンポーネントの移動 | |||
* delete_component | |||
*: コンポーネントの削除 | |||
* add_copper_pour | |||
*: 銅箔ポアの追加 | |||
* refill_zones | |||
*: ゾーンの再塗りつぶし | |||
* add_board_outline | * add_board_outline | ||
*: ボード外形の追加 | *: ボード外形の追加 | ||
| 1,189行目: | 1,534行目: | ||
*: マウンティングホールの追加 | *: マウンティングホールの追加 | ||
<br> | <br> | ||
==== ハイブリッドバックエンド ==== | ==== ハイブリッドバックエンド ==== | ||
KiCAD-MCP-Serverは、IPC APIとSWIG APIのハイブリッドバックエンドを実装している。<br> | KiCAD-MCP-Serverは、IPC APIとSWIG APIのハイブリッドバックエンドを実装している。<br> | ||
* IPC APIが利用可能な場合 | <br> | ||
*: リアルタイムUI同期を使用 | * IPC APIが利用可能な場合 | ||
* IPC APIが利用できない場合 | *: リアルタイムUI同期を使用 | ||
*: SWIG APIにフォールバック | * IPC APIが利用できない場合 | ||
<br> | *: SWIG APIにフォールバック | ||
この実装により、IPC APIのメリットを活用しながら、後方互換性を維持することができる。<br> | <br> | ||
<br> | この実装により、IPC APIのメリットを活用しながら、後方互換性を維持することができる。<br> | ||
IPC機能は実験的であり、現在テスト中である。<br> | <br> | ||
一部のコマンドは、全てのシナリオで期待通りに動作しない場合がある。<br> | IPC機能は実験的であり、現在テスト中である。<br> | ||
<br> | 一部のコマンドは、全てのシナリオで期待通りに動作しない場合がある。<br> | ||
==== プロジェクト構造 ==== | <br> | ||
KiCAD-MCP-Serverのプロジェクト構造を以下に示す。<br> | ==== プロジェクト構造 ==== | ||
KiCAD-MCP-Serverのプロジェクト構造を以下に示す。<br> | |||
<br> | |||
KiCAD-MCP-Server/ | |||
├── src/ # TypeScriptソースコード | |||
│ ├── index.ts # メインエントリーポイント | |||
│ ├── mcp-server.ts # MCPサーバ実装 | |||
│ └── python-interface.ts # Pythonサブプロセス管理 | |||
├── python/ # Pythonインターフェース | |||
│ ├── kicad_interface.py # メインエントリーポイント | |||
│ ├── kicad_api/ # バックエンド実装 | |||
│ │ ├── base.py # 抽象基底クラス | |||
│ │ ├── ipc_backend.py # IPC APIバックエンド | |||
│ │ ├── swig_backend.py # SWIG APIバックエンド | |||
│ │ └── factory.py # バックエンドファクトリ | |||
│ ├── schemas/ # JSON Schema定義 | |||
│ │ └── tool_schemas.py # ツールスキーマ | |||
│ ├── resources/ # リソースハンドラ | |||
│ │ └── resource_definitions.py # リソース定義 | |||
│ └── commands/ # コマンド実装 | |||
│ ├── project.py # プロジェクト操作 | |||
│ ├── board.py # ボード操作 | |||
│ ├── component.py # コンポーネント配置 | |||
│ ├── routing.py # トレースルーティング | |||
│ ├── design_rules.py # DRC操作 | |||
│ ├── export.py # ファイル生成 | |||
│ ├── schematic.py # 回路図設計 | |||
│ └── library.py # フットプリントライブラリ | |||
├── config/ # 設定ファイル | |||
├── docs/ # ドキュメント | |||
├── tests/ # テスト | |||
├── scripts/ # ユーティリティスクリプト | |||
├── package.json # Node.js依存関係 | |||
├── requirements.txt # Python依存関係 | |||
├── tsconfig.json # TypeScript設定 | |||
└── README.md # プロジェクトドキュメント | |||
<br> | |||
==== トラブルシューティング ==== | |||
===== サーバがクライアントに表示されない ===== | |||
症状は、MCPサーバがClaude DesktopまたはClineに表示されないことである。<br> | |||
<br> | |||
解決方法を以下に示す。<br> | |||
* ビルドが完了していることを確認する。 | |||
*: <pre>ls dist/index.js</pre> | |||
* 設定ファイルのパスが絶対パスであることを確認する。 | |||
* MCPクライアントを再起動する。 | |||
* クライアントのログでエラーメッセージを確認する。 | |||
<br> | |||
===== Pythonモジュールのインポートエラー ===== | |||
症状は、<u>ModuleNotFoundError: No module named 'pcbnew'</u> というエラーが発生することである。<br> | |||
<br> | |||
解決方法を以下に示す。<br> | |||
* KiCADのインストールを確認する。 | |||
*: <pre>python3 -c "import pcbnew"</pre> | |||
* 設定ファイルの環境変数 <code>PYTHONPATH</code> が、KiCADのインストールと一致しているか確認する。 | |||
* KiCADがPythonサポート付きでインストールされていることを確認する。 | |||
<br> | |||
===== ツール実行の失敗 ===== | |||
症状は、ツールが不明確なエラーで失敗することである。<br> | |||
<br> | |||
解決方法を以下に示す。<br> | |||
* サーバログを確認する。 | |||
*: <u>~/.kicad-mcp/logs/kicad_interface.log</u> | |||
* ボード操作を実行する前にプロジェクトが読み込まれていることを確認する。 | |||
* ファイルパスが相対パスではなく絶対パスであることを確認する。 | |||
* ツールパラメータの型がスキーマ要件と一致しているか確認する。 | |||
<br> | |||
===== Windows固有の問題 ===== | |||
症状は、サーバがWindowsで起動しないことである。<br> | |||
<br> | |||
解決方法を以下に示す。<br> | |||
* 自動診断を実行する。 | |||
*: <pre>.\setup-windows.ps1</pre> | |||
* Pythonパスが二重バックスラッシュを使用しているか確認する。 | |||
*: <u>C:\\Program Files\\KiCad\\10.0</u> | |||
* WindowsイベントビューアでNode.jsのエラーを確認する。 | |||
* Windows Troubleshooting Guide (docs/WINDOWS_TROUBLESHOOTING.md) を参照する。 | |||
<br> | |||
===== ヘルプの取得 ===== | |||
問題が解決しない場合は、以下の方法でサポートを受けることができる。<br> | |||
<br> | |||
* GitHub Issues (https://github.com/mixelpixx/KiCAD-MCP-Server/issues) を確認する。 | |||
* サーバログを確認する。(~/.kicad-mcp/logs/kicad_interface.log) | |||
* 以下の情報を含めて新しいissueを開く。 | |||
*: オペレーティングシステムとバージョン、KiCADバージョン、Node.jsバージョン、完全なエラーメッセージとスタックトレース、関連するログの抜粋 | |||
<br><br> | |||
==== 参考情報 ==== | |||
* [https://github.com/mixelpixx/KiCAD-MCP-Server GitHub Repository] | |||
* [https://glama.ai/mcp/servers/@mixelpixx/KiCAD-MCP-Server mixelpixx/KiCAD-MCP-Server on Glama] | |||
* [https://www.kicad.org/ KiCAD公式サイト] | |||
* [https://modelcontextprotocol.io/ Model Context Protocol公式サイト] | |||
* [https://github.com/kicad-skip kicad-skip (回路図操作)] | |||
<br><br> | |||
== サーバ3 : Seeed-Studio/kicad-mcp-server == | |||
==== 概要 ==== | |||
Seeed-Studio/kicad-mcp-serverは、KiCad設計データの分析、検証、コード生成に重点を置くPython実装である。<br> | |||
<br> | |||
ライセンスはMIT、最新コミットは2026年5月22日である。<br> | |||
<br> | |||
KiCad 8.0以降に対応するが、KiCad 9.0または10.0を推奨する。<br> | |||
<br> | |||
==== 機能カテゴリ ==== | |||
<center> | |||
{| class="wikitable" | |||
|+ Seeed-Studioのツールカテゴリ | |||
! カテゴリ !! ツール数 !! 主な用途 | |||
|- | |||
| Schematic Analysis || 6 || 回路図の構造と接続の分析 | |||
|- | |||
| PCB Analysis || 6 || 基板、レイヤー、部品の分析 | |||
|- | |||
| Netlist Analysis || 4 || ネットリストと接続関係の分析 | |||
|- | |||
| Validation || 3 || 設計の検証と問題の検出 | |||
|- | |||
| Editing || 6 || 分析結果に基づく編集とコード生成 | |||
|} | |||
</center> | |||
<br> | |||
==== インストール ==== | |||
KiCadに同梱されたPythonを使用する方法が推奨される。<br> | |||
<br> | |||
KiCadバンドルPythonでは完全な <code>pcbnew</code> 分析を利用できる。<br> | |||
<br> | |||
プロジェクトを取得し、編集可能モードでインストールする。<br> | |||
<br> | |||
git clone https://github.com/Seeed-Studio/kicad-mcp-server.git | |||
cd kicad-mcp-server | |||
"C:\\Program Files\\KiCad\\10.0\\bin\\python.exe" -m pip install -e . | |||
<br> | |||
システムPythonでの導入も可能だが、この場合はテキストパースにフォールバックすることがある。<br> | |||
<br> | |||
python -m pip install -e . | |||
<br> | |||
==== クライアント設定 ==== | |||
KiCadバンドルPythonを使用するClaude Codeの設定例を示す。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"mcpServers": { | |||
"kicad": { | |||
"command": "C:\\Program Files\\KiCad\\10.0\\bin\\python.exe", | |||
"args": ["-m", "kicad_mcp_server"] | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
システムPythonを使用する設定は、以下の通りである。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"mcpServers": { | |||
"kicad": { | |||
"command": "python", | |||
"args": ["-m", "kicad_mcp_server"] | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
Claude Code CLIでは、次のコマンドでユーザスコープに追加できる。<br> | |||
<br> | |||
claude mcp add kicad -s user -- "C:\Program Files\KiCad\10.0\bin\python.exe" -m kicad_mcp_server | |||
<br> | |||
===== OpenCode ===== | |||
OpenCodeでは、プロジェクトルートの <u>opencode.json</u> または <u>opencode.jsonc</u> に設定を記述する。<br> | |||
<br> | |||
Seeed-Studio/kicad-mcp-serverをKiCadバンドルPythonで起動する設定例を以下に示す。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"kicad": { | |||
"type": "local", | |||
"command": [ | |||
"C:/Program Files/KiCad/10.0/bin/python.exe", | |||
"-m", | |||
"kicad_mcp_server" | |||
], | |||
"enabled": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
Linuxでは、KiCadバンドルPythonのパスを環境に合わせて変更する。<br> | |||
設定後、<code>opencode mcp list</code> コマンドを実行して、接続を確認する。<br> | |||
<br> | |||
詳しい仕様は、[https://opencode.ai/docs/mcp-servers/ OpenCode公式MCPサーバ設定]を参照すること。<br> | |||
<br> | |||
==== 動作確認 ==== | |||
* KiCadのバージョンを確認する。 | |||
*: <pre>kicad-cli version</pre> | |||
* MCPクライアントを再起動する。 | |||
* PCBの外形、部品、ネットを読み取るツールを順に実行する。 | |||
* KiCadバンドルPythonで <code>import pcbnew</code> が成功することを確認する。 | |||
<br><br> | |||
== サーバ4 : oaslananka/kicad-mcp-pro == | |||
==== 概要 ==== | |||
oaslananka/kicad-mcp-proは、Schematic、PCB、ERC、DRC、DFM、BOM、製造レビューを1つのサーバで扱う統合型実装である。<br> | |||
KiCad 9.xと10.xに対応し、KiCadプログラム互換率は76.3[%]とされる。<br> | |||
<br> | |||
ライセンスはMIT、最新リリースはv3.25.0である。<br> | |||
<br> | |||
Python 3.13以降が必要である。<br> | |||
<br> | |||
==== インストール方法 ==== | |||
最も簡単な方法は、PyPIパッケージを <code>uvx</code> コマンドで実行する方法である。<br> | |||
<br> | |||
uvx kicad-mcp-pro | |||
<br> | |||
npmラッパーを使う場合は次の通りである。<br> | |||
<br> | |||
npx kicad-mcp-pro | |||
<br> | |||
GUIを使用する場合は、GitHub ReleasesからTauriデスクトップアプリのインストーラを取得する。<br> | |||
TauriアプリはPythonダッシュボードサーバを自動起動し、<code>http://127.0.0.1:3334/ui</code> でGUIを公開する。<br> | |||
<br> | |||
==== STDIO設定 ==== | |||
MCPクライアントの通常のローカル設定では、<code>uvx</code> をコマンドに指定する。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"mcpServers": { | |||
"kicad-pro": { | |||
"command": "uvx", | |||
"args": ["kicad-mcp-pro"] | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
===== OpenCode ===== | |||
<code>uvx</code> を使用してkicad-mcp-proを起動する場合は、<code>mcp</code> フィールドにローカルサーバを定義する。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"kicad-pro": { | |||
"type": "local", | |||
"command": [ | |||
"uvx", | |||
"kicad-mcp-pro" | |||
], | |||
"enabled": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
特定のプロファイルを使用する場合は、<code>command</code> 配列の末尾にプロファイル名を追加する。<br> | |||
設定後、<code>opencode mcp list</code> コマンド と <code>opencode mcp debug kicad-pro</code> コマンドを実行して、接続を確認する。<br> | |||
<br> | |||
詳しい仕様は、[https://opencode.ai/docs/mcp-servers/ OpenCode公式MCPサーバ設定]を参照すること。<br> | |||
<br> | |||
==== Streamable HTTP ==== | |||
Streamable HTTPでは <code>/mcp</code> エンドポイントを使用する。<br> | |||
既定ポートは3334である。<br> | |||
<br> | |||
uvx kicad-mcp-pro --transport streamable-http --host 127.0.0.1 --port 3334 | |||
<br> | |||
HTTP時のMCPプロトコルバージョンは <code>2025-11-25</code> である。<br> | |||
既定では、ステートレスHTTPを使う。<br> | |||
<br> | |||
セッションIDが必要な環境では、次の環境変数を設定する。<br> | |||
<br> | |||
KICAD_MCP_STATEFUL_HTTP=1 | |||
<br> | |||
LANやインターネットへ公開する場合は、127.0.0.1からバインド先を変更する前に、認証、ファイアウォール、TLS、プロジェクトパスの制限を設定する。<br> | |||
<br> | |||
==== プロファイル ==== | |||
プロファイルを使うと、クライアントに公開するツールセットを制限できる。<br> | |||
* <code>full</code> | |||
*: 総合機能を公開する。 | |||
* <code>pcb_only</code> | |||
*: PCB関連機能を公開する。 | |||
* <code>analysis</code> | |||
*: 解析とレビューを中心にする。 | |||
* <code>minimal</code> | |||
*: 必要最小限のツールだけを公開する。 | |||
<br> | |||
==== 解析機能の範囲 ==== | |||
* DFMと製造レビュー | |||
* SI、PI、EMC、熱解析の一次近似 | |||
*: 一次近似の精度目安は5から10%であり、正式な検証の代替ではない。 | |||
* JLCPCB部品調達 | |||
* Nexar、DigiKey、Mouser | |||
*: 各APIを設定した場合に利用できる。 | |||
<br> | |||
==== トラブルシューティング ==== | |||
===== 3334ポートが使用中 ===== | |||
Tauriアプリまたは別のプロセスが3334ポートを使用していると起動に失敗する。<br> | |||
<br> | |||
* 使用中のプロセスを確認する。 | |||
* 別のポートを指定する。 | |||
* MCPクライアントの接続先を同じポートへ変更する。 | |||
<br> | |||
===== HTTP接続を許可できない ===== | |||
<code>/mcp</code> コマンドのエンドポイント、ホスト、ポート、MCP-Protocol-Versionを確認する。<br> | |||
<br> | |||
ステートフル接続が必要な場合は、環境変数 <code>KICAD_MCP_STATEFUL_HTTP=1</code> を設定する。<br> | |||
<br><br> | |||
== サーバ5 : belaszalontai/kipilot-mcp == | |||
==== 概要 ==== | |||
kipilot-mcpはKiCad 10.xだけを対象にしたPCB-firstのMCPサーバである。<br> | |||
<br> | |||
Python 3.11以降を必要とし、KiCad 9以前には対応しない。<br> | |||
<br> | |||
KiCad 10の公式kicad-python IPCバインディングのみを使用するため、SWIGとの自動フォールバックを前提にしない。<br> | |||
<br> | |||
設計思想は読み取り主体であり、変更機能は <code>KIPILOT_ENABLE_MUTATIONS=0</code> が初期値である。<br> | |||
<br> | |||
==== インストール ==== | |||
ソースコードからインストールする場合は、リポジトリのルートで次を実行する。<br> | |||
<br> | |||
git clone https://github.com/belaszalontai/kipilot-mcp.git | |||
cd kipilot-mcp | |||
pip install . | |||
<br> | |||
Windowsでは、ランタイムを含むZIPを使用できる。<br> | |||
kipilot-mcp-<version>-windows-x64.zip | |||
<br> | |||
==== ツールの範囲 ==== | |||
===== 接続確認 ===== | |||
* <code>ping_kicad</code> | |||
*: KiCadとのIPC接続を確認する。 | |||
* <code>get_kicad_version</code> | |||
*: 接続先のKiCadバージョンを取得する。 | |||
<br> | |||
===== ボードとドキュメントの検査 ===== | |||
* ボード外形 | |||
* スタックアップ | |||
* フットプリント | |||
* ネット | |||
* パッド | |||
* トラック | |||
* ビア | |||
* ゾーン | |||
<br> | |||
===== フィルタ検索 ===== | |||
* フットプリント検索 | |||
* ネット検索 | |||
* ネットクラス検索 | |||
* 接続アイテム検索 | |||
<br> | |||
===== ガード付き変更 ===== | |||
* レイヤーの変更 | |||
* フットプリントの移動、回転、反転 | |||
* トラックとビアの作成 | |||
* ゾーンの再充填 | |||
* 保存 | |||
* リバート | |||
<br> | |||
==== 利用手順 ==== | |||
# KiCad 10のPCBエディタを起動する。 | |||
# MCPクライアントから <code>ping_kicad</code> を呼び出す。 | |||
# <code>get_kicad_version</code> で10.xを確認する。 | |||
# 検査ツールで現状を読み取る。 | |||
# 変更を行う場合だけ、環境変数 <code>KIPILOT_ENABLE_MUTATIONS=1</code> を明示する。 | |||
# 変更後に検査を再実行し、保存前に差分を確認する。 | |||
<br> | |||
==== トラブルシューティング ==== | |||
===== KiCad GUIへ接続できない ===== | |||
kipilot-mcpはIPC必須であり、KiCad GUIが起動していないと接続できない。<br> | |||
KiCad 10のPCBエディタで対象ボードを開いて、IPCプラグインの状態を確認する。<br> | |||
<br> | |||
===== 変更ツールが利用できない ===== | |||
変更は、既定で無効である。<br> | |||
<br> | |||
意図した操作だけを行う場合に限り、環境変数 <code>KIPILOT_ENABLE_MUTATIONS=1</code> を設定する。<br> | |||
<br><br> | |||
== サーバ6 : mixelpixx/Konnect == | |||
==== 概要 ==== | |||
mixelpixx/KonnectのKonnectは、KiCad専用として公開されているRust製MCPサーバである。<br> | |||
公式KiCad IPC APIを使用し、MCPのstdio通信でOpenCode等のクライアントへKiCad操作を提供する。<br> | |||
<br> | |||
OpenCode連携ではスタンドアロン実行ファイルを使用する構成が扱いやすい。<br> | |||
<br> | |||
ライセンスはAGPL-3.0である。<br> | |||
<br> | |||
==== 公式リポジトリと対応範囲 ==== | |||
公式リポジトリは、[https://github.com/mixelpixx/Konnect mixelpixx/Konnect]である。<br> | |||
<br> | |||
Konnectは、回路図をS式形式のファイルとして編集して、PCBをKiCad 10のIPC API経由でリアルタイムに操作する構成を採用している。<br> | |||
<br> | |||
PCB操作ではKiCad GUIが起動して、対象基板が開かれている必要がある。<br> | |||
<br> | |||
Konnectの主な範囲は、以下の通りである。<br> | |||
* 回路図の部品配置と配線 | |||
* PCBのフットプリント配置、移動、回転、配線 | |||
* ERC、DRC、接続性検証、設計レビュー監査 | |||
* ガーバー、ドリル、BOM、ピックアンドプレース、3Dモデル、PDFのエクスポート | |||
* JLCPCB部品検索、Freerouting、リファレンス回路 | |||
* 回路図ビューアと変更に追従する表示 | |||
<br> | |||
<center> | |||
{| class="wikitable" | |||
|+ Konnectの処理経路 | |||
|- | |||
! 対象 !! 方式 !! KiCadの状態 | |||
|- | |||
| 回路図編集 || <u>.kicad_sch</u> のS式編集と書き込み || KiCadを起動せずに扱える範囲がある | |||
|- | |||
| PCB編集 || KiCad 10 IPC API (NNG + protobuf) || KiCad GUIと対象PCBが必要 | |||
|- | |||
| DRC、ERC、エクスポート || kicad-cliのサブプロセス || kicad-cliのパスが必要 | |||
|- | |||
| MCP接続 || JSON-RPC over stdio || OpenCodeのローカルMCPとして起動 | |||
|} | |||
</center> | |||
<br> | |||
==== 配布物の選択 ==== | |||
Linux向け配布物は、用途によって選択する。<br> | |||
両方を導入する必要はなく、OpenCode連携ではスタンドアロン版を使用する。<br> | |||
<br> | |||
* <u>Konnect PCM</u> | |||
*: KiCad Plugin and Content Manager用のプラグインパッケージである。 | |||
*: <u>metadata.json</u>、<u>plugin.json</u>、Pythonランチャー、設定ダイアログ、Konnectバイナリを含む。 | |||
*: KiCad内からインストールする場合に使用する。 | |||
* <u>Konnect スタンドアロン</u> | |||
*: スタンドアロンのKonnectバイナリを含むアーカイブである。 | |||
*: OpenCodeのstdio MCPサーバとして直接起動する場合は、こちらを推奨する。 | |||
<br> | |||
Konnect PCMは、KiCad内のPlugin and Content Managerから導入する方式であり、Konnect スタンドアロンはKiCad外のMCPクライアントから実行ファイルを指定する方式である。<br> | |||
<br> | |||
==== Linuxへの導入 ==== | |||
===== Konnect スタンドアロンの配置 ===== | |||
[https://github.com/mixelpixx/Konnect/releases KonnectのReleases]から <u>konnect-<バージョン>-<プラットフォーム>.tar.gz</u> をダウンロードする。<br> | |||
ダウンロードしたファイルを解凍して、任意のディレクトリに配置する。<br> | |||
<br> | |||
tar xf konnect-<バージョン>-<プラットフォーム>.tar.gz | |||
mkdir -p ~/.local/bin | |||
mv konnect ~/.local/bin/konnect | |||
chmod u+x ~/.local/bin/konnect | |||
~/.local/bin/konnect --version | |||
<br> | |||
環境変数 <code>PATH</code> に含まれていない場合でも、OpenCodeの設定では上記の絶対パスを指定することが可能である。<br> | |||
<br> | |||
このバイナリはGNU libcに動的リンクされるため、Alpine Linux等のmusl環境ではそのまま動作しない場合がある。<br> | |||
そのため、musl環境では、互換性を確認するか適切なGNU libc環境で実行する。<br> | |||
<br> | |||
==== OpenCodeの設定 ==== | |||
OpenCodeでは、プロジェクトルートの <u>opencode.json</u> または <u>opencode.jsonc</u> のトップレベルにある <code>mcp</code> フィールドへ追加する。<br> | |||
全体設定を使用する場合は、Linuxでは <u>~/.config/opencode/opencode.json</u> を使用する。<br> | |||
<br> | |||
OpenCodeの形式では、<code>mcp</code> 配下の <code>type</code>、<code>command</code>、<code>enabled</code> を使用する。<br> | |||
<br> | |||
既存のMCPサーバの設定がある場合は、既存サーバのブロックを削除せず、<code>konnect</code> ブロックだけを追加する。<br> | |||
<br> | |||
以下の例では、kicad-proを登録するが、ツールの選択間違いを避けるため無効化している。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
// opencode.json / opencode.jsoncファイル | |||
{ | |||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"konnect": { | |||
"type": "local", | |||
"command": [ | |||
"/home/<ユーザ名>/.local/bin/konnect" | |||
], | |||
"enabled": true | |||
}, | |||
"kicad-pro": { | |||
"type": "local", | |||
"command": [ | |||
"uvx", | |||
"kicad-mcp-pro", | |||
"--transport", | |||
"stdio" | |||
], | |||
"enabled": false | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
<u>/home/<ユーザ名>/.local/bin/konnect</u>は、実際のログインユーザ名に置き換える。<br> | |||
設定を保存した後、OpenCodeを再起動して、以下に示すコマンドで接続を確認する。<br> | |||
<br> | |||
opencode mcp list | |||
opencode mcp debug konnect | |||
<br> | |||
==== Konnectの設定ファイル ==== | |||
Linuxでは、Konnectの設定ファイルとして <u>~/.config/konnect/config.toml</u> ファイルを使用する。<br> | |||
<br> | |||
OpenCodeのローカルstdio連携では、基本設定を次のようにする。<br> | |||
<br> | |||
<syntaxhighlight lang="toml"> | |||
# ~/.config/konnect/config.tomlファイル | |||
transport = "stdio" | |||
</syntaxhighlight> | |||
<br> | |||
<u>また、IPCアドレスやkicad-cliのパスを環境に合わせて指定することもできる。</u><br> | |||
実際のソケットパスと実行ファイルの場所は、環境に合わせて変更すること。<br> | |||
<br> | |||
<syntaxhighlight lang="toml"> | |||
# ~/.config/konnect/config.tomlファイル | |||
transport = "stdio" | |||
kicad_cli = "/usr/bin/kicad-cli" | |||
kicad_binary = "/usr/bin/kicad" | |||
ipc_address = "ipc:///tmp/kicad/api.sock" | |||
</syntaxhighlight> | |||
<br> | |||
LinuxディストリビューションやKiCadの導入方法によってパスは異なるため、未確認のパスをそのまま固定値として扱わないこと。<br> | |||
<br> | |||
==== KiCad IPC APIの有効化 ==== | |||
KonnectのPCB操作は、KiCad 10の公式IPC APIをNNGとprotobufで利用する。<br> | |||
<br> | |||
PCBを操作する前に、KiCad GUIとIPC APIを準備する。<br> | |||
<br> | |||
# KiCad 10を起動する。 | |||
# [設定]メニューバー - [設定...]を開いて、[プラグイン]を選択する。 | |||
# [KiCad APIを有効にする]チェックボックスにチェックを入力する。 | |||
# PCB編集では、対象のPCBファイルをPCBエディターで開く。 | |||
# OpenCodeからKonnectの接続確認と読み取り操作を行う。 | |||
# 変更後はKiCad GUIの表示、Undo履歴、DRC結果を確認して保存する。 | |||
<br> | |||
回路図の直接編集はKonnectのS式エンジンによるファイル操作であり、PCBのGUI操作は起動中のKiCad IPC APIを経由する。<br> | |||
<br> | |||
一方、DRC、ERC、ガーバー等のチェックとエクスポートは、kicad-cliサブプロセスの役割とされている。<br> | |||
したがって、回路図編集、PCBのGUI IPC操作、kicad-cliによるチェックと出力を同じ接続経路として扱わない。<br> | |||
<br> | |||
==== kicad-mcp-proとの併用 ==== | |||
<u>Konnect</u> と <u>oaslananka/kicad-mcp-pro</u> をOpenCodeへ両方登録することは可能である。<br> | |||
<u>ただし、類似したPCB、DRC、ERC、エクスポート系のツールが同時に有効になると、AIが意図しないサーバを選ぶ可能性がある。</u><br> | |||
<br> | |||
運用方法は、次のいずれかに固定する。<br> | |||
<br> | |||
* 編集担当をKonnectに固定して、kicad-mcp-proはレビューと解析専用にする。 | |||
* OpenCodeの設定において、作業時に使用するサーバだけを <code>enabled: true</code> にする。 | |||
* 両方を登録したまま、AIへの運用指示で担当範囲を明示する。 | |||
<br> | |||
<u>同じ <u>.kicad_sch</u> または <u>.kicad_pcb</u> を、Konnectとkicad-mcp-proから同時に編集してはならない。</u><br> | |||
<u>編集前にプロジェクトを複製して、どちらか一方のMCPサーバによる操作を完了してから、もう一方をレビューに使用する。</u><br> | |||
<br> | |||
OpenCodeでの運用指示例を以下に示す。<br> | |||
<br> | |||
<syntaxhighlight lang="md"> | |||
- PCBと回路図の編集担当はKonnectに固定する。 | |||
- kicad-mcp-proは読み取り、レビュー、解析だけに使用する。 | |||
- 同じ .kicad_sch または .kicad_pcb を両MCPサーバから同時に編集しない。 | |||
- 変更前に複製とバックアップを作成して、変更対象と保存可否を確認する。 | |||
- Konnectで編集した後、KiCad GUIで確認して、kicad-mcp-proでレビューする。 | |||
- DRC、ERC、エクスポートは使用したMCPサーバとkicad-cliの結果を照合する。 | |||
</syntaxhighlight> | |||
<br> | |||
==== Konnectのトラブルシューティング ==== | |||
===== Exec format error ===== | |||
<u>Exec format error</u> エラーが表示される場合は、実行環境とバイナリのアーキテクチャが一致していない可能性がある。<br> | |||
<br> | |||
* <code>uname -m</code> コマンドで実行環境を確認する。 | |||
* <u>x86_64</u> と表示される場合は、<u>konnect-<バージョン>-x86_64-unknown-linux-gnu.tar.gz</u> を使用する。 | |||
* ARM環境では、対応する別の配布物 または ソースコードからビルドする。 | |||
<br> | |||
===== Permission denied ===== | |||
<u>Permission denied</u> エラーが表示される場合は、実行権限を付与する。<br> | |||
<br> | |||
chmod u+x ~/.local/bin/konnect | |||
<br> | |||
===== IPC接続失敗 ===== | |||
PCBツールがIPC接続に失敗する場合は、次の順に確認する。<br> | |||
<br> | |||
* KiCad 10のGUIが起動していることを確認する。 | |||
* [設定]メニューバー - [設定...] - [プラグイン]を選択して、[KiCad APIを有効にする]チェックボックスにチェックを入力する。 | |||
* 対象PCBをPCBエディターで開く。 | |||
* <u>~/.config/konnect/config.toml</u> ファイルの <code>ipc_address</code>と、KiCad側のソケット設定を確認する。 | |||
* <u>opencode.json</u> ファイルの <code>command</code> がスタンドアロン版のフルパスを指していることを確認する。 | |||
<br> | |||
===== kicad-cliの検出失敗 ===== | |||
<u>kicad-cli not found</u> エラー等が表示される場合は、kicad-cliが環境変数 <code>PATH</code> にあるか、設定ファイルのkicad_cliのパスが正しいかを確認する。<br> | |||
<br> | |||
which kicad-cli | |||
kicad-cli version | |||
<br> | |||
KiCadのインストール先が標準外の場合は、<u>~/.config/konnect/config.toml</u> ファイルにフルパスを指定する。<br> | |||
<br><br> | |||
== その他の実装 == | |||
主要な6つのMCPサーバ以外にも、用途を絞ったものが存在する。<br> | |||
<br> | |||
==== Glama.aiに登録された実装 ==== | |||
<center> | |||
{| class="wikitable" | |||
! サーバ !! ツール数 !! 特徴 | |||
|- | |||
| bleugreen/kicad-mcp || - || マルチボード接続トレース、データシート検索 | |||
|- | |||
| lmaag182/kicad_mcp_server_ipc || 77 || IPC APIのみ、KiCad 9+ | |||
|- | |||
| daedalus/mcp-kicad || 約17 || PyPIのmcp-kicad v0.1.1 | |||
|- | |||
| ProductOfAmerica/mcp-server-kicad || 102 || 5サーバスイート | |||
|- | |||
| SaeronLab/eda-mcp || 39 || KiCad 9.x、EDA汎用 | |||
|- | |||
| fsbondtec/kicad-mcp || - || lamaalrajihのフォーク | |||
|- | |||
| skeptomai/kicad_mcp || - || SQLite FTS5による20,000以上の部品検索 | |||
|} | |||
</center> | |||
<br> | |||
==== Huaqiu Electronicsの組み込み実装 ==== | |||
Huaqiu-Electronics/kicad-mcpはKiCadフォークに組み込まれたMCPサーバである。<br> | |||
<br> | |||
72ツールを含み、フォーク元はKiCad 9.0リリースブランチを追跡する。<br> | |||
<br> | |||
公式KiCadへのマージ状況は不明であるため、導入前にフォークとの差分と保守状態を確認する。<br> | |||
<br> | |||
==== その他の専門実装 ==== | |||
<center> | |||
{| class="wikitable" | |||
! サーバ !! 主な用途 !! 状態 | |||
|- | |||
| circuit-synth/mcp-kicad-sch-api || 回路図操作特化 || 専門実装 | |||
|- | |||
| Netlist-Studio/kicad-mcp || KiCad 9 IPC API制御 || IPC中心 | |||
|- | |||
| blwfish/kicad-mcp || 71ツール、FastMCP、kicad-sch-api || 複合実装 | |||
|- | |||
| Greg3001/kicad-claude-mcp || 105ツール、SPICE、SI、RF、パネル化 || 拡張型 | |||
|- | |||
| Finerestaurant/kicad-mcp-python || 公式IPC API || 2025年7月以降開発停止 | |||
|} | |||
</center> | |||
<br> | |||
用途が限定されるサーバは、主要サーバの代替ではなく、対象機能の補助として評価する。<br> | |||
<u>特に、KiCad 10のフォーマットとIPC APIを使用する場合は、最終コミット日だけでなく、実際のサンプルプロジェクトで確認する。</u><br> | |||
<br><br> | |||
== MCPプロトコルと接続方式 == | |||
MCPはLLMホスト、クライアント、サーバの間でコンテキストとツールを標準化する。<br> | |||
メッセージ形式はJSON-RPC 2.0で、サーバとクライアントは能力をネゴシエーションする。<br> | |||
<br> | |||
==== プロトコル階層 ==== | |||
* JSON-RPC 2.0 | |||
*: リクエスト、レスポンス、エラーのメッセージ形式を定める。 | |||
* MCP Base Protocol | |||
*: 初期化、能力交渉、通知、キャンセル、ログを定める。 | |||
* Server Features | |||
*: Resources、Prompts、Toolsを定める。 | |||
<br> | |||
==== STDIO ==== | |||
STDIOは全主要サーバが対応するローカル向けの接続方式である。<br> | |||
プロセスの標準入力と標準出力をJSON-RPC通信に使うため、標準出力へデバッグログを出力してはならない。<br> | |||
<br> | |||
==== Streamable HTTP ==== | |||
oaslananka/kicad-mcp-proはStreamable HTTPに対応する。<br> | |||
リモートや複数クライアントから利用できるが、HTTP公開時には認証、許可オリジン、TLS、プロジェクトディレクトリ制限を検討する。<br> | |||
<br><br> | |||
== 共通の設定と運用 == | |||
==== Claude Desktopの設定 ==== | |||
設定ファイルの場所はLinuxでは <code>~/.config/Claude/claude_desktop_config.json</code>、Windowsでは <code>%APPDATA%\Claude\claude_desktop_config.json</code> である。<br> | |||
サーバごとに実行ファイルと引数を絶対パスで指定する。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"mcpServers": { | |||
"kicad": { | |||
"command": "/home/<ユーザ名>/.local/bin/uvx", | |||
"args": ["kicad-mcp-pro"] | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
==== OpenCodeの設定 ==== | |||
OpenCodeでは、<u>opencode.json</u> または <u>opencode.jsonc</u> の <code>mcp</code> フィールドに、使用するMCPサーバを定義する。<br> | |||
<br> | |||
kicad-mcp-proを使用する例を以下に示す。<br> | |||
<br> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"$schema": "https://opencode.ai/config.json", | |||
"mcp": { | |||
"kicad-pro": { | |||
"type": "local", | |||
"command": [ | |||
"uvx", | |||
"kicad-mcp-pro" | |||
], | |||
"enabled": true | |||
} | |||
} | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
OpenCodeのプロジェクト設定はプロジェクトルートに配置して、全プロジェクト共通の設定はLinuxでは <u>~/.config/opencode/opencode.json</u> に配置する。<br> | |||
<br> | |||
<code>command</code> は実行ファイルと引数を1つの配列にまとめる。<br> | |||
設定後、<code>opencode mcp list</code> コマンドを実行して、サーバ一覧を確認する。<br> | |||
<br> | |||
詳しい仕様は、[https://opencode.ai/docs/mcp-servers/ OpenCode公式MCPサーバ設定]を参照すること。<br> | |||
<br> | |||
==== パス制限 ==== | |||
AIから参照できるディレクトリは、KiCadプロジェクト専用ディレクトリに限定する。<br> | |||
既存ページで使用していた検証例を次に示す。<br> | |||
<br> | |||
<syntaxhighlight lang="python"> | |||
from pathlib import Path | |||
ALLOWED_DIRECTORIES = [ | |||
"/home/<ユーザ名>/kicad-projects", | |||
"/home/<ユーザ名>/shared-projects", | |||
] | |||
def is_path_allowed(file_path: str) -> bool: | |||
try: | |||
resolved_path = Path(file_path).resolve() | |||
return any( | |||
resolved_path.is_relative_to(Path(item).resolve()) | |||
for item in ALLOWED_DIRECTORIES | |||
) | |||
except Exception: | |||
return False | |||
</syntaxhighlight> | |||
<br> | |||
==== バックアップ ==== | |||
変更を許可するサーバでは、ツール呼び出し前にスナップショットを作成する。<br> | |||
<br> | |||
既存のバックアップ例を示す。<br> | |||
<br> | |||
<syntaxhighlight lang="sh"> | |||
#!/usr/bin/env sh | |||
BACKUP_DIR="/var/backups/kicad-projects" | |||
DATE=$(date +%Y%m%d_%H%M%S) | |||
PROJECT_DIR="/home/username/kicad-projects" | |||
mkdir -p "$BACKUP_DIR" | |||
tar -czf "$BACKUP_DIR/kicad-projects_$DATE.tar.gz" \ | |||
-C "$(dirname "$PROJECT_DIR")" "$(basename "$PROJECT_DIR")" | |||
find "$BACKUP_DIR" -name "*.tar.gz" -mtime +30 -delete | |||
echo "バックアップ完了: kicad-projects_$DATE.tar.gz" | |||
</syntaxhighlight> | |||
<br> | |||
==== Systemdでの運用 ==== | |||
STDIOサーバをSystemdで常時起動する場合は、専用ユーザと限定された作業ディレクトリを使用する。<br> | |||
<br> | |||
<syntaxhighlight lang="ini"> | |||
[Unit] | |||
Description=KiCAD MCP Server | |||
After=network.target | |||
[Service] | |||
Type=simple | |||
User=<実行する任意のユーザ名> | |||
WorkingDirectory=/home/<ユーザ名>/kicad-mcp-server | |||
ExecStart=/home/<ユーザ名>/kicad-mcp-server/venv/bin/python server.py | |||
Restart=on-failure | |||
RestartSec=10 | |||
StandardOutput=journal | |||
StandardError=journal | |||
[Install] | |||
WantedBy=multi-user.target | |||
</syntaxhighlight> | |||
<br> | |||
systemctl --user daemon-reload | |||
systemctl --user enable kicad-mcp-server | |||
systemctl --user start kicad-mcp-server | |||
journalctl --user -u kicad-mcp-server -f | |||
<br><br> | |||
== トラブルシューティング == | |||
==== KiCad 10のシャーディングエラー ==== | |||
<code>kicad_symdir</code> のシャーディングを認識できない場合は、mixelpixx/KiCAD-MCP-Serverをv2.3.1以降へ更新する。<br> | |||
<br> | |||
古いMCPサーバを使用する場合は、KiCad 9形式の複製プロジェクトで処理し、原本を上書きしない。<br> | |||
<br> | |||
==== フォーマットバージョン20260101の認識エラー ==== | |||
KiCad 10.0.0以降を使用して、サーバ側のKiCad 10対応状況を確認する。<br> | |||
<br> | |||
MCPサーバのログに古いフォーマットエラーが出る場合は、更新後にプロセスとMCPクライアントを再起動する。<br> | |||
<br> | |||
==== Python 3.9のwrite_text非互換 ==== | |||
mixelpixxの古いバージョンでPython 3.9の <code>write_text</code> 引数非互換が発生する場合は、v2.3.1へ更新する。<br> | |||
<br> | |||
==== IPCで回路図を操作できない ==== | |||
KiCad 10では回路図エディタのIPC APIは未対応である。<br> | |||
<br> | |||
SWIG、回路図専用API、またはサーバが提供するテキスト解析を使い分ける。<br> | |||
<br> | |||
PCB操作と回路図操作を同じIPC接続だけで実現しようとしない。<br> | |||
<br> | |||
==== lamaalrajihがKiCad 10で動かない ==== | |||
lamaalrajih/kicad-mcpはKiCad 9.0のみ対応で、2025-10以降は開発停止状態である。<br> | |||
<br> | |||
KiCad 10では動作しない可能性が高いため、KiCad 9専用の隔離環境で使用するか、対応サーバへ移行する。<br> | |||
<br> | |||
==== kipilot-mcpが接続できない ==== | |||
KiCadを起動して、対象PCBを開いてから <code>ping_kicad</code> を実行する。<br> | |||
<br> | |||
IPC必須であるため、ヘッドレス環境やKiCad未起動の環境では接続できない。<br> | |||
<br> | |||
==== STDIOのサーバが表示されない ==== | |||
* 実行ファイルの絶対パスを確認する。 | |||
* 引数の順序と作業ディレクトリを確認する。 | |||
* 標準出力へログを出力していないか確認する。 | |||
* MCPクライアントを完全終了して再起動する。 | |||
* サーバ単体でバージョン確認コマンドを実行する。 | |||
<br> | |||
==== DRC、ERC、ガーバー出力が失敗する ==== | |||
IPC APIはプロットとエクスポートを提供しない。<br> | |||
<br> | |||
エクスポートには <code>kicad-cli</code> を使用して、出力先の書き込み権限とディスク容量を確認する。<br> | |||
<br> | |||
DRCまたはERCの結果は、使用サーバの解析機能とKiCad本体の結果を照合する。<br> | |||
<br> | |||
==== 大規模PCBで応答が遅い ==== | |||
* 解析対象をプロファイルやパスで限定する。 | |||
* 読み取りを複数回繰り返さず、結果をキャッシュする。 | |||
* 変更操作を一つずつ承認する。 | |||
* 長時間処理にタイムアウトを設定する。 | |||
* 不要なボードオブジェクトを解放する。 | |||
<br><br> | |||
== 外部リンク == | |||
* [https://www.kicad.org/blog/2026/03/Version-10.0.0-Released/ KiCad 10.0.0リリース告知] | |||
* [https://www.kicad.org/ KiCad公式サイト] | |||
* [https://docs.kicad.org/ KiCad公式ドキュメント] | |||
* [https://github.com/KiCad/kicad-source-mirror KiCadソースコード] | |||
* [https://modelcontextprotocol.io/specification/2025-06-18 MCP 2025-06-18仕様] | |||
* [https://github.com/lamaalrajih/kicad-mcp lamaalrajih/kicad-mcp] | |||
* [https://github.com/mixelpixx/KiCAD-MCP-Server mixelpixx/KiCAD-MCP-Server] | |||
* [https://github.com/Seeed-Studio/kicad-mcp-server Seeed-Studio/kicad-mcp-server] | |||
* [https://github.com/oaslananka/kicad-mcp-pro oaslananka/kicad-mcp-pro] | |||
* [https://github.com/belaszalontai/kipilot-mcp belaszalontai/kipilot-mcp] | |||
* [https://github.com/mixelpixx/Konnect mixelpixx/Konnect] | |||
* [https://glama.ai/ Glama.ai MCPサーバ一覧] | |||
* [https://smithery.ai/ Smithery MCPサーバ一覧] | |||
<br><br> | |||
== 実運用ワークフロー == | |||
==== 導入前の確認 ==== | |||
導入前に、KiCad本体、Python、Node.js、IPCの対応範囲を別々に確認する。<br> | |||
<br> | |||
<center> | |||
{| class="wikitable" | |||
! 確認項目 !! 確認方法 !! 判断 | |||
|- | |||
| KiCad本体 || <code>kicad-cli version</code> || 9.xまたは10.xを記録する。 | |||
|- | |||
| PCB API || バンドルPythonで <code>import pcbnew</code> || 完全分析が必要なら成功を確認する。 | |||
|- | |||
| IPC || KiCad GUI起動後にping || IPC専用サーバでは必須 | |||
|- | |||
| MCPクライアント || サーバ一覧を表示 || STDIOまたはHTTPを確認する。 | |||
|- | |||
| プロジェクト || 複製を作成 || 原本を直接変更しない。 | |||
|} | |||
</center> | |||
<br> | |||
==== 読み取りから変更へ進む ==== | |||
安全な順序は、接続確認、読み取り、解析、差分確認、変更、再検証、保存である。<br> | |||
<br> | |||
# サーバを起動する。 | |||
# クライアントでサーバのツール一覧を取得する。 | |||
# KiCadのバージョンを確認する。 | |||
# プロジェクト、ボード、回路図のパスを確認する。 | |||
# 部品、ネット、レイヤー、ゾーンを読み取る。 | |||
# DRCまたは検証結果を取得する。 | |||
# 変更内容をAIの応答で確認する。 | |||
# 変更ツールを1つずつ承認する。 | |||
# KiCad本体で結果を目視確認する。 | |||
# 保存前にバックアップと差分を作成する。 | |||
# DRC、ERC、製造データの検証を再実行する。 | |||
<br> | |||
==== AIへの依頼文の設計 ==== | |||
依頼文には対象ファイル、操作対象、単位、許可する変更、検証条件を明記する。<br> | |||
<br> | |||
# 良い依頼の例: | |||
複製した <u>~/projects/led/led.kicad_pcb</u> を読み取り、フットプリント数と未接続ネットだけを報告してください。 | |||
変更は行わないでください。 | |||
<br> | |||
# 変更を含む依頼の例: | |||
複製ボードのF.Cuだけを対象に、USB差動対の幅と間隔を確認してください。 | |||
問題がある場合は変更案を提示し、承認なしでは保存しないでください。 | |||
<br> | |||
==== 単位と座標 ==== | |||
KiCadの寸法は通常mmで扱うが、APIの実装によっては内部単位を使う。<br> | |||
<br> | |||
ツールの説明に単位がない場合は、変更前に取得した値とKiCad GUIの表示を照合する。<br> | |||
<br> | |||
座標、レイヤー名、ネット名、リファレンスを省略せず指定する。<br> | |||
<br> | |||
==== 変更の承認 ==== | |||
書き込みツールは、読み取りツールと分離して公開する。<br> | |||
<br> | |||
読み取り主体のkipilot-mcpでは、変更を明示的に有効化した時だけ書き込みを許可する。<br> | |||
<br> | |||
総合型サーバでは、クライアント側の自動承認リストを空にすることを基本とする。<br> | |||
<br> | |||
==== ログとプライバシー ==== | |||
ログにはプロジェクトパス、ツール名、実行時間、結果の要約を記録する。<br> | |||
<br> | |||
回路図、ネットリスト、部品表に含まれる機密情報を外部へ送信しない。<br> | |||
<br> | |||
STDIOのJSON-RPC通信を壊さないため、通常ログは標準エラー出力かファイルへ出力する。<br> | |||
<br> | |||
==== 大規模PCBの処理 ==== | |||
大規模な基板では、一度に全オブジェクトをAIへ返さない。<br> | |||
まず集計値を取得し、必要なリファレンス、ネット、レイヤーに絞って詳細を取得する。<br> | |||
<br> | |||
* 最初にボードの外形と層数を取得する。 | |||
* 次にフットプリント数とネット数を取得する。 | |||
* 次に問題のあるネットだけを検索する。 | |||
* 最後に対象部品のパッドとトラックを取得する。 | |||
<br> | |||
==== エクスポートの分離 ==== | |||
ガーバー、PDF、SVG、3D、BOMの生成は、使用サーバが対応するか確認する。<br> | |||
<br> | |||
IPCだけで完結しない場合は <code>kicad-cli</code> を外部コマンドとして使用する。<br> | |||
<br> | |||
出力ディレクトリはプロジェクト外の一時ディレクトリにし、生成物をレビュー後に移動する。<br> | |||
<br> | |||
==== 失敗時の復旧 ==== | |||
変更の途中でエラーが出た場合は、プロセスを再起動する前にログとプロジェクトの状態を保存する。<br> | |||
<br> | |||
未保存のKiCad GUI状態とファイル上の状態が異なる可能性があるため、GUI上のUndoとバックアップを併用する。<br> | |||
<br> | |||
# ツールの実行を停止する。 | |||
# KiCad GUIで変更履歴を確認する。 | |||
# 直前のバックアップとファイルのハッシュを比較する。 | |||
# 必要なら複製プロジェクトへ戻す。 | |||
# 問題を再現できる最小プロジェクトを作る。 | |||
# OS、KiCad、Python、Node.js、MCPサーバのバージョンを記録する。 | |||
<br> | |||
==== サーバ更新の手順 ==== | |||
更新前に、リポジトリのコミット、依存関係、クライアント設定を保存する。<br> | |||
<br> | |||
# 現在のMCPサーバのバージョンを記録する。 | |||
# プロジェクトをバックアップする。 | |||
# 新しい版を別ディレクトリへ導入する。 | |||
# 小さなテストプロジェクトで接続する。 | |||
# 読み取りツールを検証する。 | |||
# 書き込みを含む機能を複製上で検証する。 | |||
# 問題がなければクライアント設定を切り替える。 | |||
<br> | |||
==== 互換性の記録 ==== | |||
プロジェクトごとに、KiCadのバージョン、MCPサーバのバージョン、Pythonのバージョン、利用したトランスポートを記録する。<br> | |||
特に、<u>kicad_symdir</u>、フォーマットバージョン <u>20260101</u>、IPC接続の有無を記録する。<br> | |||
<br> | |||
<center> | |||
{| class="wikitable" | |||
! 記録項目 !! 例 | |||
|- | |||
| KiCad || 10.0.0 | |||
|- | |||
| サーバ || mixelpixx/KiCAD-MCP-Server v2.3.1 | |||
|- | |||
| Python || 3.9以降またはサーバ要件に従う。 | |||
|- | |||
| トランスポート || STDIO | |||
|- | |||
| IPC || KiCad GUIで有効 | |||
|- | |||
| プロジェクト形式 || 20260101、kicad_symdir | |||
|- | |||
| バックアップ || 実行前に作成 | |||
|} | |||
</center> | |||
<br><br> | |||
== 実装例の再利用 == | |||
既存ページのFastMCP実装例は、lamaalrajih/kicad-mcpのような小規模サーバを拡張する場合の出発点として利用できる。<br> | |||
<br> | |||
ただし、例はKiCad 9のSWIG APIを前提にしているため、KiCad 10でそのまま動作するとは限らない。<br> | |||
<br> | |||
==== 安全なボード読み込み ==== | |||
<syntaxhighlight lang="python"> | |||
import logging | |||
from pathlib import Path | |||
import pcbnew | |||
logger = logging.getLogger(__name__) | |||
def safe_load_board(kicad_pcb_path: str): | |||
try: | |||
path = Path(kicad_pcb_path).resolve() | |||
if not path.exists(): | |||
logger.error("ファイルが存在しません: %s", path) | |||
return None | |||
if path.suffix != ".kicad_pcb": | |||
logger.error("PCBファイルではありません: %s", path) | |||
return None | |||
return pcbnew.LoadBoard(str(path)) | |||
except Exception: | |||
logger.exception("PCB読み込みエラー") | |||
return None | |||
</syntaxhighlight> | |||
<br> | |||
==== 結果を小さく返す ==== | |||
AIへ返す結果は、必要なフィールドだけに絞る。<br> | |||
<br> | |||
<syntaxhighlight lang="python"> | |||
def board_summary(board: pcbnew.BOARD) -> dict: | |||
return { | |||
"layer_count": board.GetCopperLayerCount(), | |||
"track_count": board.GetTracks().GetCount(), | |||
"footprint_count": len(list(board.GetFootprints())), | |||
} | |||
</syntaxhighlight> | |||
<br> | |||
==== 標準出力の保護 ==== | |||
STDIOサーバでは、起動時の診断文字列を標準出力へ出力しない。<br> | |||
<br> | |||
<syntaxhighlight lang="python"> | |||
import logging | |||
import sys | |||
logging.basicConfig(stream=sys.stderr, level=logging.INFO) | |||
</syntaxhighlight> | |||
<br> | |||
==== KiCad 10への移行 ==== | |||
* <u>kicad_symdir</u> の探索を追加する。 | |||
* フォーマットバージョン <u>20260101</u> を認識する。 | |||
* KiCad 10のバンドルPythonでAPIを検証する。 | |||
* IPCとSWIGの機能差を文書化する。 | |||
* 回路図操作をIPCだけに依存しない。 | |||
* エクスポートを <code>kicad-cli</code> に委譲する。 | |||
<br><br> | |||
== 運用上の注意 == | |||
==== ライセンスと計画中の実装 ==== | |||
主要サーバのライセンスはMITが多いが、個々のリポジトリのライセンス表示を導入時に確認する。<br> | |||
<br> | |||
KonnectはKiCad 10専用、v0.2.0 BETAのRust製MCPサーバである。<br> | |||
READMEには185ツールと18ツールセットと記載されている一方、リポジトリの別箇所には171ツールの表記もあるため、数え方が異なる可能性がある。<br> | |||
実際の導入時は、使用するリリースのREADMEとライセンス条件を確認する。<br> | |||
<br> | <br> | ||
詳細な導入手順、OpenCode設定、kicad-mcp-proとの併用方針は、[[#サーバ6 : mixelpixx/Konnect|サーバ6 : mixelpixx/Konnect]]にまとめる。<br> | |||
<br> | <br> | ||
==== | ==== 注意事項 ==== | ||
KiCad 10では、MCPサーバの選択にファイル形式とIPC対応の確認が欠かせない。<br> | |||
<br> | <br> | ||
総合操作にはmixelpixx、分析にはSeeed-Studio、HTTPにはoaslananka、読み取り主体のKiCad 10運用にはkipilot-mcpが適している。<br> | |||
lamaalrajihは、KiCad 9専用の既存資産として隔離して扱う。<br> | |||
<br> | <br> | ||
導入後は、バックアップ、パス制限、承認制、KiCad本体での再検証を運用手順に組み込む。<br> | |||
更新時は、サーバのリリースノートとKiCadのフォーマット変更を照合する。<br> | |||
<br> | <br> | ||
KiCad 10対応を明記していない実装では、複製プロジェクトを使用する。<br> | |||
<br> | <br> | ||
HTTP接続はローカルバインドを基本として、公開する場合は保護機構を追加する。<br> | |||
<br> | <br> | ||
回路図操作とPCB操作は、APIの対応範囲を分けて検証する。<br> | |||
<br> | <br> | ||
エクスポートはIPCの制限を考慮して、必要に応じてkicad-cliへ委譲する。<br> | |||
<br> | <br> | ||
これらの確認により、AIによる設計支援と再現可能なレビューを両立できる。<br> | |||
<br> | <br> | ||
<u>最終判断は設計者が行い、MCPサーバを検証工程の代替にしないことが重要である。</u><br> | |||
<br><br> | <br><br> | ||
| 1,297行目: | 2,623行目: | ||
{{#seo: | {{#seo: | ||
|title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki | |title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki | ||
|keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,電気回路,電子回路,基板,プリント基板,MCP,Model Context Protocol,KiCAD,PCB Design,Claude | |keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,電気回路,電子回路,基板,プリント基板,MCP,Model Context Protocol,KiCAD,KiCad 10,KiCad10,PCB Design,Claude,IPC-API,KiCad IPC API,Streamable HTTP,Konnect,Rust,x86_64,AGPL-3.0,Tauri,uvx,kicad-python,kipy,FastMCP,MCP Server | ||
|description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報、KiCAD MCPサーバの統合ガイド | This page is {{PAGENAME}} in our wiki about electronic circuits, SUSE Linux, and KiCAD MCP servers | |description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報、KiCAD MCPサーバの統合ガイド | This page is {{PAGENAME}} in our wiki about electronic circuits, SUSE Linux, and KiCAD MCP servers | ||
|image=/resources/assets/MochiuLogo_Single_Blue.png | |image=/resources/assets/MochiuLogo_Single_Blue.png | ||
| 1,303行目: | 2,629行目: | ||
__FORCETOC__ | __FORCETOC__ | ||
[[カテゴリ:電子回路]][[カテゴリ:PCB]] | [[カテゴリ:電子回路]][[カテゴリ:PCB]][[カテゴリ:設定]] | ||