list_schematic_components
Lists all placed schematic components from a .kicad_sch file, including reference and unit per sheet path, with optional filters for DNP status, reference type, and value.
Instructions
Give the components of a schematic file.
Each placed symbol of the file is in the list one time for each sheet path of the file, with the reference and the unit that KiCad gives that path (a sheet that the hierarchy uses two times gives two references). Power symbols are not components. The tool needs kicad-cli (the rules of the KiCad version).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"file_path": "<file_path>"
},
"name": "list_schematic_components"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes | A .kicad_sch file of the project. | |
| filter_dnp | No | Optional: True gives only the DNP components, False only the components that are not DNP. | |
| filter_type | No | Optional start of the references, for example "R", "C" or "U" (no difference of case). | |
| filter_value | No | Optional text in the Value field (no difference of case). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |