General Tools
These tools handle project-level operations and editor control.
save_document
Save the current schematic and/or PCB to disk.
save_document doc_type="all"
| Parameter | Type | Description |
|---|---|---|
doc_type | string | "schematic", "pcb", or "all" (default) |
check_status
Get current project status including open editors and unsaved changes.
check_status
Returns project path, open editors, current sheet, and modification state.
launch_editor
Launch the schematic or PCB editor from the project manager.
launch_editor doc_type="schematic"
| Parameter | Type | Description |
|---|---|---|
doc_type | string | "schematic" or "pcb" |
run_terminal
Execute shell commands for file operations, git, and scripting.
run_terminal command="ls -la"
| Parameter | Type | Description |
|---|---|---|
command | string | Shell command to execute |
screenshot
Export PNG renders of schematics or PCB with layer selection.
screenshot target="pcb" layers=["F.Cu", "B.Cu", "Edge.Cuts"]
| Parameter | Type | Description |
|---|---|---|
target | string | "schematic" or "pcb" |
layers | array | PCB layers to include (PCB only) |
output | string | Output file path (optional) |
create_project
Create a new KiCad project with standard file structure.
create_project project_name="my-board" directory="/path/to/projects"
| Parameter | Type | Description |
|---|---|---|
project_name | string | Project name |
directory | string | Directory for the project |
open_project
Open an existing KiCad project.
open_project project_path="/path/to/project.kicad_pro"
| Parameter | Type | Description |
|---|---|---|
project_path | string | Path to .kicad_pro file or directory containing one |