Skip to content
verify mcp Beta VerifyMCP is currently in beta. If you notice any issues, get in touch and we’ll put it right.

KiCad Workbench

PYPI · KICAD-WORKBENCH

Gives KiCad 10 projects to LLM agents: schematics, boards, ERC, DRC, BOM, edits

Available components

+19 this week 72 Trust /100

Last scanned (16 hours ago)

Scores higher than 65% of PyPI servers

Category IoT and Hardware

Trust breakdown (7 categories)

How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score → Why this is hard to score →

Supply Chain Security100
  • No malware found by supply-chain analysis.Pass
  • No known CVEs affecting this package version or its production dependencies.Pass
  • Runs hatchling.build at install time, a recognised build step with no custom scripting around it. View diagnostics → Pass
  • 1 of 37 dependencies flagged as unhealthy. View diagnostics → Partial
Provenance & Transparency45
Schema Quality & AI Usability59
  • AI-judged instruction clarity (excellent).Pass
  • Context-footprint check failed: tool/resource definitions use about 24449 tokens (~317/item across 77 items; 77 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
  • Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management43
  • Stability observed for 13 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage99
  • 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
  • 97% of tool parameters carry a description.Partial
  • Structured output schemas are declared (96% of tools); any adoption earns full credit.Pass
Tool Safety75
  • No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.Pass
  • 0 of 3 tool(s) whose name or description implies an irreversible operation declare an MCP destructiveHint annotation; "remove_library_from_table" implies "remove" and declares no destructiveHint at all, which the MCP spec reads as destructive by default. See how to fix → Fail
  • An AI judge read all 78 captured unit(s) of tool text and found none that tries to manipulate the model reading it.Pass
Capabilities100
  • Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
What we tested

Checks we ran (16)

  • Malware scan
  • Known CVEs
  • Install scripts
  • Dependency health
  • Source repository
  • Provenance
  • License
  • Maintenance
  • Security disclosure
  • Schema quality
  • Stability
  • Tool coverage
  • Injection markers
  • Destructive annotations
  • Judged manipulation
  • MCP protocol

Does not apply to this package (2)

  • Endpoint SecurityScored on hosted endpoints only. A package has no live endpoint of its own for us to probe.
  • Transport & ReachabilityScored on hosted endpoints only. A package has no live endpoint of its own for us to probe.

The score does not measure everything. What the score does not measure →

Changelog

Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.

  • 21 Nov 26 +15
    • Malware scan: unverified → pass ▲ security
  • 20 Nov 26 −11
    • Malware scan: pass → unverified ▼ security
    • Schema quality: 188 → 317 ▼ functional
    • Stability: unverified → 0.40 ▲ functional
    • Schema quality: good → excellent functional
    • Destructive annotations: pass → 0 functional
    • Package version: 0.1.0 → 0.2.0 functional
  • 19 Nov 26 +15
    • Malware scan: unverified → pass ▲ security
  • 14 Nov 26 −15
    • Malware scan: pass → unverified ▼ security
  • 13 Nov 26 +15
    • Malware scan: unverified → pass ▲ security
  • 8 Nov 26 53

    First indexed and scored.

Diagnostics

Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.

Captured 21 Nov 2026 · Analysed pypi/kicad-workbench@0.2.0

Provenance No attestation

The registry publishes no build provenance for this version, so there is nothing to verify.

Result No attestation
Ecosystem pypi
Reason No attestation published

Background: How many MCP packages publish verified provenance →

Install scripts 1 script
Hook Tier Command
build_backend Known build tool hatchling.build

Background: Why install scripts are a supply-chain risk →

Dependencies 37 packages
Packages resolved 37
Stale 1
Tree resolution Complete

Background: SBOMs and build attestations, explained →

MCP tools · 77 exposed · ~23,822 tokens

The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability. A tool's description is untrusted text the model reads on every call, which is what makes this list a security surface and not just an inventory: how tool poisoning works →

Tool Tokens
add_component_from_library ~900

Add a symbol of a KiCad symbol library to the schematic. The library comes from the library tables of the installed KiCad and of the project, as in the symbol chooser of KiCad: a library of the project table replaces a global library with the same name. A derived symbol gets the units, the pins and the drawings of its parents. When the schematic has the symbol in its lib_symbols section, the tool uses that definition. The tool gets the version of the installed KiCad from kicad-cli, to find the global library table. The placed symbol gets the fields of the library symbol (Datasheet, Description, user fields) at their library positions, the flags exclude_from_sim, in_bom, on_board and in_pos_files of the library symbol, and the reference of its sheet path, as KiCad places a symbol. The tool does not move the fields (KiCad: autoplace). With KiCad 10.0, the copy of the library symbol and its fields are the text of a save of the library in kicad-cli (a library that KiCad did not save gets the texts of KiCad: no blanks at the ends of a mandatory field, the canonical field names, "<name>_1" for a second field of one name). kicad-cli saves the symbol with its parents one time (about 0.2 s), and again after a change of their text; a cache keeps the last saves. The connection grid is schematic.connection_grid_size of the project file (default 1.27 mm). ERC finds a pin off this grid (endpoint_off_grid). As the schematic editor of KiCad, the tool removes the part of a wire between two pins of the new symbol, and adds a junction where a pin is in the middle of a wire. The output tells each junction and each changed wire. The tool places the symbol at 0 degrees, with no mirror, in body style 1. It cannot rotate or mirror a symbol, and cannot place an other body style (De Morgan): tell the user to do this in KiCad. One call places one unit: for the other units of a package, call the tool again with the same reference and the next unit. The tool does not check that the refer…

NameTypeReqDescription
file_pathstringyesThe .kicad_sch file.
footprintstring–The footprint. Empty: the footprint of the library symbol.
library_namestringyesThe library name of the library tables.
referencestringyesThe reference, for example "R1".
sheet_pathstring–Only for a sheet file that the hierarchy uses more than one time: the sheet that gets the reference, as the sheet names ("/Power/") or the UUID path. The error lists the sheet paths.
snap_to_gridboolean–True: move the symbol to the nearest position that puts its pins on the connection grid. When the move takes a pin away from a connection point of the sheet (a pin, a wire, a label), the symbol stays…
symbol_namestringyesThe symbol name in the library.
unitinteger–The unit, from 1 to the number of units of the symbol.
valuestringyesThe text of the Value field.
xnumber––
ynumber––
NameTypeReqDescription
resultstringyes–

No examples provided.

add_global_label ~522

Add a global label on a pin of a component. A global label connects the nets with its name in all sheets of the project. The tool puts the label on the connection point of the pin (with the rotation and the mirror of the symbol). The angle comes from the direction of the pin, as KiCad orients a label that "Update Schematic from PCB" adds on a pin: the label points away from the body, also on the long side of a tall symbol. The text goes from the point to the right at 0 degrees, up at 90, to the left at 180 and down at 270, as KiCad draws it: a label at 180 has its text to the left of the point. This is correct, not a defect. With x and y, the angle is 0. A new global label has the hidden field Intersheetrefs at its point, as KiCad makes it. KiCad shows the field next to the label only when the schematic setting shows the references to other sheets. This is correct, not a defect. The tool finds the symbol by the Reference field in the file, not by the reference of each sheet path: in a sheet that the hierarchy uses more than one time, the reference of an other sheet path is not found. KiCad must not have the schematic open: the tool refuses the write (the lock file of KiCad). The tool also refuses the write when the file changed after the tool read it. A schematic of an older file version than the installed KiCad writes is an error: the user converts it in KiCad first (the output gives the step).

NameTypeReqDescription
file_pathstringyesThe .kicad_sch file.
label_namestringyesThe name of the net.
pinstringyesThe pin number.
referencestringyesThe reference of the component, for example "U1".
shapestring–The electrical type of the label: "input" (default), "output", "bidirectional", "tri_state" or "passive". ERC uses it.
snap_to_gridboolean–Only for x and y. True: move the label to the nearest point of the connection grid of the project (default 1.27 mm), except on a connection point of the sheet (a pin, a wire, a label).
x–––
y–––
NameTypeReqDescription
resultstringyes–

No examples provided.

add_hierarchical_label ~592

Add a hierarchical label on a pin of a component. A hierarchical label in a sub-sheet connects its net to the pin with the same name of the sheet symbol in the parent sheet. The tool puts the label on the connection point of the pin (with the rotation and the mirror of the symbol). The angle comes from the direction of the pin, as KiCad orients a label that "Update Schematic from PCB" adds on a pin: the label points away from the body, also on the long side of a tall symbol. The text goes from the point to the right at 0 degrees, up at 90, to the left at 180 and down at 270, as KiCad draws it: a label at 180 has its text to the left of the point. This is correct, not a defect. With x and y, the angle is 0. The tool changes only the sub-sheet. It does not add the sheet pin to the sheet symbol in the parent sheet, and KiCad connects the label to the parent sheet only through a sheet pin with the same name. Tell the user to add the sheet pin in the schematic editor of KiCad: until then, ERC gives hier_label_mismatch. Make sure that the connection is in the netlist: generate_netlist. The tool finds the symbol by the Reference field in the file, not by the reference of each sheet path: in a sheet that the hierarchy uses more than one time, the reference of an other sheet path is not found. KiCad must not have the schematic open: the tool refuses the write (the lock file of KiCad). The tool also refuses the write when the file changed after the tool read it. A schematic of an older file version than the installed KiCad writes is an error: the user converts it in KiCad first (the output gives the step).

NameTypeReqDescription
file_pathstringyesThe .kicad_sch file of the sub-sheet.
label_namestring–The text of the label. Empty: "<reference>.<pin>" (also with x and y).
pinstringyesThe pin number.
referencestringyesThe reference of the component, for example "U1".
shapestring–The electrical type of the label: "input" (default), "output", "bidirectional", "tri_state" or "passive". ERC uses it.
snap_to_gridboolean–Only for x and y. True: move the label to the nearest point of the connection grid of the project (default 1.27 mm), except on a connection point of the sheet (a pin, a wire, a label).
x–––
y–––
NameTypeReqDescription
resultstringyes–

No examples provided.

add_label ~382

Add a local label (text label) to the schematic. The text goes from the point to the right at 0 degrees, up at 90, to the left at 180 and down at 270, and KiCad keeps it upright: a label at 180 has its text to the left of the point (right justified), as KiCad draws it. This is correct, not a defect. The point is the connection point: put it on the end of a wire or on a pin. A label connects at each point of a wire, also in its middle: the tool adds no junction for it. A label on a bus names the bus. KiCad must not have the schematic open: the tool refuses the write (the lock file of KiCad). The tool also refuses the write when the file changed after the tool read it. A schematic of an older file version than the installed KiCad writes is an error: the user converts it in KiCad first (the output gives the step).

NameTypeReqDescription
file_pathstringyesThe .kicad_sch file.
orientationnumber–The angle: 0, 90, 180 or 270 (KiCad reads no other angle of a label). Use the angle that points away from the wire or the pin, thus the text does not cover them.
snap_to_gridboolean–True: move the label to the nearest point of the connection grid of the project (default 1.27 mm), except on a connection point of the sheet (a pin, a wire, a label). A label in the middle of a wire…
textstringyesThe label text.
xnumberyes–
ynumberyes–
NameTypeReqDescription
resultstringyes–

No examples provided.

add_library_to_table ~347

Add a KiCad library that exists to the project library table, as the table dialog of KiCad 10 does. The library must be of the KiCad format: a .kicad_sym file or a folder with .kicad_sym files (symbols), a folder with .kicad_mod files (footprints). The tool refuses other formats. A nickname that the project table has is an error. A nickname of the global table gives a warning: the project row hides the global library. A library of an older file version gives a warning with the step for its upgrade; a library of a newer file version is an error. KiCad must not have the project open. The installed KiCad must be KiCad 10.0. The URI of the new row has a path variable of KiCad when its folder holds the library (the variable with the most folder levels), else ${KIPRJMOD} when the project folder holds it, else the absolute path (NormalizePath). As the table dialog, the tool writes some characters of the nickname as escapes, for example ":" as "{colon}".

NameTypeReqDescription
descriptionstring–The description of the row.
kindstringyes"symbol" or "footprint".
library_pathstringyesThe library file or folder: an absolute path, or a path relative to the project folder.
nickname––The nickname in the table. Default: the name of the library with no extension, as KiCad gives it.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

add_wire ~416

Add a wire to the schematic: a line through two or more points. A KiCad wire has two points (SCH_LINE). The tool adds one wire for each segment, as KiCad saves a line with corners. As the schematic editor of KiCad, the tool merges the segments that are on one straight line, merges a new wire with a wire of the sheet on the same straight line that it touches, removes the part of a new wire between the two pins of a symbol with two pins, and adds a junction where three or more wire directions meet (a wire end or a pin in the middle of a wire). The output tells each junction and each changed wire. The connection grid is schematic.connection_grid_size of the project file (default 1.27 mm). ERC finds a wire end off this grid (endpoint_off_grid). The tool adds wires only, not buses or bus entries. A wire that the sheet has already gives "No change". KiCad must not have the schematic open: the tool refuses the write (the lock file of KiCad). The tool also refuses the write when the file changed after the tool read it. A schematic of an older file version than the installed KiCad writes is an error: the user converts it in KiCad first (the output gives the step).

NameTypeReqDescription
file_pathstringyesThe .kicad_sch file.
pointsarrayyesThe points (x, y) in mm. Each point after the first ends a segment.
snap_to_gridboolean–True: move each point to the nearest point of the connection grid. A point on a connection point of the sheet (a pin, a wire end, a junction, a label) stays. A point in the middle of a wire moves onl…
NameTypeReqDescription
resultstringyes–

No examples provided.

analyze_hierarchical_nets ~396

Analyze all nets of the full schematic hierarchy. The tool reads the netlist that kicad-cli writes now: the nets of all sheets at each level of the hierarchy. It groups them as power, interface and signal nets (by their names), and gives the sheet paths of the hierarchy. The groups come from parts of the net names (heuristic): power has VDD, VSS, GND, VCC, VBAT, VPP, +3V or +5V, interface has I2C, SPI, UART, SDA, SCL, MOSI, MISO, TX or RX, and signal is each other net. The tool lists at most 20 power nets, 30 interface nets and 20 signal nets, sorted by name: use filter_pattern for the others. The netlist of KiCad has a net "unconnected-(...)" for each unconnected pin, with the pin name in it: these nets are in the total, and in a group by their names ("unconnected-(U1-TXD-Pad5)" is an interface net). The total counts the nets after filter_pattern.

NameTypeReqDescription
file_pathstringyesA .kicad_sch file of the project (the root schematic or a sub-sheet: the tool uses the netlist of the root schematic).
filter_patternstring–Optional regular expression for the net names (no difference of case), found in a part of the full name with the sheet path ("/Power/VIN"), with the syntax of the Python module re. Empty: all nets. A…
show_hierarchyboolean–True (default): list the sheet paths of the hierarchy with their files.
NameTypeReqDescription
resultstringyes–

No examples provided.

analyze_pcb_nets ~220

Give the routing of a board: track widths, vias, net lengths and layers. The tool gives the distribution of the track widths and of the via drills, the layer spans of the vias, the tracks of each layer, the nets by the length of their tracks, and a comparison with the design rules of the board. The zone count is the count of the copper zones, as the Zone Manager of KiCad lists them: no rule area (keepout), no teardrop, and no zone on non-copper layers only. The tool lists the 20 nets with the longest tracks. The warning about narrow tracks is a rule of the tool (a track narrower than half of the current track width of the board settings), not a DRC result: run_drc gives the checks of KiCad. With the text reader (no pcbnew), the answer has no board size and no comparison with the design rules.

NameTypeReqDescription
file_pathstringyesThe .kicad_pcb file.
NameTypeReqDescription
resultstringyes–

No examples provided.

analyze_pcb_power_integrity ~293

Give the copper zones of a board and the routing of its power nets (heuristic). The tool finds a power net and a ground net from its name, and gives the copper zones of each and the tracks of the power nets. A power net has VDD, VCC, VSS, 3V3, 5V, 1V8, VBUS, LDO or DCDC in its name; a ground net has GND, PGND, AGND, DGND or CHASSIS (no difference between upper and lower case). The copper zones are the zones of the Zone Manager of KiCad: no rule area (keepout), no teardrop, and no zone on non-copper layers only. A zone can be on more than one copper layer: the tool gives all of its copper layers on the board, from the top, and counts each of them for the GND coverage. On a board with more than 2 copper layers, a warning tells when the GND zones are not on each copper layer: this warning comes from the tool, not from a check of KiCad. "filled" is the fill state that the file has. With the text reader (no pcbnew), the zones have no fill state.

NameTypeReqDescription
file_pathstringyesThe .kicad_pcb file.
NameTypeReqDescription
resultstringyes–

No examples provided.

analyze_pcb_signal_integrity ~307

Give the differential pairs, the RF tracks and the longest signal nets of a board (heuristic). The tool finds a differential pair from the ends of two net names, case-sensitive: _P/_N, _DP/_DN, _TXP/_TXN, _RXP/_RXN, _M/_S and _POS/_NEG (for example USB_DP and USB_DN). It does not find + and - (USB_D+ and USB_D-). The status of a pair uses fixed limits of the tool (OK below 0.127 mm, Marginal below 0.5 mm, else Mismatch), not the rules of the board. The length is the sum of the track segments, with no vias and no pads. An RF net has ANT, RF or FEED in its name, and not VDD or GND. The longest signal nets (15) are the nets whose name has no power word (VDD, VCC, GND, VSS, 3V3, 5V, 1V8, PGND, VBUS). The tool also gives the 10 nets with the most vias. With the text reader (no pcbnew), the answer has no design rules of the differential pairs.

NameTypeReqDescription
file_pathstringyesThe .kicad_pcb file.
net_namestring–Optional name of one net to analyze in detail.
NameTypeReqDescription
resultstringyes–

No examples provided.

assign_footprint ~686

Assign footprints to placed symbols, as CvPcb ("Assign Footprints") of KiCad 10 does it when it saves. The tool writes the footprint into the Footprint field of each unit of the reference, in the symbol, not in a variant. A variant with a Footprint of its own keeps it (the tool gives a warning; set_symbol_fields with the variant changes it). When the old footprint is empty and the field is visible, the field becomes hidden, as the save of CvPcb does ("Footprint field visible" in the table), also when the footprint stays empty. CvPcb hides such a field in each symbol of the netlist; the tool changes only the references of the call. An empty footprint removes the footprint. The tool checks each footprint as CvPcb has it: - The footprint must be in a library that KiCad loads (the global and the project footprint library tables, an enabled row of the type "KiCad"), with the same case: else an error. - The footprint filters of the symbol (anchored wildcards, with no difference of case; a filter with ":" compares "<library>:<footprint>") and the pin count (the pins of the symbol against the pads of the footprint) give a warning when they do not match. CvPcb then does not show the footprint in that filtered list. The tool still writes the footprint. The tool gets the pin count and the filters from the netlist of kicad-cli (the netlist that CvPcb reads). It refuses a reference that the netlist does not have (a symbol that is excluded from the board, or in a sheet that is excluded from the board), a power symbol (a reference that starts with "#"), a reference that is not annotated (U?), a duplicate reference, a symbol with no Footprint field, a Footprint field with a text variable (KiCad compares the resolved text), a footprint ID with no library name, and a library of an other type than "KiCad". With kicad-cli 10.0.0 to 10.0.6, a project with more than one top-level sheet is an error. A symbol in a sheet that the hierarchy uses more than one time has one Fo…

NameTypeReqDescription
assignmentsarrayyesOne item for each reference: the reference and the footprint ("<library>:<footprint>", or empty to remove it).
schematic_pathstringyesA .kicad_sch file of the project. The tool finds the references in the full project.
NameTypeReqDescription
resultstringyes–

No examples provided.

check_library_links ~157

Check the links of a project to its symbol and footprint libraries and 3D models. The tool uses the checks of KiCad: ERC for the symbols of the schematic (a library or a symbol that KiCad does not find, a symbol that is not equal to its library symbol) and DRC for the footprints of the board. It finds the footprints of the schematic as "Update PCB from Schematic" does, and the 3D models of the footprints as the STEP export does (KiCad does not check them).

NameTypeReqDescription
project_pathstringyesThe project: a .kicad_pro, .kicad_sch or .kicad_pcb file, or its directory.
NameTypeReqDescription
resultstringyes–

No examples provided.

check_pin_pad_mapping ~245

Compare the pin numbers of a library symbol with the pad numbers of a footprint. The tool uses the rules of "Update PCB from Schematic" of the installed KiCad. A pin number that no pad has, and a pin with no number, are errors. A pad with a number that no pin has gets no net: this is a warning. KiCad 10 reads a stacked pin number ("[1-4]") as more than one pad number. The check uses the pins of all units, for each body style. A power symbol gives an error: KiCad puts no power symbol into the netlist.

NameTypeReqDescription
footprint_lib_idstring–Optional library ID of the footprint, for example "Resistor_SMD:R_0603_1608Metric". If empty, the tool uses the Footprint field of the symbol.
project_pathstring–Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.
symbol_lib_idstringyesThe library ID of the symbol, for example "Device:R".
NameTypeReqDescription
resultstringyes–

No examples provided.

check_schematic_pin_pad_mapping ~274

Compare the pins of each symbol of a schematic with the pads of its footprint. The tool uses the netlist that "Update PCB from Schematic" gives pcbnew (kicad-cli of the installed KiCad), and the rules of that update. A pin number that no pad has, a pin with no number, and a symbol whose footprint KiCad does not find are errors. A pad with a number that no pin has gets no net: this is a warning. A symbol has the pins of the units that the schematic has. The pads come from the library footprints, as a new footprint on the board gets them. For a board that has the footprints, run_drc with the schematic parity compares the footprints of the board. For a library symbol and a footprint, use check_pin_pad_mapping. When the netlist job finds annotation errors (a duplicate reference can join two symbols in one component), the tool lists them.

NameTypeReqDescription
references––Optional references to check, for example ["U1", "J3"]. All symbols of the netlist if empty.
schematic_pathstringyesA schematic of the project (.kicad_sch). For a sub-sheet or an other top-level sheet, the tool uses the project.
NameTypeReqDescription
resultstringyes–

No examples provided.

check_symbol_fields ~407

Check the MPNs of the symbols: the fields Value, MPN, Value_Confirmed and MPN_Confirmed. Use this tool only when the MCP server datasheet-lens is not available: its tool project_check does the same check, and also checks the datasheets. The two tools give the same messages (a datasheet-lens with the model of the four fields, of 2026-11-07 or later: an older one reads the MPNs from the parentheses of Value). The convention: Value holds the general value ("2N7002", "100nF 10V"), the field MPN the MPNs, the fitted part first ("2N7002LT1G, BSS138LT1G"; the separators are "," and ";", an MPN with "," or ";" is in quotes, as in CSV), and the hidden fields Value_Confirmed and MPN_Confirmed the copies of the last confirmation. A symbol with the MPNs in the parentheses of Value (the old convention) gets the move into the field MPN. The tool reads the BOM of kicad-cli (also the DNP symbols: the user can fit them at any time) of the default variant and of each variant (KiCad 10). For each symbol it gives the conflicts, the changes that the user must confirm, the symbols that are not confirmed, the moves of the old convention, and the symbols with no part. Each message gives the change for set_symbol_fields. Write the fields only after the user confirmed them. A symbol with "Exclude from BOM" is not in the BOM of kicad-cli: the tool does not check its fields. A power symbol is never in the BOM.

NameTypeReqDescription
schematic_pathstringyesA .kicad_sch file of the project. The tool checks the full project.
NameTypeReqDescription
resultstringyes–

No examples provided.

copy_footprint_to_library ~240

Copy a footprint into a library of the project table, as "Save As" of the footprint editor of KiCad 10 does. The Value gets the new name when it was equal to the old name. KiCad saves the footprint (kicad-cli), and a second save must give the same bytes. The target must be a footprint library of the project table in the version of the installed KiCad (else: upgrade_project_libraries first). A footprint that is not on F.Cu is refused. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
lib_idstringyesThe footprint, "<library>:<footprint>".
new_name––The new name. Default: the old name.
overwriteboolean–True replaces a footprint with the same name in the target (KiCad: Overwrite). False refuses it.
project_pathstringyesThe .kicad_pro file or the project folder.
target_librarystringyesThe nickname of the target in the project footprint table.
NameTypeReqDescription
resultstringyes–

No examples provided.

copy_symbol_to_library ~426

Copy a symbol into a library of the project table, as "Save As" of the symbol editor of KiCad 10 does. To an other library, a derived symbol goes with its parents (KiCad copies the full parent chain; only the symbol gets the new name). flatten=True saves only the flattened symbol, as the "Flatten" check box. The Value gets the new name when it was equal to the old name. The copy starts from the symbols as KiCad loads them: the text of a save of the library in kicad-cli (about 0.2 s, a cache keeps the last saves). Thus a library that KiCad did not save gives the texts of KiCad: no blanks at the ends of a mandatory field, the canonical field names ("value" is "Value"), "<name>_1" for a second field of one name. The Value follows the new name also when the file has "value" or blanks at the ends of the old name. KiCad saves the library (kicad-cli), and a second save must give the same bytes. The target must be a symbol library file of the project table in the version of the installed KiCad (else: upgrade_project_libraries first). KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
flattenboolean–True saves only the flattened symbol, with no parent.
lib_idstringyesThe symbol, "<library>:<symbol>", for example "Device:R".
new_name––The new name. KiCad changes spaces to "_". Default: the old name.
overwriteboolean–True replaces the symbols with the same names in the target (KiCad: Overwrite / Overwrite All). False refuses them.
project_pathstringyesThe .kicad_pro file or the project folder.
target_librarystringyesThe nickname of the target in the project symbol table.
NameTypeReqDescription
resultstringyes–

No examples provided.

create_derived_symbol ~498

Make a new symbol that extends a symbol of the same project library, as "Derive from existing symbol" of the symbol editor of KiCad 10 does. The new symbol has the units, the pins and the drawings of its parent (extends). Its mandatory fields are copies of the fields of the parent: the Footprint and the Datasheet are empty unless keep_footprint and keep_datasheet; the Value of a power symbol is the new name. With transfer_user_fields, the new symbol gets a copy of each user field of the parent (MPN, for example), with an empty text unless keep_user_field_content. The arguments have the defaults of the dialog of KiCad (the check boxes are off). KiCad 10.0 saves the keywords and the footprint filters of the parent into the new symbol (LIB_SYMBOL::GetKeyWords). Set the Value, the MPN and the other fields after this with set_library_symbol_properties. The parent must be in a library of the project table, in the version of the installed KiCad: for a symbol of a global library, copy it first with copy_symbol_to_library. As the dialog, the tool writes the escapes of the name ("{colon}" for ":") and a space as "_". A name that the library has already is an error: the tool does not replace a symbol. KiCad saves the library (kicad-cli), and a second save must give the same bytes. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
keep_datasheetboolean–Keep the Datasheet of the parent ("Keep linked datasheet").
keep_footprintboolean–Keep the Footprint of the parent ("Keep linked footprint").
keep_user_field_contentboolean–With transfer_user_fields, keep their texts ("Keep content of user-defined fields").
namestringyesThe name of the new symbol.
parent_lib_idstringyesThe parent, "<library>:<symbol>", of a library of the project table. The new symbol goes into the same library.
project_pathstringyesThe .kicad_pro file or the project folder.
transfer_user_fieldsboolean–Copy the user fields of the parent ("Transfer user-defined fields").
NameTypeReqDescription
resultstringyes–

No examples provided.

create_kicad_project ~460

Create a new KiCad project, as the project manager of the installed KiCad (8, 9 or 10) makes it. With no template ("empty"), the project gets the files of "New Project" of KiCad: KiCad 8 and 9 copy the project file kicad.kicad_pro of KiCad and write an empty schematic and board. KiCad 10 makes the project from its template "default" (it makes that template when it is not there). With a template, the project gets the files of "New Project from Template": the files of the template with the project name in the place of the template name, then the files that are missing. KiCad does not change the files of a template. The tool then writes the title, the company and the date into the title block of the root schematic that it wrote. When the project folder is not empty (no template), or it has files of the template, KiCad asks the user. The tool then gives an error: ask the user, then call it again with overwrite=True.

NameTypeReqDescription
companystring–Optional name of the company.
overwriteboolean–True after the user confirmed: with a template, the files of the template replace the files with the same names; with no template, the tool makes the project in a folder that is not empty (the files…
project_namestringyesName of the project. As in the file dialog of KiCad, the extension ".kicad_pro" (or a last ".") goes: "board.kicad_pro" gives "board".
project_pathstringyesThe folder of the project.
templatestring–"empty" (default) for a blank project, or a KiCad template: a name on the template pages of KiCad (KICAD_USER_TEMPLATE_DIR and KICAD<version>_TEMPLATE_DIR, for example "Arduino_Uno") or the path of a…
titlestring–Optional title of the project. Default: project_name.
NameTypeReqDescription
resultstringyes–

No examples provided.

create_project_library ~256

Make a new, empty library and add it to the project library table, as "New Library" of the symbol editor and of the footprint editor of KiCad 10 does. A symbol library is a .kicad_sym file with no symbols, in the format of KiCad 10.0. A footprint library is an empty .pretty folder. The new row has the nickname name, the type KiCad, and a URI with a path variable of KiCad or ${KIPRJMOD} when one holds the library. The tool does not replace a library that exists. KiCad must not have the project open: KiCad reads the project tables only when it opens the project. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
folder––The folder of the new library: an absolute path, or a path relative to the project folder. Default: the project folder.
kindstringyes"symbol" or "footprint".
namestringyesThe name of the library: the file name with no extension, and the nickname in the table.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

delete_library_footprint ~222

Delete a footprint from a project library, as "Delete" of the library tree of the footprint editor of KiCad 10 does: KiCad removes the file of the footprint. KiCad does not change the uses of the footprint, and neither does the tool: the answer gives as a warning the Footprint fields of the placed symbols (also of their variants) and of the symbols of the project symbol libraries, and the footprints of the board of the project, that have its library ID. The board keeps its copy of each footprint. The library must be a footprint library of the project table, in the version of the installed KiCad (else: upgrade_project_libraries first). KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
lib_idstringyesThe footprint, "<library>:<footprint>", of a library of the project table.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

delete_library_symbol ~291

Delete a symbol from a project library, as "Delete" of the library tree of the symbol editor of KiCad 10 does. KiCad deletes a symbol together with all symbols derived from it (also the derived symbols of a derived symbol). With delete_derived=False, a symbol with derived symbols is an error that gives their names. delete_derived=True deletes them all, as "Delete All Listed Symbols" of KiCad. KiCad does not change the schematics that use a deleted symbol, and neither does the tool: the answer gives the placed symbols with a deleted lib_id as a warning. The schematic keeps its copy of each symbol, but an update from the library then fails. The library must be a symbol library file of the project table, in the version of the installed KiCad (else: upgrade_project_libraries first). KiCad saves the library (kicad-cli), and a second save must give the same bytes. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
delete_derivedboolean–True deletes the symbols derived from the symbol too.
lib_idstringyesThe symbol, "<library>:<symbol>", of a library of the project table.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

detect_pin_conflicts ~465

Give the pin conflicts of a schematic: the items of the ERC of kicad-cli about the connections of the symbol pins. The tool runs the ERC of kicad-cli on the full project (as run_erc, with the severities, the pin map and the exclusions of the project) and gives only these items of the ERC of KiCad 10: - pin_to_pin: two connected pins whose electrical types conflict in the pin map of the project (an error or a warning). In the default pin map of KiCad, two open collector pins, two open emitter pins or two tri-state pins are OK: a wired OR or a tri-state bus is not a conflict. - pin_not_driven, power_pin_not_driven: an input or a power input pin with no output or power output pin on its net. - pin_not_connected, no_connect_connected: a pin with no connection and no "no connection" flag, or a pin with the flag that is connected. - isolated_pin_label: a label that connects to only one pin. - duplicate_pins, different_unit_net: pins of one number, or a shared pin of the units, on different nets. - ground_pin_not_ground: a ground pin that is not on a ground net. - missing_input_pin, missing_bidi_pin, missing_power_pin: the pins of a unit that is not placed. The other items of the ERC (for example a wire end off the grid) are in run_erc. The tool uses the last ERC report until a schematic file or a project file changes: then it runs the ERC again. An excluded violation shows with "(excluded)" and does not count. "✅" comes only when the schematic is fully annotated: KiCad connects the pins by their references. With KiCad 8 or 9 installed, the answer has a warning: the list of items is the list of KiCad 10.

NameTypeReqDescription
schematic_pathstringyesA .kicad_sch file of the project.
severitystring–Optional severity: "error" or "warning". Empty: all violations.
NameTypeReqDescription
resultstringyes–

No examples provided.

download_registry_part ~249

Download the files of a part of the parts registry into a local folder. The tool downloads only through HTTPS, only from the hosts of the registry, at most 50 MB for each file, and only the file extensions of each format. The tool replaces a file with the same name in save_dir. It does not check the file version, and does not add the files to a library table: KiCad reads a .kicad_mod file only in a footprint library folder (.pretty). Add the library with add_library_to_table: then copy_symbol_to_library and copy_footprint_to_library can copy its items into a project library.

NameTypeReqDescription
formats––The files to download: "footprint", "symbol", "step", "preview" (.glb), "footprint_svg" and "symbol_svg". Default: the footprint and the symbol.
part_idstringyesThe ID of the part (search_parts_registry gives it).
save_dirstringyesA folder that exists, for example the library folder of the project: in the working folder, the home folder or a folder of PARTS_REGISTRY_SAVE_ROOTS.
NameTypeReqDescription
resultstringyes–

No examples provided.

export_bom ~576

Give the bill of materials (BOM) of a schematic, as KiCad makes it. The tool runs "kicad-cli sch export bom" for the full project of the schematic, and gives its lines as a table. Without group_by, each reference is one line. KiCad does not put the power symbols and the symbols that are excluded from the BOM into the BOM. The units of one package (one reference, U1A and U1B) must have the same Value, MPN, Value_Confirmed and MPN_Confirmed. When they do not, the output starts with an error of the design: the BOM line of the package joins the values, and the joined MPNs look like an MPN and its alternative. Tell the user, and correct the fields in KiCad. For project_check of datasheet-lens, give output_path and no group_by. Then give the path of the CSV file to project_check (argument bom). For a project with variants (KiCad 10), also give all_variants: then give the list of the files that the tool names to project_check.

NameTypeReqDescription
all_variantsboolean–True to export the default variant and each variant of the project (KiCad 10 and later), one kicad-cli run and one CSV file for each: the default variant into output_path, the variant X into <stem>-X…
exclude_dnpboolean–True to remove the symbols that have DNP.
fields––The fields of the BOM, in their order. "*" adds all other fields. A generated field has the form "${QUANTITY}" or "${DNP}". Default: Reference, Value, Footprint, Datasheet, ${QUANTITY}, ${DNP} and "*…
group_by––The fields whose equal values put symbols into one line. Each name must be an item of fields: a field that "*" adds does not group the symbols. Default: no groups.
output_pathstring–The CSV file to write, as kicad-cli writes it. A relative path is relative to the project directory. The tool does not expand variables. The tool replaces an existing file. Empty: the tool keeps no f…
schematic_pathstringyesA .kicad_sch file of the project. The BOM is the BOM of the full project, also for a sub-sheet.
variantstring–The name of a variant of the project (KiCad 10 and later). Empty: the default variant.
NameTypeReqDescription
resultstringyes–

No examples provided.

export_drc_report ~277

Run the DRC of kicad-cli on a board and copy its JSON report into a file. The tool replaces an existing output file. The JSON report is the report of kicad-cli: it has the excluded violations ("excluded": true).

NameTypeReqDescription
output_pathstring–Optional file of the report. Default: <board>_drc_report.json next to the board, or <board>_drc_refill_report.json with refill_zones (the JSON report of kicad-cli does not tell the zone mode).
pcb_pathstringyesThe .kicad_pcb file.
refill_zonesboolean–True: kicad-cli fills all zones again before the DRC (--refill-zones), as the DRC dialog of KiCad does by default (its check box "Refill all zones before performing DRC" is on). The fill is only in m…
NameTypeReqDescription
resultstringyes–

No examples provided.

export_erc_report ~124

Run the ERC of kicad-cli on a schematic and copy its JSON report into a file. The tool replaces an existing output file. The JSON report is the report of kicad-cli: it has the excluded violations ("excluded": true), and not the annotation errors of the ERC dialog (the answer tells them).

NameTypeReqDescription
output_pathstring–Optional file of the report. Default: <schematic>_erc_report.json next to the schematic.
schematic_pathstringyesA .kicad_sch file of the project.
NameTypeReqDescription
resultstringyes–

No examples provided.

export_gerber ~461

Export the Gerber and drill files of a board with kicad-cli, for fabrication. The tool runs "kicad-cli pcb export gerbers", then "kicad-cli pcb export drill", and gives the files that kicad-cli wrote. The Gerber files use the plot settings that the board saves, as the Plot dialog of KiCad (--board-plot-params, PCBNEW_JOBS_HANDLER::JobExportGerbers): the options of the dialog and its selection of the layers that are not copper. kicad-cli plots each copper layer of the board, also a copper layer that the dialog does not select. The output folder of the dialog has no effect: the files go to output_dir. The drill files have the drill origin of the board (the auxiliary origin when the plot settings use it, as the drill dialog). The other options of the drill dialog (format, units, zeros, map) are settings of the user, not of the board: the drill files use the default options of kicad-cli (Excellon, mm). kicad-cli always writes the Gerber job file (.gbrjob), also when the plot settings of the board do not create it: kicad-cli has no option for it. The tool deletes no file in output_dir: a file of an earlier export stays, and the list gives only the files that this export wrote or changed. A failed drill export is a warning: the Gerber files stay.

NameTypeReqDescription
output_dirstring–Optional folder of the files. Default: the folder "gerber" next to the board.
pcb_pathstringyesThe .kicad_pcb file.
refill_zonesboolean–True: kicad-cli fills all zones again before the plot (--check-zones), as the Plot dialog of KiCad does by default (its check box "Check zone fills before plotting" is on). The fill is only in memory…
NameTypeReqDescription
resultstringyes–

No examples provided.

export_pcb_3d ~168

Export a board as a STEP 3D model with kicad-cli, for mechanical CAD. The model has the board and the 3D models of its footprints. kicad-cli does not add a 3D model that it cannot find or read: the tool then gives a warning with the footprints and the reason. Tell the user about each such footprint. The tool replaces an existing STEP file with the same name.

NameTypeReqDescription
board_onlyboolean–True gives only the board, with no models of the footprints.
output_pathstring–Optional .step or .stp file. Default: <board>.step next to the board.
pcb_pathstringyesThe .kicad_pcb file.
NameTypeReqDescription
resultstringyes–

No examples provided.

export_schematic_svg ~205

Export the pages of a schematic as SVG files with kicad-cli. kicad-cli renders the pages of the project with the hierarchy of its root schematic (the schematic of the project name), thus each page has the references of its sheet path. For the root schematic, the files are all pages of the project. For an other file (a sub-sheet), the files are the pages of its sheet paths (a sheet that the hierarchy uses two times gives two pages). An SVG file is a vector image: a zoom shows each detail with no loss. The tool needs kicad-cli. The tool replaces a file with the same name in output_dir; the other files of the folder stay.

NameTypeReqDescription
output_dirstring–Optional folder of the files. Default: <schematic>_svg next to the schematic.
schematic_pathstringyesA .kicad_sch file of the project.
NameTypeReqDescription
resultstringyes–

No examples provided.

find_tracks_by_net ~291

Give the tracks and the vias of one net of a board, with their lengths and widths. The tool also gives the copper zones of the net (no rule area, no teardrop), each with all of its copper layers on the board, from the top. "Track Layers" is the layers of the tracks only. For a net with no tracks, vias or zones, the tool gives the nets whose name contains the name (no difference between upper and lower case). The layers are the standard names of the copper layers (F.Cu, In1.Cu, B.Cu), also when the layer table of the board has user names for them ("Top"): KiCad shows the user names in its GUI. Give the full net name of the board, case-sensitive (for example "/SDA" for a local label of the root sheet). The total length is the sum of the track segments, with no vias and no pads. The tables show 50 segments and 20 vias, in the order of the board file. The warning about different track widths comes from the tool, not from a DRC. With the text reader (no pcbnew), the zones have no fill state.

NameTypeReqDescription
file_pathstringyesThe .kicad_pcb file.
net_namestringyesThe name of the net.
NameTypeReqDescription
resultstringyes–

No examples provided.

generate_netlist ~137

Make the netlist of a schematic with kicad-cli, and give the path of its file. kicad-cli writes the netlist (KiCad XML) of the full project into a file in the temporary folder of the system. Give this file to trace_netlist_connection, get_netlist_nets and get_netlist_components. Make the netlist again after a change of the schematic. The file name comes from the root schematic: each call replaces the netlist file of an earlier call for the same project.

NameTypeReqDescription
schematic_pathstringyesA .kicad_sch file of the project.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_drc_violations ~337

Give the DRC violations of a board, with a filter by type. The tool uses the last DRC report of the same zone mode until the board, a project file, a .kicad_dru file or a schematic of the project changes: then it runs the DRC again (run_drc). The list has all violations of the type. An excluded violation shows with "(excluded)" and does not count. A filter that matches no active violation gives "✅" only when the board has no active violation of an other type, else "⚠️" with their count (also for a type with a typing error).

NameTypeReqDescription
pcb_pathstringyesThe .kicad_pcb file.
refill_zonesboolean–True: kicad-cli fills all zones again before the DRC (--refill-zones), as the DRC dialog of KiCad does by default (its check box "Refill all zones before performing DRC" is on). The fill is only in m…
violation_typestring–Optional type of the violations, as the DRC report of KiCad gives it, for example "clearance". Empty: all violations.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_erc_violations ~129

Give the ERC violations of a schematic, with a filter by severity. The tool uses the last ERC report until a schematic file or a project file changes: then it runs the ERC again (as run_erc, with the annotation check of the ERC dialog). The list has all violations of the severity. An excluded violation shows with "(excluded)" and does not count.

NameTypeReqDescription
schematic_pathstringyesA .kicad_sch file of the project.
severitystring–Optional severity: "error" or "warning". Empty: all violations.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_library_footprint ~181

Show the content of a footprint of a KiCad library: pads, courtyard, attributes, 3D models. The library comes from the library tables of the installed KiCad and of the project, as in the footprint chooser of KiCad. pcbnew of the installed KiCad reads the footprint, thus the values are those of KiCad. The tool finds the file of each 3D model as KiCad finds it.

NameTypeReqDescription
lib_idstringyesThe library ID, for example "Resistor_SMD:R_0603_1608Metric".
project_pathstring–Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries and to set ${KIPRJMOD} for the 3D models.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_library_symbol ~221

Show the content of a symbol of a KiCad library: fields, units and pins. The library comes from the library tables of the installed KiCad and of the project, as in the symbol chooser of KiCad. A derived symbol (extends ...) is shown as KiCad places it: the fields of the symbol and of its parents, the flags of its parent, and the units and pins of its root symbol. The tool reads symbol libraries of KiCad 8 and later. An older library gives an error with the step for the user (kicad-cli sym upgrade), and a library of a newer version than the installed KiCad gives an error.

NameTypeReqDescription
lib_idstringyesThe library ID, for example "Device:R" or "MCU_ST_STM32F4:STM32F405RGTx".
project_pathstring–Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_netlist_components ~104

Give the components of a netlist file with the nets of their pins. Total Components counts all components of the netlist, also with filter_ref. The netlist has no power symbols.

NameTypeReqDescription
filter_refstring–Optional start of the references to give, for example "R", "U" or "C" (the case is important). Empty: all components.
netlist_pathstringyesA netlist file of generate_netlist.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_netlist_nets ~177

Give the nets of a netlist file with their pins. Total Nets counts all nets of the netlist, also with filter_pattern. Each net shows its first 10 pins. The netlist of KiCad has a net "unconnected-(...)" for each unconnected pin: these nets are in the list.

NameTypeReqDescription
filter_patternstring–Optional regular expression for the net names (the syntax of the Python module re, no difference of case), found in a part of the full name with the sheet path. Empty: all nets. A pattern that is not…
netlist_pathstringyesA netlist file of generate_netlist.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_pcb_statistics ~196

Give the size, the layers, the counts and the design rules of a board. The zone count is the count of the copper zones, as the Zone Manager of KiCad lists them: no rule area (keepout), no teardrop, and no zone on non-copper layers only. The size is the bounding box of the Edge.Cuts shapes of the board and of its footprints, with the line width (BOARD::ComputeBoundingBox): an outline of 100 x 100 mm with lines of 0.15 mm gives 100.15 x 100.15 mm. The pad count is all pads of the footprints, also NPTH (FOOTPRINT::GetPadCount). With the text reader (no pcbnew), the answer has no size, no net count and no design rules.

NameTypeReqDescription
file_pathstringyesThe .kicad_pcb file.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_registry_part ~78

Give the full record of one part of the parts registry. The record has the download URLs (footprint, symbol, 3D model), the link to the datasheet, the origin of the dimensions, and the reports of real builds.

NameTypeReqDescription
part_idstringyesThe ID of the part (search_parts_registry gives it).
NameTypeReqDescription
resultstringyes–

No examples provided.

get_schematic_info ~141

Give the title block, the counts and the sheets of a schematic file. The components and the sheet symbols are the ones that KiCad loads for the project of the file (the references of each sheet path). The tool needs kicad-cli (the rules of the KiCad version). A package with more units is one component. Total Nets is the number of the names of the labels and of the power symbols of the file (as list_schematic_nets gives them), not the number of the nets of the netlist.

NameTypeReqDescription
file_pathstringyesA .kicad_sch file of the project.
NameTypeReqDescription
resultstringyes–

No examples provided.

get_symbol_details ~307

Give the fields and the pins of one component of a schematic. The fields are each field of the placed symbol as KiCad 10 loads it: the mandatory fields (Reference, Value, Footprint, Datasheet, Description), then the user fields (for example MPN) in the order of the file. Each text is a JSON string: "" is an empty field, and "\n" in it is a line feed. Some properties of the result come from the load of KiCad and are correct: - "~" of a file older than KiCad 10 is an empty text. KiCad removes the white space at the two ends of the text of a mandatory field, not of a user field. - A user field with the name of an earlier field gets the name "<name>_1" (to "<name>_9"). Limits: the tool reads the saved files, thus a change that KiCad has not saved is not in the result. The position, the unit, the sheet and the fields come from the first placed unit. A unit of the package with other field texts gets a warning line. With KiCad 8 or 9 installed, the tool gives only the mandatory fields.

NameTypeReqDescription
file_pathstringyesA .kicad_sch file of the project.
referencestringyesThe reference of the component, for example "R1" or "U1".
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_add_board_outline ~248

Add the board outline: one closed polygon on Edge.Cuts of the board in the PCB editor, when the board has no Edge.Cuts shapes. KiCad adds the outline in one undo step. A board that has Edge.Cuts shapes gives an error: the tools delete no items (KiCad 10.0.6 gives no result of a delete, limit delete_results); the user deletes the old outline in the PCB editor. Footprints can have Edge.Cuts shapes too: the tool does not count them. KiCad 10.0.6 must have the schematic editor closed (KiCad bug #24966). An outline that crosses itself, has the same point two times one after the other, or has no area gives an error.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
line_width_mm––The line width. Default: the graphics defaults of the board for Edge.Cuts.
outlinearrayyesThe corners of the outline in mm (3 or more points, the first point not again at the end).
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_add_tracks ~352

Add straight tracks and through vias on one net of the board in the PCB editor. KiCad adds the items in one undo step. The sizes come from the netclass of the net, or from the arguments (the router of the PCB editor uses the sizes that the user selected in the editor, which can be other sizes). KiCad checks no clearance: the answer tells the user to run DRC. The tool refuses a net that the board does not have. KiCad 10.0.6 must have the schematic editor closed (KiCad bug #24966). When the running KiCad has the limit free_via (ipc_status), each via must be at an end of a new track of the same call: an other via gives an error. A track with the same start and end, and a via drill that is not smaller than the via size, give an error. After an error, the tool changed nothing.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
netstringyesThe name of the net, for example "GND" or "/SDA" (case-sensitive).
tracks––The tracks: start, end (mm) and copper layer of each one.
via_drill_mm––The via drill. Default: the via drill of the netclass.
via_size_mm––The via diameter. Default: the via size of the netclass.
vias––The positions of the through vias (mm).
width_mm––The track width. Default: the track width of the netclass.
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_add_zone ~557

Add a copper zone with a solid fill on one net and one copper layer of the board in the PCB editor. The API gives no default zone settings: the settings are required arguments. When the user did not give them, ask the user. KiCad adds the zone in one undo step, with no fill: fill it with ipc_refill_zones. KiCad checks no clearance: the answer tells the user to run DRC. KiCad 10.0.6 must have the schematic editor closed (KiCad bug #24966). An outline that crosses itself, has the same point two times one after the other, or has no area gives an error.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
border_pitch_mmnumberyesThe pitch of the border hatch, 0.1 to 2 mm.
border_stylestringyesThe border of the zone in the editor: "solid", "hatched_edge" or "hatched_full".
clearance_mm––An own clearance of the zone, 0 to 100 mm: KiCad uses the larger of it and the current clearance of the netclass and the rules. Default: none (0), thus only the netclass and the rules apply.
connectionstringyesThe connection of pads: "thermal" (thermal reliefs), "solid", "none", or "thermal_pth" (thermal reliefs for through-hole pads only).
island_removalstringyesRemove isolated islands of the fill: "always" or "never". (The mode with a minimum area is not possible: the API gives no unit for it.)
layerstringyesA copper layer of the board, for example F.Cu.
min_thickness_mmnumberyesThe minimum width of the fill, 0.025 mm or more.
namestring–The name of the zone (optional, not the name of an other zone).
netstringyesThe name of the net, for example "GND" (case-sensitive).
outlinearrayyesThe corners of the zone outline in mm (3 or more points, the first point not again at the end).
priorityintegeryesThe zone priority (0 or more).
thermal_gap_mmnumberyesThe thermal relief gap (KiCad keeps it also for a solid connection: a pad can have its own thermal connection).
thermal_spoke_width_mmnumberyesThe thermal spoke width, not smaller than min_thickness_mm.
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_get_selection ~52

Show the items that the user selected in the PCB editor of the running KiCad.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_place_footprints ~300

Place footprints on the board in the PCB editor of the running KiCad. KiCad does the change. One call is one undo step. The tool checks all placements first, and changes nothing when a check fails. The tool can only change the side: a change of the position, the rotation or the lock gives an error (the limits footprint_update_loses_data and footprint_move_children of ipc_status). A footprint that is not on F.Cu or B.Cu gives an error.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
flip_directionstringyesThe flip of a footprint to the other side: "left_right" (around the Y axis) or "top_bottom" (around the X axis). KiCad flips around the position of the footprint. The API cannot read the flip directi…
override_locksboolean–Flip also a locked footprint, as the PCB editor does with "Override locks". With false, a locked footprint that must change its side gives an error.
placementsarrayyesFor each footprint: the reference, and the side ("top" or "bottom"). x_mm, y_mm, rotation_deg and locked give an error.
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_refill_zones ~110

Fill all zones of the board in the PCB editor of the running KiCad. KiCad fills the zones as "Fill All Zones" does, with its progress dialog. The tool waits for the end of the fill.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
timeout_snumber–The longest time to wait for the end of the fill, 1 to 3600 s.
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_save_board ~80

Save the board of the PCB editor of the running KiCad into its file. KiCad saves the board as File > Save does, also the project file. KiCad writes the file version of the running KiCad.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
NameTypeReqDescription
resultstringyes–

No examples provided.

ipc_select_items ~211

Select items in the PCB editor of the running KiCad, by reference or by net. The selection is no change of the board: KiCad makes no undo step for it. The selection filter of the PCB editor does not apply: the API cannot read it.

NameTypeReqDescription
board_pathstringyesThe path of the .kicad_pcb file that is open in the PCB editor.
modestring–"replace" (clear the selection, then select the items), "add", "remove" (remove the items from the selection), or "clear" (no references and no nets).
nets––The net names, for example ["GND", "/SDA"]. They are case-sensitive. A net gives its tracks, arcs, vias and shapes: the item types of "Select All Tracks in Net" of KiCad.
references––The references of footprints, for example ["R1", "U3"]. They are case-sensitive.
NameTypeReqDescription
resultstringyes–

No examples provided.

Install

How do I install the KiCad Workbench MCP server?

KiCad Workbench runs locally as a PyPI package, launched with uvx kicad-workbench. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.

pypi · kicad-workbench

# add to Claude Code
claude mcp add turbyho-kicad-workbench -- uvx kicad-workbench
Common questions

What is the KiCad Workbench MCP server?

KiCad Workbench is an MCP server listed in the public MCP registry as io.github.turbyho/kicad-workbench. Gives KiCad 10 projects to LLM agents: schematics, boards, ERC, DRC, BOM, edits. This page covers its PyPI package (kicad-workbench).

Is the KiCad Workbench MCP server safe to use?

KiCad Workbench scores 72 out of 100 on VerifyMCP. We found no known CVEs affecting it as of 21 November 2026. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.

What tools does the KiCad Workbench MCP server expose?

KiCad Workbench exposes 77 tools: list_libraries, search_library_symbols, search_library_footprints, get_library_symbol, get_library_footprint, and 72 more. Their descriptions and schemas cost roughly 23,822 tokens of context every time the server is loaded.

Is the KiCad Workbench MCP server still maintained?

KiCad Workbench is still listed as active in the MCP registry. We last reached this channel on 21 November 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.

What licence is the KiCad Workbench MCP server under?

KiCad Workbench declares the MIT licence, which is OSI-approved. That covers the source only, and says nothing about the cost of any service it calls.

What did VerifyMCP test on the KiCad Workbench MCP server?

VerifyMCP ran 16 checks on KiCad Workbench, covering Malware scan, Known CVEs, Install scripts, Dependency health and 12 more. Endpoint Security and Transport & Reachability do not apply to a PyPI package, so they were not tested. The score does not measure everything, and the scoring documentation lists what it leaves out.