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
ipc_status ~100

Show the state of the IPC connection to the running KiCad. The IPC tools change the board that is open in the PCB editor of a running KiCad. Use this tool first: it shows if the IPC tools can operate now, and the limits of the running KiCad version.

NameTypeReqDescription
board_pathstring–The path of a .kicad_pcb file (optional). The tool then shows if the PCB editor has this board.
NameTypeReqDescription
resultstringyes–

No examples provided.

job_status ~330

Give the background jobs of the tool calls, the state or the result of one job, or cancel a job. A tool call that takes longer than 20 s becomes a background job: its answer starts with "⏳" and gives the job ID, and the work continues (also when the client stops to wait for the call). This tool gives the result of the job: the same text that the tool gives, or the same error. A call of the same tool with the same arguments while its job runs starts no second run: it waits for that job again (up to 20 s) and gives its result or its ID. The list also has the calls that run in their first 20 s. The jobs are in the memory of the server process: a restart of the server (of the MCP client) loses them. A finished job stays 1 h (the 50 newest finished jobs). A cancel stops the task of the job at its next step. Work in a thread does not stop: kicad-cli, the Python of KiCad or a file write can still end and change files. Only the schematic edit tools (add_component_from_library, add_wire and the label tools) do not save when the cancel comes before their save. Check the files after a cancel. Cancel a job only when the user asks.

NameTypeReqDescription
cancelboolean–True: cancel the running job job_id.
job_idstring–The ID of a job. Empty: the list of the jobs of the server process.

No output schema declared.

No examples provided.

list_libraries ~131

List the symbol or footprint libraries of KiCad and of a project. The libraries come from the library tables: the global table of the installed KiCad version (with its nested tables), then the table of the project. When more than one row has the same library name, KiCad uses the last one: a project library replaces a global library.

NameTypeReqDescription
kindstring–"symbol" or "footprint".
project_pathstring–Optional .kicad_pro, .kicad_sch or .kicad_pcb file, or the project directory.
NameTypeReqDescription
resultstringyes–

No examples provided.

list_pcb_footprints ~126

Give the footprints of a board. The layer of a footprint is the standard name of its copper layer, F.Cu or B.Cu, also when the layer table of the board has a user name for it ("Top"): KiCad shows the user name in its GUI.

NameTypeReqDescription
file_pathstringyesThe .kicad_pcb file.
filter_layer––Optional layer of the footprints to give: "F.Cu" or "B.Cu" (a user name of the layer gives an error). Empty: all footprints.
NameTypeReqDescription
resultstringyes–

No examples provided.

list_schematic_components ~249

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). Each placed unit of a package is a row of its own with the same reference (U1 four times for four units), and the table has no unit column. This is correct, not a duplicate reference. Total counts the rows (the placed units), not the packages.

NameTypeReqDescription
file_pathstringyesA .kicad_sch file of the project.
filter_dnp––Optional: True gives only the DNP components, False only the components that are not DNP.
filter_type––Optional start of the references, for example "R", "C" or "U" (no difference of case). "R" also gives RV1 and RN1.
filter_value––Optional text in the Value field (no difference of case).
NameTypeReqDescription
resultstringyes–

No examples provided.

list_schematic_nets ~249

Give the names of the labels and of the power symbols of a schematic file. The table gives the names of the labels and of the power symbols of this file, not the nets of KiCad: KiCad adds the sheet path to a local label of a sub-sheet ("/Power/VIN"), gives one name to a net with more labels, and names a net with no label. A label with no connection is in the list too. Each name is in the list one time. Type is the first kind that has the name, in this sequence: global, local, hierarchical, power. Code is the index of the name when the tool reads the kinds in this sequence, each in the order of the file (from 0): it is not the net code of the netlist. Use generate_netlist on the root schematic for the nets of KiCad.

NameTypeReqDescription
file_pathstringyesA .kicad_sch file of the project.
filter_powerboolean–True gives only the nets whose name has "gnd", "vcc", "vdd", "vss", "+" or "-" (heuristic).
NameTypeReqDescription
resultstringyes–

No examples provided.

remove_library_from_table ~110

Remove a library from the project library table, as the table dialog of KiCad 10 does. The library files stay: KiCad does not delete them. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
kindstringyes"symbol" or "footprint".
nicknamestringyesThe nickname of the row.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

