connect_kicad
Connect to a running KiCad instance via IPC API. This must be called before any other tool operations.
Instructions
Connect to a running KiCad instance via the IPC API.
This must be called before any other operations. Ensure KiCad is running with the API server enabled in Preferences > Plugins.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "connect_kicad"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| socket_path | No | Optional path to IPC socket. If not provided, reads from KICAD_API_SOCKET environment variable or uses default platform path. | |
| kicad_token | No | Optional API token for authentication. | |
| timeout_ms | No | Connection timeout in milliseconds. Default 2000. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||