rename_library_footprint ~473

Give a footprint of a project library an other name, as "Rename" of the library tree of the footprint editor of KiCad 10 does. KiCad saves the footprint as "<new name>.kicad_mod", then removes the old file. The Value gets the new name when it was equal to the old name. As the rename dialog, the tool removes the white space at the two ends of the name. A name with one of the characters \ / : " < > | * ? is an error: KiCad changes them to "_" in the file name, and reads the name from the file name. A name that the library has already is an error: the tool does not replace a footprint. On a file system with no difference of case in file names (Windows, macOS), a change of only the case of the name is one file: KiCad 10.0.7 and later delete the old footprint first, then save the new one, and so does the tool. With KiCad 10.0.6 (it saves first, then deletes, and thus removes the footprint) the tool refuses such a rename: do it in two steps. KiCad does not change the uses of the old name, 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 the old library ID. The library 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 saves the footprint (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
lib_idstringyesThe footprint, "<library>:<footprint>", of a library of the project table.
new_namestringyesThe new name.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

rename_library_symbol ~338

Give a symbol of a project library an other name, as "Rename" of the library tree of the symbol editor of KiCad 10 does. As the rename dialog, the tool removes the white space at the two ends of the name and writes the escapes of the name ("{colon}" for ":"). A space stays a space (not "_", as in create_derived_symbol). The Value gets the new name when it was equal to the old name. The symbols derived from the symbol extend the new name. A name that the library has already is an error, also with an other case (KiCad compares the names with no difference of case): the tool does not replace a symbol. A change of only the case of the name of the symbol itself is not an error. KiCad does not change the schematics that use the old name, and neither does the tool: the answer gives the placed symbols with the old lib_id as a warning. 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
lib_idstringyesThe symbol, "<library>:<symbol>", of a library of the project table.
new_namestringyesThe new name.
project_pathstringyesThe .kicad_pro file or the project folder.
NameTypeReqDescription
resultstringyes–

No examples provided.

render_library_item ~623

Render a symbol or a footprint of a KiCad library as PNG images. Use the images for a visual check: the layout, the texts, the pin 1 mark, the silkscreen on the pads, items that overlap. get_library_symbol and get_library_footprint give the exact values. kicad-cli of the installed KiCad draws the item as SVG, with the color theme "KiCad Default". The tool draws each SVG as PNG images with the background of that theme. The library comes from the library tables of the installed KiCad and of the project, as in the chooser of KiCad.

NameTypeReqDescription
include_hiddenboolean–Symbol only: also draw the hidden pins and the hidden fields.
item_typestringyes"symbol" or "footprint".
layoutstring–"tiles": the smallest text gets at least 15 pixels (the height of a 1.27 mm text at 300 DPI), never less than 300 DPI. An item that does not fit in one image at that scale is divided into tiles that…
lib_idstringyesThe library ID, for example "Device:R" or "Resistor_SMD:R_0603_1608Metric".
max_height_pxintegeryesThe largest image height that your vision input reads with no reduction. If your input also has a limit of the pixel count, give a width and a height whose product is in that limit.
max_imagesinteger–The tool gives an error, not images, when the item needs more images than this.
max_width_pxintegeryesThe largest image width that your vision input reads with no reduction, from 64 to 8192 pixels.
output_dirstring–Optional directory to keep the SVG and PNG files. The tool replaces files with the same names, and does not delete other files. The summary gives the files that it wrote.
pages––Optional names of the pages to draw, from the summary or from an error (a symbol has one page for each unit and body style, for example "74HC00_unit2"). All pages if empty.
project_pathstring–Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.
region––Optional [x, y, width, height] in mm, a part of the page to draw (the origin is the top left corner of the page; the summary gives the page sizes). Use it to see a part in more detail. The region app…

No output schema declared.

No examples provided.

render_pcb ~283

Render a 3D view of a board as an image with kicad-cli (KiCad 9 or later). The image has the board and the 3D models of the footprints: a footprint with no 3D model has no body in the image. Use the image for a visual review of the layout. The tool replaces an existing image file with the same name.

NameTypeReqDescription
heightinteger–The height of the image in pixels (default 900).
output_pathstring–Optional image file: .png, or .jpg or .jpeg for a JPEG image. Default: <board>_render_<side>.png next to the board.
pcb_pathstringyesThe .kicad_pcb file.
qualitystring–"basic" (default, fast), "high" (ray tracing, slower), "user" or "job_settings" (the settings of KiCad).
rotatestring–Optional rotation of the board "X,Y,Z" in degrees, for example "-30,0,25".
sidestring–The side of the camera: "top" (default), "bottom", "left", "right", "front" or "back".
widthinteger–The width of the image in pixels (default 1600).

No output schema declared.

No examples provided.

run_drc ~331

Run the DRC of kicad-cli on a board. The tool uses the severities of the project. When the schematic of the board name is next to the board, the DRC also checks the parity of the schematic and the board. The answer tells if the DRC used new zone fills or the fills of the file. The table shows 20 violations: the errors first, and in each severity the unconnected items and the schematic parity items before the other violations (they are at the end of the report). The description is cut to 40 characters: get_drc_violations gives all of them. The table also has the violations that the project excludes, marked "(excluded)", after the others: Total Violations counts them, the counts of errors and warnings do not.

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…
NameTypeReqDescription
resultstringyes–

No examples provided.

run_erc ~206

Run the ERC of kicad-cli on a schematic, with the annotation check of the ERC dialog. The tool uses the severities of the project. It also runs the annotation check of the ERC dialog of KiCad (symbols that are not annotated, duplicate references, units with different values), which kicad-cli does not run. For a sub-sheet, the tool checks the root schematic of the project (the answer tells it). The table shows the first 20 violations, with the description cut to 50 characters: first the violations of the annotation check, then the violations of the report of kicad-cli in its order. get_erc_violations gives all of them. The table also has the violations that the project excludes, marked "(excluded)": Total Violations counts them, the counts of errors and warnings do not.

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

No examples provided.

search_components_by_type ~345

Find the components of a type, for example OLED, sensor or display (heuristic). The tool searches the value, the footprint and the net names of each component. It reads the netlist that kicad-cli writes now: each component of each sheet path, at each level of the hierarchy, with the reference of that path. The netlist has no power symbols and no symbol with no library symbol. The tool needs kicad-cli. The types OLED, sensor, display, SPI, I2C, UART, power, memory and wireless search a list of words (for example SPI: spi, mosi, miso, sck, cs). An other type is one word to search. The tool finds a word in a part of the value, of the footprint or of a net name of the component (no difference of case). Thus a component on a net of the type (a pull-up resistor on SDA) is in the result, and short words (cs, tx, rx, esp) give false matches. The output gives the words. Each component shows its first 10 connections.

NameTypeReqDescription
component_typestringyesThe type of component, for example "OLED", "sensor", "display", "SPI" or "I2C".
file_pathstringyesA .kicad_sch file of the project.
search_in_subsheetsboolean–True (default): the components of the file and of all sheets below it (for the root schematic: the full project). False: only the components that are placed in the file.
NameTypeReqDescription
resultstringyes–

No examples provided.

search_library_footprints ~291

Search the footprints of the KiCad libraries by name, description and tags. Each word of the query must be in the library ID ("Resistor_SMD:R_0603_1608Metric"), the description or the tags. The order is that of the footprint chooser of KiCad: an exact name first, then the best score. The first search reads all libraries (some seconds); then an index in the user cache directory is used until a library file changes. The tool searches only libraries of the type KiCad, not a disabled library, and not a hidden library unless include_hidden or library asks for it. A library file of a newer version than the installed KiCad gives no results (KiCad cannot read it). The output tells a library of an other type and a library file that the tool cannot read.

NameTypeReqDescription
include_hiddenboolean–Also search libraries that are hidden in KiCad.
librarystring–Optional name of one library to search (also when it is hidden).
limitinteger–The maximum number of results in the table.
project_pathstring–Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.
querystringyesWords to find, for example "0603 resistor".
NameTypeReqDescription
resultstringyes–

No examples provided.

search_library_symbols ~298

Search the symbols of the KiCad libraries by name, description and keywords. Each word of the query must be in the library ID ("Device:R"), the description, the keywords or the default footprint. A derived symbol gets the empty fields from its parent. The order is that of the symbol chooser of KiCad: an exact name first, then the best score. The first search reads all libraries (some seconds); then an index in the user cache directory is used until a library file changes. The tool searches only libraries of the type KiCad, not a disabled library, and not a hidden library unless include_hidden or library asks for it. A library file of a newer version than the installed KiCad gives no results (KiCad cannot read it). The output tells a library of an other type and a library file that the tool cannot read.

NameTypeReqDescription
include_hiddenboolean–Also search libraries that are hidden in KiCad.
librarystring–Optional name of one library to search (also when it is hidden).
limitinteger–The maximum number of results in the table.
project_pathstring–Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.
querystringyesWords to find, for example "op amp rail-to-rail".
NameTypeReqDescription
resultstringyes–

No examples provided.

search_parts_registry ~124

Search an open registry of KiCad parts (no login). The tool compares the query with the ID, the name, the family, the category, the manufacturer and the keywords of each part. Example queries: "usb c connector", "0402 capacitor", "nrf9151". The results are the first matches in the order of the registry index, with no ranking.

NameTypeReqDescription
limitinteger–The maximum number of results (default 20).
querystringyesThe words to find. Each word must match. "*" is a wildcard.
NameTypeReqDescription
resultstringyes–

No examples provided.

search_symbols ~187

Find the components of a schematic whose reference, value or library ID match a pattern. The tool searches only the components of this file (in each of its sheet paths), not the sheets below it. A component matches when the pattern is in a part of the text (Python re.search). The table shows the first 50 matches, and the count of the others.

NameTypeReqDescription
file_pathstringyesA .kicad_sch file of the project.
patternstringyesA regular expression with the syntax of the Python module re (no difference of case). Empty: all components. A pattern that is not a regular expression gives an error, and a search that takes longer…
search_fieldsstring–The fields to search: "all" (default), "reference", "value" or "library".
NameTypeReqDescription
resultstringyes–

No examples provided.

set_library_symbol_properties ~329

Change the properties of a symbol of a project library, as the Symbol Properties dialog of the symbol editor of KiCad 10 does. A field name that the symbol has gets the new text (a mandatory name in any case). A new name gives a new hidden field at (0, 0), with the text size of the symbol editor settings. A text of None removes a user field (the five mandatory fields cannot be removed). As in the dialog, a text that is a path to a file that exists ("/", "${", "./", "../") gets "file://" before it, the escapes ("{slash}") become characters, and the text of a mandatory field has no white space at its ends. The footprint filters replace the list (spaces become "_"). KiCad saves the library (kicad-cli), and a second save must give the same bytes. The library must be in the project table, in the version of the installed KiCad. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
fields––The field texts by name. None as a text removes the user field.
footprint_filters––The new list of footprint filters. None: no change.
keywords––The new keywords. None: no change. "" removes them.
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.

set_library_table_row ~186

Enable, disable, show or hide a library of the project library table, as the table dialog of KiCad 10 does. KiCad does not load a disabled library. A hidden symbol library is loaded, but the symbol chooser and the library tree do not show it. Only a symbol table has the visible flag. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
enabled––True enables the library, False disables it. None: no change.
kindstringyes"symbol" or "footprint".
nicknamestringyesThe nickname of the row.
project_pathstringyesThe .kicad_pro file or the project folder.
visible––True shows the library, False hides it (symbol tables only). None: no change.
NameTypeReqDescription
resultstringyes–

No examples provided.

set_symbol_attributes ~625

Write the attributes of placed symbols, as the Symbol Properties dialog of KiCad 10 sets them: "Do not populate" (dnp), "Exclude from bill of materials", "Exclude from board", "Exclude from position files" and "Exclude from simulation". The tool writes each attribute into each unit of the reference. KiCad 10.0.6 gives the other units the same DNP and Exclude from BOM, board and position files, but not Exclude from simulation (it keeps that one for each unit): the tool sets each unit, as the dialog on each unit does. The tool changes only the attributes. The OK of the dialog also copies the fields of the unit (not the Reference) to the other units (SCH_SYMBOL::SyncOtherUnits). The tool does not copy the fields: units with different fields keep them (set_symbol_fields changes the fields). With a variant (KiCad 10), the tool writes the attributes of that variant: a value equal to the attribute of the symbol is no differential, and KiCad writes no variant with no differentials. A change of an attribute of the symbol does not change the variants: KiCad keeps the old value in each variant (the variant starts with the attributes of the symbol when KiCad loads the file), thus the file then has the old value as a token of each variant. This is correct, not a defect. A symbol in a sheet that the hierarchy uses more than one time has one set of attributes for all its references (U201 and U301): give the same attributes for each of these references, or write different attributes through a variant. The tool checks all changes and all files first, and writes no file when a check fails. It writes all files or no file. KiCad must not have the files open. A schematic file of the project with an older version than the installed KiCad writes is an error: the user converts it in KiCad first. The tool refuses a reference that is not annotated (U?), a duplicate reference, a variant that the project does not have, an attribute name that it does not know, a symbol with no token for an…

NameTypeReqDescription
changesarrayyesOne item for each reference (and variant): the reference, the attributes to set (a missing attribute does not change), and the variant name (empty: the symbol).
schematic_pathstringyesA .kicad_sch file of the project. The tool finds the references in the full project.
NameTypeReqDescription
resultstringyes–

No examples provided.

set_symbol_fields ~689

Write the fields of placed symbols, as KiCad writes them. The tool writes each field into each unit of the reference (one package has one Value and one MPN). A field that the symbol does not have becomes a new field, hidden as KiCad 9 and 10 make it (a file of KiCad 8: visible; Value_Confirmed and MPN_Confirmed: always hidden). With a variant (KiCad 10), the tool writes the fields of that variant into each unit: a value equal to the field of the symbol removes the field from the variant. The tool checks all changes and all files first, and writes no file when a check fails. It writes all files or no file: an error of the disk also changes no file. KiCad must not have the files open. A schematic file of the project with an older version than the installed KiCad writes is an error: the user converts it in KiCad first (the output gives the step). A symbol in a sheet that the hierarchy uses more than one time has one set of fields for all its references (U201 and U301): give the same fields for each of these references, or write different fields through a variant. The tool refuses a reference that is not annotated (U?), a duplicate reference, the field Reference, a mandatory field name in an other case ("value": give "Value"), the fields Sim.Enable and Spice_Netlist_Enabled (KiCad removes them when it loads the symbol), a symbol with two fields of one name (a mandatory field two times, or more than ten user fields of one name), a file that KiCad loads under more than one name, and a project whose full sheet hierarchy the tool cannot read. An error gives the reason, and the step in KiCad when one is necessary. With KiCad 10, the field names are the names that KiCad gives the fields when it loads the symbol, as get_symbol_details gives them: a second field "MPN" of the file has the name "MPN_1" (to "MPN_9"). Give that name to write that field: the tool changes its text and keeps its name in the file (KiCad writes "MPN_1" at its next save). With KiCad 8 and 9, the nam…

NameTypeReqDescription
changesarrayyesOne item for each reference (and variant): the reference, the fields by name, and the variant name (empty: the symbol).
schematic_pathstringyesA .kicad_sch file of the project. The tool finds the references in the full project.
NameTypeReqDescription
resultstringyes–

No examples provided.

setup_pcb_layout ~357

Make a new board with an outline, next to the schematic. The board has the name of the schematic, a rectangle of four lines on Edge.Cuts, two copper layers and the default design rules. It has no footprints, tracks or nets: use "Update PCB from Schematic" of KiCad for the footprints. The rectangle goes from (0, 0) to (width, height): its top left corner is at the top left corner of the page. pcbnew of the installed KiCad makes the board (a Python with pcbnew is necessary), thus the board has the file format of the installed KiCad, as when the user makes it in the PCB editor. When that is newer than the KiCad of the schematic, the output has a warning: tell the user that the older KiCad cannot open the board. The tool does not change the project file. When the .kicad_pcb file exists, the tool does not write it and returns an error. A new board removes all footprints, tracks and zones of the existing board. Ask the user before you set overwrite=True.

NameTypeReqDescription
heightnumber–The height of the board in the unit (default 100).
overwriteboolean–True replaces an existing .kicad_pcb file. Set it only after the user agreed to lose the existing board.
schematic_pathstringyesThe .kicad_sch file. The board gets its name and its title.
unitstring–"mm" (default) or "mil".
widthnumber–The width of the board in the unit (default 100).
NameTypeReqDescription
resultstringyes–

No examples provided.

trace_hierarchical_connection ~211

Trace the connections of a component across the full schematic hierarchy. The tool reads the netlist that kicad-cli writes now: it has each component of each sheet path, at each level of the hierarchy, with the reference of that path (a sheet that the hierarchy uses two times gives two references). The netlist has no power symbols and no symbol with no library symbol. The tool needs kicad-cli. The connected pins of a net are the pins of the other components: a pin of the same component on the net is not in the list. Each net shows 15 pins or less.

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).
pin_numberstring–Optional pin number. Empty: all pins.
referencestringyesThe reference of the component, for example "U1".
NameTypeReqDescription
resultstringyes–

No examples provided.

trace_netlist_connection ~169

Give the nets of the pins of a component, and the pins on each net. The netlist of kicad-cli is the most exact source for the connections. Make it with generate_netlist, and again after a change of the schematic. The pins on a net are the pins of the other components: a pin of the same component on the net is not in the list. Give no pin_number to see each pin of the component. The reference and the pin number are case-sensitive.

NameTypeReqDescription
netlist_pathstringyesA netlist file of generate_netlist.
pin_numberstring–Optional pin number, for example "1". Empty: all pins.
referencestringyesThe reference of the component, for example "R16".
NameTypeReqDescription
resultstringyes–

No examples provided.

update_symbols_from_library ~913

Update placed symbols from their library symbols, as "Update Symbols from Library" of the schematic editor of KiCad 10 does it. Each matching symbol gets the library symbol of its library ID (from the global and the project symbol library tables, flattened): the new shape and pins, the keywords and the footprint filters (always, as the dialog). The fields, the attributes and the alternate pins follow the options, with the defaults of the dialog. The library symbol is the text of a save in kicad-cli, as KiCad loads it: kicad-cli saves each library symbol with its parents one time (about 0.2 s), and again after a change of their text; a cache keeps the last 256 saves. The pins follow the new library symbol (SCH_SYMBOL::UpdatePins): a pin keeps its UUID when the library symbol has its number; a new pin gets a new UUID, and a pin that the library symbol does not have goes. KiCad makes random UUIDs, and the order of a new pin comes from the memory: the tool uses the order of the placed pins in the file and of the library pins in the save of KiCad. The fields of the update (fields): with no list, the dialog defaults: Footprint, Datasheet and Description, and each user field of the matching symbols and of their library symbols; not Reference and not Value. A private field is always updated. The position of a field (update_field_positions, and a new field) is the position of the symbol plus the position of the library field, rotated and mirrored as the symbol (SCH_FIELD::GetPosition). A user field of the library that the symbol does not have becomes a new field. The tool refuses these updates: - A match with no symbol, or a field name that the dialog does not list. - A library ID that is not valid, or that the libraries do not have. A library symbol with fewer units than the symbol. - A symbol with no mandatory field (Reference, Value, Footprint, Datasheet or Description), with two fields of one name, or with a field or a library ID that the load changes (a fiel…

NameTypeReqDescription
fields––The names of the fields to update, or none for the dialog defaults. The names of the user fields have case.
matchstring–"all" (each symbol), "reference" or "value" (pattern with "*" and "?", no case), or "lib_id" (pattern is "<library>:<symbol>").
options––The update options of the dialog; a missing option has the default of the dialog.
patternstring–The text of the match "reference", "value" or "lib_id".
schematic_pathstringyesA .kicad_sch file of the project. The tool finds the symbols in the full project.
NameTypeReqDescription
resultstringyes–

No examples provided.

upgrade_project_libraries ~278

Convert the libraries of the project tables to the file version of the installed KiCad 10, with kicad-cli (`kicad-cli sym upgrade`, `kicad-cli fp upgrade`). KiCad converts each library of an older version into a temporary folder. Then KiCad saves the result again: the bytes must not change, and the names of the symbols or the footprints must stay. Only then the tool writes the files of that library, all or none. The tool makes no backup: git gives the way back, and the output names a library that git cannot give back. A converted library cannot be read by an older KiCad. A library outside the project folder (other projects can use it) is converted only when libraries names it or include_outside is True. A library of a newer version, and a folder of symbol files, give an error. KiCad must not have the project open. The installed KiCad must be KiCad 10.0.

NameTypeReqDescription
include_outsideboolean–True also converts the libraries outside the project folder.
libraries––The nicknames of the libraries to convert. Default: all libraries of the project tables.
project_pathstringyesThe .kicad_pro file or the project folder.
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.