{"$schema":"https://verifymcp.io/schemas/trust-report.json","schemaVersion":1,"license":{"name":"CC BY-NC 4.0","url":"https://creativecommons.org/licenses/by-nc/4.0/"},"generatedAt":"2026-11-22T00:33:41.623Z","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench","markdownUrl":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench.md","server":{"slug":"turbyho-kicad-workbench","name":"KiCad Workbench","registryName":"io.github.turbyho/kicad-workbench","description":"Gives KiCad 10 projects to LLM agents: schematics, boards, ERC, DRC, BOM, edits","registryStatus":"active","deletedAt":null,"statusMessage":null,"liveness":"live","publisher":{"class":"unknown","claimed":false}},"component":{"slug":"kicad-workbench","type":"pypi","identifier":"kicad-workbench","withdrawn":false,"url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench","version":"0.2.0","transport":"stdio","scoredAt":"2026-11-21T07:35:48.446Z"},"score":{"total":72,"tier":"medium","status":"scored","weekDelta":19,"history":[{"date":"2026-11-21","total":72},{"date":"2026-11-20","total":57},{"date":"2026-11-19","total":68},{"date":"2026-11-18","total":53},{"date":"2026-11-17","total":53},{"date":"2026-11-16","total":53},{"date":"2026-11-15","total":53},{"date":"2026-11-14","total":53},{"date":"2026-11-13","total":68},{"date":"2026-11-12","total":53},{"date":"2026-11-11","total":53},{"date":"2026-11-10","total":53},{"date":"2026-11-09","total":53},{"date":"2026-11-08","total":53}]},"categories":[{"name":"Supply Chain Security","score":100,"verdict":"partial","reasons":["No malware found by supply-chain analysis.","No known CVEs affecting this package version or its production dependencies.","Runs hatchling.build at install time, a recognised build step with no custom scripting around it.","1 of 37 dependencies flagged as unhealthy."],"codes":[{"code":"supplychain.malware_clean","args":{}},{"code":"cve.none","args":{}},{"code":"installscript.allowlisted","args":{"tool":"hatchling.build","hooks":"build_backend"}},{"code":"dephealth.assessed","args":{"deps":"37","unhealthy":"1"}}]},{"name":"Provenance & Transparency","score":45,"verdict":"fail","reasons":["Source repository is publicly reachable at the declared URL.","Provenance check failed: no build-provenance attestation is published.","Clear OSI-approved license (MIT).","Actively maintained (last published 0 days ago).","Disclosure check failed: no security disclosure policy was found in the source repository."],"codes":[{"code":"provenance.repo_verified","args":{}},{"code":"provenance.none","args":{}},{"code":"license.osi","args":{"spdx":"MIT"}},{"code":"maintenance.recent","args":{"age_days":"0"}},{"code":"disclosure.absent","args":{}}]},{"name":"Schema Quality & AI Usability","score":59,"verdict":"fail","reasons":["AI-judged instruction clarity (excellent).","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.","Usage-examples check failed: none of the tools include examples."],"codes":[{"code":"schema.ai_quality","args":{"band":"excellent"}},{"code":"schema.footprint_heavy","args":{"avg":"317","items":"77","tools":"77","tokens":"24449","resources":"0"}},{"code":"schema.examples_absent","args":{}}]},{"name":"Stability & Change Management","score":43,"verdict":"partial","reasons":["Stability observed for 13 of 30 days with no destabilising changes; credit accrues until the full window elapses."],"codes":[{"code":"stability.building_history","args":{"days":"13"}}]},{"name":"Tool Coverage","score":99,"verdict":"partial","reasons":["100% of tools have a non-trivial description (not blank, and not just the tool's name).","97% of tool parameters carry a description.","Structured output schemas are declared (96% of tools); any adoption earns full credit."],"codes":[{"code":"toolquality.descriptions","args":{"pct":"100"}},{"code":"toolquality.param_docs","args":{"pct":"97"}},{"code":"toolquality.output_present","args":{"pct":"96"}}]},{"name":"Tool Safety","score":75,"verdict":"fail","reasons":["No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.","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.","An AI judge read all 78 captured unit(s) of tool text and found none that tries to manipulate the model reading it."],"codes":[{"code":"toolsafety.injection_clean","args":{}},{"code":"toolsafety.destructive_undeclared","args":{"pct":"0","tool":"remove_library_from_table","verb":"remove","declared":"none","annotated":"0","destructive":"3"}},{"code":"toolsafety.manipulation_clean","args":{"units":"78","judged":"78"}}]},{"name":"Capabilities","score":100,"verdict":"pass","reasons":["Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28."],"codes":[{"code":"protocol.supported","args":{"latest":"2026-07-28","version":"2025-11-25"}}]}],"inconclusive":[],"malware":[],"components":[{"slug":"kicad-workbench","type":"pypi","identifier":"kicad-workbench","withdrawn":false,"score":72,"current":true,"url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench","markdownUrl":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench.md"}],"facts":[{"label":"Registry","value":"pypi"},{"label":"Package","value":"kicad-workbench"},{"label":"Version","value":"0.2.0"},{"label":"Transport","value":"stdio"}],"install":{"available":true,"bundleSha256":null},"tools":[{"name":"list_libraries","title":null,"description":"List the symbol or footprint libraries of KiCad and of a project.\n\nThe libraries come from the library tables: the global table of the\ninstalled KiCad version (with its nested tables), then the table of the\nproject. When more than one row has the same library name, KiCad uses the\nlast one: a project library replaces a global library.","inputs":[{"name":"kind","type":"string","required":false,"description":"\"symbol\" or \"footprint\"."},{"name":"project_path","type":"string","required":false,"description":"Optional .kicad_pro, .kicad_sch or .kicad_pcb file, or\nthe project directory."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":131},{"name":"search_library_symbols","title":null,"description":"Search the symbols of the KiCad libraries by name, description and keywords.\n\nEach word of the query must be in the library ID (\"Device:R\"), the\ndescription, the keywords or the default footprint. A derived symbol gets\nthe empty fields from its parent. The order is that of the symbol chooser\nof KiCad: an exact name first, then the best score. The first search reads\nall libraries (some seconds); then an index in the user cache directory is\nused until a library file changes.\n\nThe tool searches only libraries of the type KiCad, not a disabled library, and\nnot a hidden library unless include_hidden or library asks for it. A library file\nof a newer version than the installed KiCad gives no results (KiCad cannot read\nit). The output tells a library of an other type and a library file that the tool\ncannot read.","inputs":[{"name":"include_hidden","type":"boolean","required":false,"description":"Also search libraries that are hidden in KiCad."},{"name":"library","type":"string","required":false,"description":"Optional name of one library to search (also when it is hidden)."},{"name":"limit","type":"integer","required":false,"description":"The maximum number of results in the table."},{"name":"project_path","type":"string","required":false,"description":"Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or\nits directory), to include its libraries."},{"name":"query","type":"string","required":true,"description":"Words to find, for example \"op amp rail-to-rail\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":298},{"name":"search_library_footprints","title":null,"description":"Search the footprints of the KiCad libraries by name, description and tags.\n\nEach word of the query must be in the library ID\n(\"Resistor_SMD:R_0603_1608Metric\"), the description or the tags. The order\nis that of the footprint chooser of KiCad: an exact name first, then the\nbest score. The first search reads all libraries (some seconds); then an\nindex in the user cache directory is used until a library file changes.\n\nThe tool searches only libraries of the type KiCad, not a disabled library, and\nnot a hidden library unless include_hidden or library asks for it. A library file\nof a newer version than the installed KiCad gives no results (KiCad cannot read\nit). The output tells a library of an other type and a library file that the tool\ncannot read.","inputs":[{"name":"include_hidden","type":"boolean","required":false,"description":"Also search libraries that are hidden in KiCad."},{"name":"library","type":"string","required":false,"description":"Optional name of one library to search (also when it is hidden)."},{"name":"limit","type":"integer","required":false,"description":"The maximum number of results in the table."},{"name":"project_path","type":"string","required":false,"description":"Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or\nits directory), to include its libraries."},{"name":"query","type":"string","required":true,"description":"Words to find, for example \"0603 resistor\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":291},{"name":"get_library_symbol","title":null,"description":"Show the content of a symbol of a KiCad library: fields, units and pins.\n\nThe library comes from the library tables of the installed KiCad and of\nthe project, as in the symbol chooser of KiCad. A derived symbol (extends\n...) is shown as KiCad places it: the fields of the symbol and of its\nparents, the flags of its parent, and the units and pins of its root symbol.\n\nThe tool reads symbol libraries of KiCad 8 and later. An older library gives an\nerror with the step for the user (kicad-cli sym upgrade), and a library of a\nnewer version than the installed KiCad gives an error.","inputs":[{"name":"lib_id","type":"string","required":true,"description":"The library ID, for example \"Device:R\" or \"MCU_ST_STM32F4:STM32F405RGTx\"."},{"name":"project_path","type":"string","required":false,"description":"Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or\nits directory), to include its libraries."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":221},{"name":"get_library_footprint","title":null,"description":"Show the content of a footprint of a KiCad library: pads, courtyard, attributes, 3D models.\n\nThe library comes from the library tables of the installed KiCad and of\nthe project, as in the footprint chooser of KiCad. pcbnew of the installed\nKiCad reads the footprint, thus the values are those of KiCad. The tool\nfinds the file of each 3D model as KiCad finds it.","inputs":[{"name":"lib_id","type":"string","required":true,"description":"The library ID, for example \"Resistor_SMD:R_0603_1608Metric\"."},{"name":"project_path","type":"string","required":false,"description":"Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or\nits directory), to include its libraries and to set ${KIPRJMOD}\nfor the 3D models."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":181},{"name":"check_pin_pad_mapping","title":null,"description":"Compare the pin numbers of a library symbol with the pad numbers of a footprint.\n\nThe tool uses the rules of \"Update PCB from Schematic\" of the installed\nKiCad. A pin number that no pad has, and a pin with no number, are errors.\nA pad with a number that no pin has gets no net: this is a warning. KiCad\n10 reads a stacked pin number (\"[1-4]\") as more than one pad number. The\ncheck uses the pins of all units, for each body style. A power symbol gives an\nerror: KiCad puts no power symbol into the netlist.","inputs":[{"name":"footprint_lib_id","type":"string","required":false,"description":"Optional library ID of the footprint, for example\n\"Resistor_SMD:R_0603_1608Metric\". If empty, the tool uses the\nFootprint field of the symbol."},{"name":"project_path","type":"string","required":false,"description":"Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or\nits directory), to include its libraries."},{"name":"symbol_lib_id","type":"string","required":true,"description":"The library ID of the symbol, for example \"Device:R\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":245},{"name":"check_schematic_pin_pad_mapping","title":null,"description":"Compare the pins of each symbol of a schematic with the pads of its footprint.\n\nThe tool uses the netlist that \"Update PCB from Schematic\" gives pcbnew\n(kicad-cli of the installed KiCad), and the rules of that update. A pin\nnumber that no pad has, a pin with no number, and a symbol whose footprint\nKiCad does not find are errors. A pad with a number that no pin has gets\nno net: this is a warning. A symbol has the pins of the units that the\nschematic has. The pads come from the library footprints, as a new\nfootprint on the board gets them. For a board that has the footprints,\nrun_drc with the schematic parity compares the footprints of the board.\nFor a library symbol and a footprint, use check_pin_pad_mapping.\nWhen the netlist job finds annotation errors (a duplicate reference can\njoin two symbols in one component), the tool lists them.","inputs":[{"name":"references","type":null,"required":false,"description":"Optional references to check, for example [\"U1\", \"J3\"].\nAll symbols of the netlist if empty."},{"name":"schematic_path","type":"string","required":true,"description":"A schematic of the project (.kicad_sch). For a\nsub-sheet or an other top-level sheet, the tool uses the project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":274},{"name":"render_library_item","title":null,"description":"Render a symbol or a footprint of a KiCad library as PNG images.\n\nUse the images for a visual check: the layout, the texts, the pin 1 mark,\nthe silkscreen on the pads, items that overlap. get_library_symbol and\nget_library_footprint give the exact values.\n\nkicad-cli of the installed KiCad draws the item as SVG, with the color\ntheme \"KiCad Default\". The tool draws each SVG as PNG images with the\nbackground of that theme. The library comes from the library tables of\nthe installed KiCad and of the project, as in the chooser of KiCad.","inputs":[{"name":"include_hidden","type":"boolean","required":false,"description":"Symbol only: also draw the hidden pins and the\nhidden fields."},{"name":"item_type","type":"string","required":true,"description":"\"symbol\" or \"footprint\"."},{"name":"layout","type":"string","required":false,"description":"\"tiles\": the smallest text gets at least 15 pixels (the\nheight of a 1.27 mm text at 300 DPI), never less than 300 DPI. An\nitem that does not fit in one image at that scale is divided into\ntiles that…"},{"name":"lib_id","type":"string","required":true,"description":"The library ID, for example \"Device:R\" or\n\"Resistor_SMD:R_0603_1608Metric\"."},{"name":"max_height_px","type":"integer","required":true,"description":"The largest image height that your vision input reads\nwith no reduction. If your input also has a limit of the pixel\ncount, give a width and a height whose product is in that limit."},{"name":"max_images","type":"integer","required":false,"description":"The tool gives an error, not images, when the item needs\nmore images than this."},{"name":"max_width_px","type":"integer","required":true,"description":"The largest image width that your vision input reads\nwith no reduction, from 64 to 8192 pixels."},{"name":"output_dir","type":"string","required":false,"description":"Optional directory to keep the SVG and PNG files. The\ntool replaces files with the same names, and does not delete\nother files. The summary gives the files that it wrote."},{"name":"pages","type":null,"required":false,"description":"Optional names of the pages to draw, from the summary or from\nan error (a symbol has one page for each unit and body style, for\nexample \"74HC00_unit2\"). All pages if empty."},{"name":"project_path","type":"string","required":false,"description":"Optional project (.kicad_pro, .kicad_sch, .kicad_pcb or\nits directory), to include its libraries."},{"name":"region","type":null,"required":false,"description":"Optional [x, y, width, height] in mm, a part of the page to\ndraw (the origin is the top left corner of the page; the summary\ngives the page sizes). Use it to see a part in more detail. The\nregion app…"}],"outputs":[],"hasOutputSchema":false,"hasExamples":false,"tokenEstimate":623},{"name":"export_bom","title":null,"description":"Give the bill of materials (BOM) of a schematic, as KiCad makes it.\n\nThe tool runs \"kicad-cli sch export bom\" for the full project of the\nschematic, and gives its lines as a table. Without group_by, each\nreference is one line. KiCad does not put the power symbols and the\nsymbols that are excluded from the BOM into the BOM.\n\nThe units of one package (one reference, U1A and U1B) must have the same\nValue, MPN, Value_Confirmed and MPN_Confirmed. When they do not, the output starts\nwith an error of the design: the BOM line of the package joins the values, and the\njoined MPNs look like an MPN and its alternative. Tell the user, and\ncorrect the fields in KiCad.\n\nFor project_check of datasheet-lens, give output_path and no group_by.\nThen give the path of the CSV file to project_check (argument bom). For a\nproject with variants (KiCad 10), also give all_variants: then give the\nlist of the files that the tool names to project_check.","inputs":[{"name":"all_variants","type":"boolean","required":false,"description":"True to export the default variant and each variant of\nthe project (KiCad 10 and later), one kicad-cli run and one CSV\nfile for each: the default variant into output_path, the variant X\ninto <stem>-X…"},{"name":"exclude_dnp","type":"boolean","required":false,"description":"True to remove the symbols that have DNP."},{"name":"fields","type":null,"required":false,"description":"The fields of the BOM, in their order. \"*\" adds all other\nfields. A generated field has the form \"${QUANTITY}\" or \"${DNP}\".\nDefault: Reference, Value, Footprint, Datasheet, ${QUANTITY},\n${DNP} and \"*…"},{"name":"group_by","type":null,"required":false,"description":"The fields whose equal values put symbols into one line.\nEach name must be an item of fields: a field that \"*\" adds does\nnot group the symbols. Default: no groups."},{"name":"output_path","type":"string","required":false,"description":"The CSV file to write, as kicad-cli writes it. A relative\npath is relative to the project directory. The tool does not\nexpand variables. The tool replaces an existing file. Empty: the\ntool keeps no f…"},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project. The BOM is the BOM\nof the full project, also for a sub-sheet."},{"name":"variant","type":"string","required":false,"description":"The name of a variant of the project (KiCad 10 and later).\nEmpty: the default variant."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":576},{"name":"check_symbol_fields","title":null,"description":"Check the MPNs of the symbols: the fields Value, MPN, Value_Confirmed and MPN_Confirmed.\n\nUse this tool only when the MCP server datasheet-lens is not available: its\ntool project_check does the same check, and also checks the datasheets. The\ntwo tools give the same messages (a datasheet-lens with the model of the four\nfields, of 2026-11-07 or later: an older one reads the MPNs from the\nparentheses of Value).\n\nThe convention: Value holds the general value (\"2N7002\", \"100nF 10V\"), the\nfield MPN the MPNs, the fitted part first (\"2N7002LT1G, BSS138LT1G\"; the\nseparators are \",\" and \";\", an MPN with \",\" or \";\" is in quotes, as in CSV),\nand the hidden fields Value_Confirmed and MPN_Confirmed the copies of the last\nconfirmation. A symbol with the MPNs in the parentheses of Value (the old\nconvention) gets the move into the field MPN.\n\nThe tool reads the BOM of kicad-cli (also the DNP symbols: the user can fit\nthem at any time) of the default variant and of each variant (KiCad 10).\nFor each symbol it gives the conflicts, the changes that the user must\nconfirm, the symbols that are not confirmed, the moves of the old convention,\nand the symbols with no part. Each message gives the change for\nset_symbol_fields. Write the fields only after the user confirmed them. A symbol\nwith \"Exclude from BOM\" is not in the BOM of kicad-cli: the tool does not check\nits fields. A power symbol is never in the BOM.","inputs":[{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project. The tool checks the\nfull project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":407},{"name":"generate_netlist","title":null,"description":"Make the netlist of a schematic with kicad-cli, and give the path of its file.\n\nkicad-cli writes the netlist (KiCad XML) of the full project into a file in the\ntemporary folder of the system. Give this file to trace_netlist_connection,\nget_netlist_nets and get_netlist_components. Make the netlist again after a change\nof the schematic. The file name comes from the root schematic: each call replaces\nthe netlist file of an earlier call for the same project.","inputs":[{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":137},{"name":"trace_netlist_connection","title":null,"description":"Give the nets of the pins of a component, and the pins on each net.\n\nThe netlist of kicad-cli is the most exact source for the connections. Make it\nwith generate_netlist, and again after a change of the schematic.\n\nThe pins on a net are the pins of the other components: a pin of the same\ncomponent on the net is not in the list. Give no pin_number to see each pin of the\ncomponent. The reference and the pin number are case-sensitive.","inputs":[{"name":"netlist_path","type":"string","required":true,"description":"A netlist file of generate_netlist."},{"name":"pin_number","type":"string","required":false,"description":"Optional pin number, for example \"1\". Empty: all pins."},{"name":"reference","type":"string","required":true,"description":"The reference of the component, for example \"R16\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":169},{"name":"get_netlist_nets","title":null,"description":"Give the nets of a netlist file with their pins.\n\nTotal Nets counts all nets of the netlist, also with filter_pattern. Each net shows\nits first 10 pins. The netlist of KiCad has a net \"unconnected-(...)\" for each\nunconnected pin: these nets are in the list.","inputs":[{"name":"filter_pattern","type":"string","required":false,"description":"Optional regular expression for the net names (the syntax of\nthe Python module re, no difference of case), found in a part of the\nfull name with the sheet path. Empty: all nets. A pattern that is not…"},{"name":"netlist_path","type":"string","required":true,"description":"A netlist file of generate_netlist."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":177},{"name":"get_netlist_components","title":null,"description":"Give the components of a netlist file with the nets of their pins.\n\nTotal Components counts all components of the netlist, also with filter_ref. The\nnetlist has no power symbols.","inputs":[{"name":"filter_ref","type":"string","required":false,"description":"Optional start of the references to give, for example \"R\",\n\"U\" or \"C\" (the case is important). Empty: all components."},{"name":"netlist_path","type":"string","required":true,"description":"A netlist file of generate_netlist."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":104},{"name":"trace_hierarchical_connection","title":null,"description":"Trace the connections of a component across the full schematic hierarchy.\n\nThe tool reads the netlist that kicad-cli writes now: it has each component of\neach sheet path, at each level of the hierarchy, with the reference of that\npath (a sheet that the hierarchy uses two times gives two references). The\nnetlist has no power symbols and no symbol with no library symbol. The tool\nneeds kicad-cli.\n\nThe connected pins of a net are the pins of the other components: a pin of the\nsame component on the net is not in the list. Each net shows 15 pins or less.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project (the root schematic or a\nsub-sheet: the tool uses the netlist of the root schematic)."},{"name":"pin_number","type":"string","required":false,"description":"Optional pin number. Empty: all pins."},{"name":"reference","type":"string","required":true,"description":"The reference of the component, for example \"U1\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":211},{"name":"analyze_hierarchical_nets","title":null,"description":"Analyze all nets of the full schematic hierarchy.\n\nThe tool reads the netlist that kicad-cli writes now: the nets of all sheets\nat each level of the hierarchy. It groups them as power, interface and signal\nnets (by their names), and gives the sheet paths of the hierarchy.\n\nThe groups come from parts of the net names (heuristic): power has VDD, VSS, GND,\nVCC, VBAT, VPP, +3V or +5V, interface has I2C, SPI, UART, SDA, SCL, MOSI, MISO, TX\nor RX, and signal is each other net. The tool lists at most 20 power nets, 30\ninterface nets and 20 signal nets, sorted by name: use filter_pattern for the\nothers. The netlist of KiCad has a net \"unconnected-(...)\" for each unconnected\npin, with the pin name in it: these nets are in the total, and in a group by\ntheir names (\"unconnected-(U1-TXD-Pad5)\" is an interface net). The total counts\nthe nets after filter_pattern.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project (the root schematic or a\nsub-sheet: the tool uses the netlist of the root schematic)."},{"name":"filter_pattern","type":"string","required":false,"description":"Optional regular expression for the net names (no\ndifference of case), found in a part of the full name with the sheet\npath (\"/Power/VIN\"), with the syntax of the Python module re. Empty: all\nnets. A…"},{"name":"show_hierarchy","type":"boolean","required":false,"description":"True (default): list the sheet paths of the hierarchy with\ntheir files."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":396},{"name":"check_library_links","title":null,"description":"Check the links of a project to its symbol and footprint libraries and 3D models.\n\nThe tool uses the checks of KiCad: ERC for the symbols of the schematic\n(a library or a symbol that KiCad does not find, a symbol that is not\nequal to its library symbol) and DRC for the footprints of the board. It\nfinds the footprints of the schematic as \"Update PCB from Schematic\"\ndoes, and the 3D models of the footprints as the STEP export does\n(KiCad does not check them).","inputs":[{"name":"project_path","type":"string","required":true,"description":"The project: a .kicad_pro, .kicad_sch or .kicad_pcb\nfile, or its directory."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":157},{"name":"search_parts_registry","title":null,"description":"Search an open registry of KiCad parts (no login).\n\nThe tool compares the query with the ID, the name, the family, the category, the\nmanufacturer and the keywords of each part. Example queries: \"usb c connector\",\n\"0402 capacitor\", \"nrf9151\". The results are the first matches in the order of the\nregistry index, with no ranking.","inputs":[{"name":"limit","type":"integer","required":false,"description":"The maximum number of results (default 20)."},{"name":"query","type":"string","required":true,"description":"The words to find. Each word must match. \"*\" is a wildcard."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":124},{"name":"get_registry_part","title":null,"description":"Give the full record of one part of the parts registry.\n\nThe record has the download URLs (footprint, symbol, 3D model), the link to the\ndatasheet, the origin of the dimensions, and the reports of real builds.","inputs":[{"name":"part_id","type":"string","required":true,"description":"The ID of the part (search_parts_registry gives it)."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":78},{"name":"download_registry_part","title":null,"description":"Download the files of a part of the parts registry into a local folder.\n\nThe tool downloads only through HTTPS, only from the hosts of the registry, at\nmost 50 MB for each file, and only the file extensions of each format.\n\nThe tool replaces a file with the same name in save_dir. It does not check the\nfile version, and does not add the files to a library table: KiCad reads a\n.kicad_mod file only in a footprint library folder (.pretty). Add the library with\nadd_library_to_table: then copy_symbol_to_library and copy_footprint_to_library\ncan copy its items into a project library.","inputs":[{"name":"formats","type":null,"required":false,"description":"The files to download: \"footprint\", \"symbol\", \"step\", \"preview\"\n(.glb), \"footprint_svg\" and \"symbol_svg\". Default: the footprint and the\nsymbol."},{"name":"part_id","type":"string","required":true,"description":"The ID of the part (search_parts_registry gives it)."},{"name":"save_dir","type":"string","required":true,"description":"A folder that exists, for example the library folder of the\nproject: in the working folder, the home folder or a folder of\nPARTS_REGISTRY_SAVE_ROOTS."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":249},{"name":"list_pcb_footprints","title":null,"description":"Give the footprints of a board.\n\nThe layer of a footprint is the standard name of its copper layer, F.Cu or B.Cu,\nalso when the layer table of the board has a user name for it (\"Top\"): KiCad shows\nthe user name in its GUI.","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"filter_layer","type":null,"required":false,"description":"Optional layer of the footprints to give: \"F.Cu\" or \"B.Cu\" (a\nuser name of the layer gives an error). Empty: all footprints."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":126},{"name":"get_pcb_statistics","title":null,"description":"Give the size, the layers, the counts and the design rules of a board.\n\nThe zone count is the count of the copper zones, as the Zone Manager of KiCad lists\nthem: no rule area (keepout), no teardrop, and no zone on non-copper layers only.\nThe size is the bounding box of the Edge.Cuts shapes of the board and of its\nfootprints, with the line width (BOARD::ComputeBoundingBox): an outline of 100 x\n100 mm with lines of 0.15 mm gives 100.15 x 100.15 mm. The pad count is all pads of\nthe footprints, also NPTH (FOOTPRINT::GetPadCount).\n\nWith the text reader (no pcbnew), the answer has no size, no net count and no design\nrules.","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_pcb file."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":196},{"name":"analyze_pcb_nets","title":null,"description":"Give the routing of a board: track widths, vias, net lengths and layers.\n\nThe tool gives the distribution of the track widths and of the via drills, the\nlayer spans of the vias, the tracks of each layer, the nets by the length of their\ntracks, and a comparison with the design rules of the board. The zone count is the\ncount of the copper zones, as the Zone Manager of KiCad lists them: no rule area\n(keepout), no teardrop, and no zone on non-copper layers only.\n\nThe tool lists the 20 nets with the longest tracks. The warning about narrow\ntracks is a rule of the tool (a track narrower than half of the current track\nwidth of the board settings), not a DRC result: run_drc gives the checks of KiCad.\nWith the text reader (no pcbnew), the answer has no board size and no comparison\nwith the design rules.","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_pcb file."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":220},{"name":"find_tracks_by_net","title":null,"description":"Give the tracks and the vias of one net of a board, with their lengths and widths.\n\nThe tool also gives the copper zones of the net (no rule area, no teardrop), each\nwith all of its copper layers on the board, from the top. \"Track Layers\" is the\nlayers of the tracks only. For a net with no tracks, vias or zones, the tool gives\nthe nets whose name contains the name (no difference between upper and lower case).\n\nThe layers are the standard names of the copper layers (F.Cu, In1.Cu, B.Cu), also\nwhen the layer table of the board has user names for them (\"Top\"): KiCad shows the\nuser names in its GUI.\n\nGive the full net name of the board, case-sensitive (for example \"/SDA\" for a local\nlabel of the root sheet). The total length is the sum of the track segments, with\nno vias and no pads. The tables show 50 segments and 20 vias, in the order of the\nboard file. The warning about different track widths comes from the tool, not from\na DRC. With the text reader (no pcbnew), the zones have no fill state.","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"net_name","type":"string","required":true,"description":"The name of the net."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":291},{"name":"analyze_pcb_signal_integrity","title":null,"description":"Give the differential pairs, the RF tracks and the longest signal nets of a board (heuristic).\n\nThe tool finds a differential pair from the ends of two net names, case-sensitive:\n_P/_N, _DP/_DN, _TXP/_TXN, _RXP/_RXN, _M/_S and _POS/_NEG (for example USB_DP and\nUSB_DN). It does not find + and - (USB_D+ and USB_D-). The status of a pair uses\nfixed limits of the tool (OK below 0.127 mm, Marginal below 0.5 mm, else\nMismatch), not the rules of the board. The length is the sum of the track\nsegments, with no vias and no pads.\n\nAn RF net has ANT, RF or FEED in its name, and not VDD or GND. The longest signal\nnets (15) are the nets whose name has no power word (VDD, VCC, GND, VSS, 3V3, 5V,\n1V8, PGND, VBUS). The tool also gives the 10 nets with the most vias.\n\nWith the text reader (no pcbnew), the answer has no design rules of the\ndifferential pairs.","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"net_name","type":"string","required":false,"description":"Optional name of one net to analyze in detail."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":307},{"name":"analyze_pcb_power_integrity","title":null,"description":"Give the copper zones of a board and the routing of its power nets (heuristic).\n\nThe tool finds a power net and a ground net from its name, and gives the copper\nzones of each and the tracks of the power nets. A power net has VDD, VCC, VSS, 3V3,\n5V, 1V8, VBUS, LDO or DCDC in its name; a ground net has GND, PGND, AGND, DGND or\nCHASSIS (no difference between upper and lower case).\n\nThe copper zones are the zones of the Zone Manager of KiCad: no rule area\n(keepout), no teardrop, and no zone on non-copper layers only. A zone can be on more\nthan one copper layer: the tool gives all of its copper layers on the board, from\nthe top, and counts each of them for the GND coverage. On a board with more than 2\ncopper layers, a warning tells when the GND zones are not on each copper layer:\nthis warning comes from the tool, not from a check of KiCad. \"filled\" is the fill\nstate that the file has. With the text reader (no pcbnew), the zones have no fill\nstate.","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_pcb file."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":293},{"name":"setup_pcb_layout","title":null,"description":"Make a new board with an outline, next to the schematic.\n\nThe board has the name of the schematic, a rectangle of four lines on Edge.Cuts,\ntwo copper layers and the default design rules. It has no footprints, tracks or\nnets: use \"Update PCB from Schematic\" of KiCad for the footprints. The rectangle\ngoes from (0, 0) to (width, height): its top left corner is at the top left corner\nof the page.\n\npcbnew of the installed KiCad makes the board (a Python with pcbnew is\nnecessary), thus the board has the file format of the installed KiCad, as\nwhen the user makes it in the PCB editor. When that is newer than the\nKiCad of the schematic, the output has a warning: tell the user that the\nolder KiCad cannot open the board. The tool does not change the project\nfile.\n\nWhen the .kicad_pcb file exists, the tool does not write it and returns\nan error. A new board removes all footprints, tracks and zones of the\nexisting board. Ask the user before you set overwrite=True.","inputs":[{"name":"height","type":"number","required":false,"description":"The height of the board in the unit (default 100)."},{"name":"overwrite","type":"boolean","required":false,"description":"True replaces an existing .kicad_pcb file. Set it only after\nthe user agreed to lose the existing board."},{"name":"schematic_path","type":"string","required":true,"description":"The .kicad_sch file. The board gets its name and its\ntitle."},{"name":"unit","type":"string","required":false,"description":"\"mm\" (default) or \"mil\"."},{"name":"width","type":"number","required":false,"description":"The width of the board in the unit (default 100)."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":357},{"name":"export_gerber","title":null,"description":"Export the Gerber and drill files of a board with kicad-cli, for fabrication.\n\nThe tool runs \"kicad-cli pcb export gerbers\", then \"kicad-cli pcb export drill\",\nand gives the files that kicad-cli wrote.\n\nThe Gerber files use the plot settings that the board saves, as the Plot dialog of\nKiCad (--board-plot-params, PCBNEW_JOBS_HANDLER::JobExportGerbers): the options\nof the dialog and its selection of the layers that are not copper. kicad-cli plots\neach copper layer of the board, also a copper layer that the dialog does not\nselect. The output folder of the dialog has no effect: the files go to\noutput_dir. The drill files have the drill origin of the board (the auxiliary\norigin when the plot settings use it, as the drill dialog). The other options of\nthe drill dialog (format, units, zeros, map) are settings of the user, not of the\nboard: the drill files use the default options of kicad-cli (Excellon, mm).\nkicad-cli always writes the Gerber job file (.gbrjob), also when the plot settings\nof the board do not create it: kicad-cli has no option for it.\n\nThe tool deletes no file in output_dir: a file of an earlier export stays, and the\nlist gives only the files that this export wrote or changed. A failed drill export\nis a warning: the Gerber files stay.","inputs":[{"name":"output_dir","type":"string","required":false,"description":"Optional folder of the files. Default: the folder \"gerber\"\nnext to the board."},{"name":"pcb_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"refill_zones","type":"boolean","required":false,"description":"True: kicad-cli fills all zones again before the plot\n(--check-zones), as the Plot dialog of KiCad does by default (its check\nbox \"Check zone fills before plotting\" is on). The fill is only in\nmemory…"}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":461},{"name":"run_erc","title":null,"description":"Run the ERC of kicad-cli on a schematic, with the annotation check of the ERC dialog.\n\nThe tool uses the severities of the project. It also runs the annotation check\nof the ERC dialog of KiCad (symbols that are not annotated, duplicate\nreferences, units with different values), which kicad-cli does not run. For a\nsub-sheet, the tool checks the root schematic of the project (the answer tells\nit).\n\nThe table shows the first 20 violations, with the description cut to 50\ncharacters: first the violations of the annotation check, then the violations of\nthe report of kicad-cli in its order. get_erc_violations gives all of them. The\ntable also has the violations that the project excludes, marked \"(excluded)\":\nTotal Violations counts them, the counts of errors and warnings do not.","inputs":[{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":206},{"name":"run_drc","title":null,"description":"Run the DRC of kicad-cli on a board.\n\nThe tool uses the severities of the project. When the schematic of the board\nname is next to the board, the DRC also checks the parity of the schematic and\nthe board. The answer tells if the DRC used new zone fills or the fills of the\nfile.\n\nThe table shows 20 violations: the errors first, and in each severity the\nunconnected items and the schematic parity items before the other violations\n(they are at the end of the report). The description is cut to 40 characters:\nget_drc_violations gives all of them. The table also has the violations that the\nproject excludes, marked \"(excluded)\", after the others: Total Violations counts\nthem, the counts of errors and warnings do not.","inputs":[{"name":"pcb_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"refill_zones","type":"boolean","required":false,"description":"True: kicad-cli fills all zones again before the DRC\n(--refill-zones), as the DRC dialog of KiCad does by default (its check\nbox \"Refill all zones before performing DRC\" is on). The fill is only in\nm…"}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":331},{"name":"get_erc_violations","title":null,"description":"Give the ERC violations of a schematic, with a filter by severity.\n\nThe tool uses the last ERC report until a schematic file or a project file\nchanges: then it runs the ERC again (as run_erc, with the annotation check of the\nERC dialog). The list has all violations of the severity. An excluded violation\nshows with \"(excluded)\" and does not count.","inputs":[{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"severity","type":"string","required":false,"description":"Optional severity: \"error\" or \"warning\". Empty: all violations."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":129},{"name":"get_drc_violations","title":null,"description":"Give the DRC violations of a board, with a filter by type.\n\nThe tool uses the last DRC report of the same zone mode until the board, a project\nfile, a .kicad_dru file or a schematic of the project changes: then it runs the DRC\nagain (run_drc). The list has all violations of the type. An excluded violation\nshows with \"(excluded)\" and does not count. A filter that matches no active\nviolation gives \"✅\" only when the board has no active violation of an other type,\nelse \"⚠️\" with their count (also for a type with a typing error).","inputs":[{"name":"pcb_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"refill_zones","type":"boolean","required":false,"description":"True: kicad-cli fills all zones again before the DRC\n(--refill-zones), as the DRC dialog of KiCad does by default (its check\nbox \"Refill all zones before performing DRC\" is on). The fill is only in\nm…"},{"name":"violation_type","type":"string","required":false,"description":"Optional type of the violations, as the DRC report of\nKiCad gives it, for example \"clearance\". Empty: all violations."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":337},{"name":"export_erc_report","title":null,"description":"Run the ERC of kicad-cli on a schematic and copy its JSON report into a file.\n\nThe tool replaces an existing output file. The JSON report is the report of\nkicad-cli: it has the excluded violations (\"excluded\": true), and not the\nannotation errors of the ERC dialog (the answer tells them).","inputs":[{"name":"output_path","type":"string","required":false,"description":"Optional file of the report. Default:\n<schematic>_erc_report.json next to the schematic."},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":124},{"name":"export_drc_report","title":null,"description":"Run the DRC of kicad-cli on a board and copy its JSON report into a file.\n\nThe tool replaces an existing output file. The JSON report is the report of\nkicad-cli: it has the excluded violations (\"excluded\": true).","inputs":[{"name":"output_path","type":"string","required":false,"description":"Optional file of the report. Default: <board>_drc_report.json\nnext to the board, or <board>_drc_refill_report.json with refill_zones\n(the JSON report of kicad-cli does not tell the zone mode)."},{"name":"pcb_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"refill_zones","type":"boolean","required":false,"description":"True: kicad-cli fills all zones again before the DRC\n(--refill-zones), as the DRC dialog of KiCad does by default (its check\nbox \"Refill all zones before performing DRC\" is on). The fill is only in\nm…"}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":277},{"name":"detect_pin_conflicts","title":null,"description":"Give the pin conflicts of a schematic: the items of the ERC of kicad-cli about the\nconnections of the symbol pins.\n\nThe tool runs the ERC of kicad-cli on the full project (as run_erc, with the\nseverities, the pin map and the exclusions of the project) and gives only these\nitems of the ERC of KiCad 10:\n\n- pin_to_pin: two connected pins whose electrical types conflict in the pin map of\n  the project (an error or a warning). In the default pin map of KiCad, two open\n  collector pins, two open emitter pins or two tri-state pins are OK: a wired OR or\n  a tri-state bus is not a conflict.\n- pin_not_driven, power_pin_not_driven: an input or a power input pin with no\n  output or power output pin on its net.\n- pin_not_connected, no_connect_connected: a pin with no connection and no \"no\n  connection\" flag, or a pin with the flag that is connected.\n- isolated_pin_label: a label that connects to only one pin.\n- duplicate_pins, different_unit_net: pins of one number, or a shared pin of the\n  units, on different nets.\n- ground_pin_not_ground: a ground pin that is not on a ground net.\n- missing_input_pin, missing_bidi_pin, missing_power_pin: the pins of a unit that\n  is not placed.\n\nThe other items of the ERC (for example a wire end off the grid) are in run_erc.\nThe tool uses the last ERC report until a schematic file or a project file\nchanges: then it runs the ERC again. An excluded violation shows with \"(excluded)\"\nand does not count. \"✅\" comes only when the\nschematic is fully annotated: KiCad connects the pins by their references. With\nKiCad 8 or 9 installed, the answer has a warning: the list of items is the list of\nKiCad 10.","inputs":[{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"severity","type":"string","required":false,"description":"Optional severity: \"error\" or \"warning\". Empty: all violations."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":465},{"name":"create_kicad_project","title":null,"description":"Create a new KiCad project, as the project manager of the installed KiCad\n(8, 9 or 10) makes it.\n\nWith no template (\"empty\"), the project gets the files of \"New Project\" of\nKiCad: KiCad 8 and 9 copy the project file kicad.kicad_pro of KiCad and\nwrite an empty schematic and board. KiCad 10 makes the project from its\ntemplate \"default\" (it makes that template when it is not there). With a\ntemplate, the project gets the files of \"New Project from Template\": the\nfiles of the template with the project name in the place of the template\nname, then the files that are missing. KiCad does not change the files of a\ntemplate. The tool then writes the title, the company and the date into the\ntitle block of the root schematic that it wrote.\n\nWhen the project folder is not empty (no template), or it has files of the\ntemplate, KiCad asks the user. The tool then gives an error: ask the user,\nthen call it again with overwrite=True.","inputs":[{"name":"company","type":"string","required":false,"description":"Optional name of the company."},{"name":"overwrite","type":"boolean","required":false,"description":"True after the user confirmed: with a template, the files of\nthe template replace the files with the same names; with no\ntemplate, the tool makes the project in a folder that is not empty\n(the files…"},{"name":"project_name","type":"string","required":true,"description":"Name of the project. As in the file dialog of KiCad, the\nextension \".kicad_pro\" (or a last \".\") goes: \"board.kicad_pro\" gives \"board\"."},{"name":"project_path","type":"string","required":true,"description":"The folder of the project."},{"name":"template","type":"string","required":false,"description":"\"empty\" (default) for a blank project, or a KiCad template:\na name on the template pages of KiCad (KICAD_USER_TEMPLATE_DIR and\nKICAD<version>_TEMPLATE_DIR, for example \"Arduino_Uno\") or the path of a…"},{"name":"title","type":"string","required":false,"description":"Optional title of the project. Default: project_name."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":460},{"name":"list_schematic_components","title":null,"description":"Give the components of a schematic file.\n\nEach placed symbol of the file is in the list one time for each sheet path of\nthe file, with the reference and the unit that KiCad gives that path (a sheet\nthat the hierarchy uses two times gives two references). Power symbols are not\ncomponents. The tool needs kicad-cli (the rules of the KiCad version).\n\nEach placed unit of a package is a row of its own with the same reference (U1 four\ntimes for four units), and the table has no unit column. This is correct, not a\nduplicate reference. Total counts the rows (the placed units), not the packages.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"filter_dnp","type":null,"required":false,"description":"Optional: True gives only the DNP components, False only the\ncomponents that are not DNP."},{"name":"filter_type","type":null,"required":false,"description":"Optional start of the references, for example \"R\", \"C\" or\n\"U\" (no difference of case). \"R\" also gives RV1 and RN1."},{"name":"filter_value","type":null,"required":false,"description":"Optional text in the Value field (no difference of case)."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":249},{"name":"get_symbol_details","title":null,"description":"Give the fields and the pins of one component of a schematic.\n\nThe fields are each field of the placed symbol as KiCad 10 loads it: the mandatory\nfields (Reference, Value, Footprint, Datasheet, Description), then the user fields\n(for example MPN) in the order of the file. Each text is a JSON string: \"\" is an\nempty field, and \"\\n\" in it is a line feed. Some properties of the result come\nfrom the load of KiCad and are correct:\n\n- \"~\" of a file older than KiCad 10 is an empty text. KiCad removes the white space\n  at the two ends of the text of a mandatory field, not of a user field.\n- A user field with the name of an earlier field gets the name \"<name>_1\" (to\n  \"<name>_9\").\n\nLimits: the tool reads the saved files, thus a change that KiCad has not saved is\nnot in the result. The position, the unit, the sheet and the fields come from the\nfirst placed unit. A unit of the package with other field texts gets a warning\nline. With KiCad 8 or 9 installed, the tool gives only the mandatory fields.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"reference","type":"string","required":true,"description":"The reference of the component, for example \"R1\" or \"U1\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":307},{"name":"search_symbols","title":null,"description":"Find the components of a schematic whose reference, value or library ID match a pattern.\n\nThe tool searches only the components of this file (in each of its sheet paths),\nnot the sheets below it. A component matches when the pattern is in a part of the\ntext (Python re.search). The table shows the first 50 matches, and the count of\nthe others.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"pattern","type":"string","required":true,"description":"A regular expression with the syntax of the Python module re (no\ndifference of case). Empty: all components. A pattern that is not a\nregular expression gives an error, and a search that takes longer…"},{"name":"search_fields","type":"string","required":false,"description":"The fields to search: \"all\" (default), \"reference\", \"value\"\nor \"library\"."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":187},{"name":"list_schematic_nets","title":null,"description":"Give the names of the labels and of the power symbols of a schematic file.\n\nThe table gives the names of the labels and of the power symbols of this file, not\nthe nets of KiCad: KiCad adds the sheet path to a local label of a sub-sheet\n(\"/Power/VIN\"), gives one name to a net with more labels, and names a net with no\nlabel. A label with no connection is in the list too. Each name is in the list one\ntime. Type is the first kind that has the name, in this sequence: global, local,\nhierarchical, power. Code is the index of the name when the tool reads the kinds\nin this sequence, each in the order of the file (from 0): it is not the net code\nof the netlist. Use generate_netlist on the root schematic for the nets of KiCad.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"filter_power","type":"boolean","required":false,"description":"True gives only the nets whose name has \"gnd\", \"vcc\", \"vdd\",\n\"vss\", \"+\" or \"-\" (heuristic)."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":249},{"name":"get_schematic_info","title":null,"description":"Give the title block, the counts and the sheets of a schematic file.\n\nThe components and the sheet symbols are the ones that KiCad loads for the\nproject of the file (the references of each sheet path). The tool needs\nkicad-cli (the rules of the KiCad version). A package with more units is one\ncomponent. Total Nets is the number of the names of the labels and of the power\nsymbols of the file (as list_schematic_nets gives them), not the number of the\nnets of the netlist.","inputs":[{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":141},{"name":"add_hierarchical_label","title":null,"description":"Add a hierarchical label on a pin of a component.\n\nA hierarchical label in a sub-sheet connects its net to the pin with the same\nname of the sheet symbol in the parent sheet. The tool puts the label on the\nconnection point of the pin (with the rotation and the mirror of the symbol). The\nangle comes from the direction of the pin, as KiCad orients a label that \"Update\nSchematic from PCB\" adds on a pin: the label points away from the body, also on\nthe long side of a tall symbol. The text goes from the point to the right at 0\ndegrees, up at 90, to the left at 180 and down at 270, as KiCad draws it: a label\nat 180 has its text to the left of the point. This is correct, not a defect. With\nx and y, the angle is 0.\n\nThe tool changes only the sub-sheet. It does not add the sheet pin to the sheet\nsymbol in the parent sheet, and KiCad connects the label to the parent sheet only\nthrough a sheet pin with the same name. Tell the user to add the sheet pin in the\nschematic editor of KiCad: until then, ERC gives hier_label_mismatch. Make sure\nthat the connection is in the netlist: generate_netlist.\n\nThe tool finds the symbol by the Reference field in the file, not by the reference\nof each sheet path: in a sheet that the hierarchy uses more than one time, the\nreference of an other sheet path is not found.\n\nKiCad must not have the schematic open: the tool refuses the write (the lock file\nof KiCad). The tool also refuses the write when the file changed after the tool read\nit. A schematic of an older file version than the installed KiCad writes is an\nerror: the user converts it in KiCad first (the output gives the step).","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_sch file of the sub-sheet."},{"name":"label_name","type":"string","required":false,"description":"The text of the label. Empty: \"<reference>.<pin>\" (also with\nx and y)."},{"name":"pin","type":"string","required":true,"description":"The pin number."},{"name":"reference","type":"string","required":true,"description":"The reference of the component, for example \"U1\"."},{"name":"shape","type":"string","required":false,"description":"The electrical type of the label: \"input\" (default), \"output\",\n\"bidirectional\", \"tri_state\" or \"passive\". ERC uses it."},{"name":"snap_to_grid","type":"boolean","required":false,"description":"Only for x and y. True: move the label to the nearest point\nof the connection grid of the project (default 1.27 mm), except on a\nconnection point of the sheet (a pin, a wire, a label)."},{"name":"x","type":null,"required":false,"description":null},{"name":"y","type":null,"required":false,"description":null}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":592},{"name":"add_global_label","title":null,"description":"Add a global label on a pin of a component.\n\nA global label connects the nets with its name in all sheets of the project. The\ntool puts the label on the connection point of the pin (with the rotation and the\nmirror of the symbol). The angle comes from the direction of the pin, as KiCad\norients a label that \"Update Schematic from PCB\" adds on a pin: the label points\naway from the body, also on the long side of a tall symbol. The text goes from the\npoint to the right at 0 degrees, up at 90, to the left at 180 and down at 270, as\nKiCad draws it: a label at 180 has its text to the left of the point. This is\ncorrect, not a defect. With x and y, the angle is 0.\n\nA new global label has the hidden field Intersheetrefs at its point, as KiCad\nmakes it. KiCad shows the field next to the label only when the schematic setting\nshows the references to other sheets. This is correct, not a defect.\n\nThe tool finds the symbol by the Reference field in the file, not by the reference\nof each sheet path: in a sheet that the hierarchy uses more than one time, the\nreference of an other sheet path is not found.\n\nKiCad must not have the schematic open: the tool refuses the write (the lock file\nof KiCad). The tool also refuses the write when the file changed after the tool read\nit. A schematic of an older file version than the installed KiCad writes is an\nerror: the user converts it in KiCad first (the output gives the step).","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_sch file."},{"name":"label_name","type":"string","required":true,"description":"The name of the net."},{"name":"pin","type":"string","required":true,"description":"The pin number."},{"name":"reference","type":"string","required":true,"description":"The reference of the component, for example \"U1\"."},{"name":"shape","type":"string","required":false,"description":"The electrical type of the label: \"input\" (default), \"output\",\n\"bidirectional\", \"tri_state\" or \"passive\". ERC uses it."},{"name":"snap_to_grid","type":"boolean","required":false,"description":"Only for x and y. True: move the label to the nearest point\nof the connection grid of the project (default 1.27 mm), except on a\nconnection point of the sheet (a pin, a wire, a label)."},{"name":"x","type":null,"required":false,"description":null},{"name":"y","type":null,"required":false,"description":null}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":522},{"name":"add_component_from_library","title":null,"description":"Add a symbol of a KiCad symbol library to the schematic.\n\nThe library comes from the library tables of the installed KiCad and of the\nproject, as in the symbol chooser of KiCad: a library of the project table\nreplaces a global library with the same name. A derived symbol gets the\nunits, the pins and the drawings of its parents. When the schematic has the\nsymbol in its lib_symbols section, the tool uses that definition. The tool\ngets the version of the installed KiCad from kicad-cli, to find the global\nlibrary table.\n\nThe placed symbol gets the fields of the library symbol (Datasheet,\nDescription, user fields) at their library positions, the flags\nexclude_from_sim, in_bom, on_board and in_pos_files of the library symbol,\nand the reference of its sheet path, as KiCad places a symbol. The tool\ndoes not move the fields (KiCad: autoplace).\n\nWith KiCad 10.0, the copy of the library symbol and its fields are the text of a\nsave of the library in kicad-cli (a library that KiCad did not save gets the\ntexts of KiCad: no blanks at the ends of a mandatory field, the canonical field\nnames, \"<name>_1\" for a second field of one name). kicad-cli saves the symbol\nwith its parents one time (about 0.2 s), and again after a change of their text; a\ncache keeps the last saves.\n\nThe connection grid is schematic.connection_grid_size of the project file\n(default 1.27 mm). ERC finds a pin off this grid (endpoint_off_grid).\n\nAs the schematic editor of KiCad, the tool removes the part of a wire\nbetween two pins of the new symbol, and adds a junction where a pin is in\nthe middle of a wire. The output tells each junction and each changed wire.\n\nThe tool places the symbol at 0 degrees, with no mirror, in body style 1. It\ncannot rotate or mirror a symbol, and cannot place an other body style (De\nMorgan): tell the user to do this in KiCad. One call places one unit: for the\nother units of a package, call the tool again with the same reference and the\nnext unit. The tool does not check that the refer…","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_sch file."},{"name":"footprint","type":"string","required":false,"description":"The footprint. Empty: the footprint of the library symbol."},{"name":"library_name","type":"string","required":true,"description":"The library name of the library tables."},{"name":"reference","type":"string","required":true,"description":"The reference, for example \"R1\"."},{"name":"sheet_path","type":"string","required":false,"description":"Only for a sheet file that the hierarchy uses more than\none time: the sheet that gets the reference, as the sheet names\n(\"/Power/\") or the UUID path. The error lists the sheet paths."},{"name":"snap_to_grid","type":"boolean","required":false,"description":"True: move the symbol to the nearest position that puts\nits pins on the connection grid. When the move takes a pin away\nfrom a connection point of the sheet (a pin, a wire, a label), the\nsymbol stays…"},{"name":"symbol_name","type":"string","required":true,"description":"The symbol name in the library."},{"name":"unit","type":"integer","required":false,"description":"The unit, from 1 to the number of units of the symbol."},{"name":"value","type":"string","required":true,"description":"The text of the Value field."},{"name":"x","type":"number","required":false,"description":null},{"name":"y","type":"number","required":false,"description":null}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":900},{"name":"add_wire","title":null,"description":"Add a wire to the schematic: a line through two or more points.\n\nA KiCad wire has two points (SCH_LINE). The tool adds one wire for each\nsegment, as KiCad saves a line with corners.\n\nAs the schematic editor of KiCad, the tool merges the segments that are\non one straight line, merges a new wire with a wire of the sheet on the\nsame straight line that it touches, removes the part of a new wire\nbetween the two pins of a symbol with two pins, and adds a junction where\nthree or more wire directions meet (a wire end or a pin in the middle of\na wire). The output tells each junction and each changed wire.\n\nThe connection grid is schematic.connection_grid_size of the project file\n(default 1.27 mm). ERC finds a wire end off this grid (endpoint_off_grid).\n\nThe tool adds wires only, not buses or bus entries. A wire that the sheet has\nalready gives \"No change\".\n\nKiCad must not have the schematic open: the tool refuses the write (the lock file\nof KiCad). The tool also refuses the write when the file changed after the tool read\nit. A schematic of an older file version than the installed KiCad writes is an\nerror: the user converts it in KiCad first (the output gives the step).","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_sch file."},{"name":"points","type":"array","required":true,"description":"The points (x, y) in mm. Each point after the first ends a segment."},{"name":"snap_to_grid","type":"boolean","required":false,"description":"True: move each point to the nearest point of the\nconnection grid. A point on a connection point of the sheet (a\npin, a wire end, a junction, a label) stays. A point in the middle\nof a wire moves onl…"}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":416},{"name":"add_label","title":null,"description":"Add a local label (text label) to the schematic.\n\nThe text goes from the point to the right at 0 degrees, up at 90, to the left at 180\nand down at 270, and KiCad keeps it upright: a label at 180 has its text to the left\nof the point (right justified), as KiCad draws it. This is correct, not a defect. The\npoint is the connection point: put it on the end of a wire or on a pin. A label\nconnects at each point of a wire, also in its middle: the tool adds no junction for\nit. A label on a bus names the bus.\n\nKiCad must not have the schematic open: the tool refuses the write (the lock file\nof KiCad). The tool also refuses the write when the file changed after the tool read\nit. A schematic of an older file version than the installed KiCad writes is an\nerror: the user converts it in KiCad first (the output gives the step).","inputs":[{"name":"file_path","type":"string","required":true,"description":"The .kicad_sch file."},{"name":"orientation","type":"number","required":false,"description":"The angle: 0, 90, 180 or 270 (KiCad reads no other angle of a\nlabel). Use the angle that points away from the wire or the pin, thus the\ntext does not cover them."},{"name":"snap_to_grid","type":"boolean","required":false,"description":"True: move the label to the nearest point of the\nconnection grid of the project (default 1.27 mm), except on a\nconnection point of the sheet (a pin, a wire, a label). A label in the\nmiddle of a wire…"},{"name":"text","type":"string","required":true,"description":"The label text."},{"name":"x","type":"number","required":true,"description":null},{"name":"y","type":"number","required":true,"description":null}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":382},{"name":"search_components_by_type","title":null,"description":"Find the components of a type, for example OLED, sensor or display (heuristic).\n\nThe tool searches the value, the footprint and the net names of each\ncomponent. It reads the netlist that kicad-cli writes now: each component of\neach sheet path, at each level of the hierarchy, with the reference of that\npath. The netlist has no power symbols and no symbol with no library symbol.\nThe tool needs kicad-cli.\n\nThe types OLED, sensor, display, SPI, I2C, UART, power, memory and wireless\nsearch a list of words (for example SPI: spi, mosi, miso, sck, cs). An other type\nis one word to search. The tool finds a word in a part of the value, of the\nfootprint or of a net name of the component (no difference of case). Thus a\ncomponent on a net of the type (a pull-up resistor on SDA) is in the result, and\nshort words (cs, tx, rx, esp) give false matches. The output gives the words.\nEach component shows its first 10 connections.","inputs":[{"name":"component_type","type":"string","required":true,"description":"The type of component, for example \"OLED\", \"sensor\",\n\"display\", \"SPI\" or \"I2C\"."},{"name":"file_path","type":"string","required":true,"description":"A .kicad_sch file of the project."},{"name":"search_in_subsheets","type":"boolean","required":false,"description":"True (default): the components of the file and of all\nsheets below it (for the root schematic: the full project). False: only\nthe components that are placed in the file."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":345},{"name":"set_symbol_fields","title":null,"description":"Write the fields of placed symbols, as KiCad writes them.\n\nThe tool writes each field into each unit of the reference (one package\nhas one Value and one MPN). A field that the symbol does not have becomes\na new field, hidden as KiCad 9 and 10 make it (a file of KiCad 8: visible;\nValue_Confirmed and MPN_Confirmed: always hidden). With a variant (KiCad 10), the\ntool writes the fields of that variant into each unit: a value equal to the\nfield of the symbol removes the field from the variant. The tool checks all\nchanges and all files first, and writes no file when a check fails. It writes\nall files or no file: an error of the disk also changes no file. KiCad must not\nhave the files open. A schematic file of the project with an older version than\nthe installed KiCad writes is an error: the user converts it in KiCad first (the\noutput gives the step).\n\nA symbol in a sheet that the hierarchy uses more than one time has one set\nof fields for all its references (U201 and U301): give the same fields for\neach of these references, or write different fields through a variant.\n\nThe tool refuses a reference that is not annotated (U?), a duplicate reference,\nthe field Reference, a mandatory field name in an other case (\"value\": give\n\"Value\"), the fields Sim.Enable and Spice_Netlist_Enabled (KiCad removes them when\nit loads the symbol), a symbol with two fields of one name (a mandatory field\ntwo times, or more than ten user fields of one name), a file that KiCad loads\nunder more than one name, and a project whose full sheet hierarchy the tool\ncannot read. An error gives the reason, and the step in KiCad when one is\nnecessary.\n\nWith KiCad 10, the field names are the names that KiCad gives the fields when it\nloads the symbol, as get_symbol_details gives them: a second field \"MPN\" of the\nfile has the name \"MPN_1\" (to \"MPN_9\"). Give that name to write that field: the\ntool changes its text and keeps its name in the file (KiCad writes \"MPN_1\" at its\nnext save). With KiCad 8 and 9, the nam…","inputs":[{"name":"changes","type":"array","required":true,"description":"One item for each reference (and variant): the reference, the\nfields by name, and the variant name (empty: the symbol)."},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project. The tool finds the\nreferences in the full project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":689},{"name":"set_symbol_attributes","title":null,"description":"Write the attributes of placed symbols, as the Symbol Properties dialog of KiCad 10\nsets them: \"Do not populate\" (dnp), \"Exclude from bill of materials\", \"Exclude from\nboard\", \"Exclude from position files\" and \"Exclude from simulation\".\n\nThe tool writes each attribute into each unit of the reference. KiCad 10.0.6 gives\nthe other units the same DNP and Exclude from BOM, board and position files, but\nnot Exclude from simulation (it keeps that one for each unit): the tool sets each\nunit, as the dialog on each unit does. The tool changes only the attributes. The\nOK of the dialog also copies the fields of the unit (not the Reference) to the\nother units (SCH_SYMBOL::SyncOtherUnits). The tool does not copy the fields: units with\ndifferent fields keep them (set_symbol_fields changes the fields).\n\nWith a variant (KiCad 10), the tool writes the attributes of that variant: a value\nequal to the attribute of the symbol is no differential, and KiCad writes no\nvariant with no differentials. A change of an attribute of the symbol does not\nchange the variants: KiCad keeps the old value in each variant (the variant starts\nwith the attributes of the symbol when KiCad loads the file), thus the file then\nhas the old value as a token of each variant. This is correct, not a defect.\n\nA symbol in a sheet that the hierarchy uses more than one time has one set of\nattributes for all its references (U201 and U301): give the same attributes for each\nof these references, or write different attributes through a variant.\n\nThe tool checks all changes and all files first, and writes no file when a check\nfails. It writes all files or no file. KiCad must not have the files open. A\nschematic file of the project with an older version than the installed KiCad writes\nis an error: the user converts it in KiCad first. The tool refuses a reference that\nis not annotated (U?), a duplicate reference, a variant that the project does not\nhave, an attribute name that it does not know, a symbol with no token for an…","inputs":[{"name":"changes","type":"array","required":true,"description":"One item for each reference (and variant): the reference, the\nattributes to set (a missing attribute does not change), and the variant\nname (empty: the symbol)."},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project. The tool finds the\nreferences in the full project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":625},{"name":"render_pcb","title":null,"description":"Render a 3D view of a board as an image with kicad-cli (KiCad 9 or later).\n\nThe image has the board and the 3D models of the footprints: a footprint with no\n3D model has no body in the image. Use the image for a visual review of the layout.\nThe tool replaces an existing image file with the same name.","inputs":[{"name":"height","type":"integer","required":false,"description":"The height of the image in pixels (default 900)."},{"name":"output_path","type":"string","required":false,"description":"Optional image file: .png, or .jpg or .jpeg for a JPEG image.\nDefault: <board>_render_<side>.png next to the board."},{"name":"pcb_path","type":"string","required":true,"description":"The .kicad_pcb file."},{"name":"quality","type":"string","required":false,"description":"\"basic\" (default, fast), \"high\" (ray tracing, slower), \"user\" or\n\"job_settings\" (the settings of KiCad)."},{"name":"rotate","type":"string","required":false,"description":"Optional rotation of the board \"X,Y,Z\" in degrees, for example\n\"-30,0,25\"."},{"name":"side","type":"string","required":false,"description":"The side of the camera: \"top\" (default), \"bottom\", \"left\", \"right\",\n\"front\" or \"back\"."},{"name":"width","type":"integer","required":false,"description":"The width of the image in pixels (default 1600)."}],"outputs":[],"hasOutputSchema":false,"hasExamples":false,"tokenEstimate":283},{"name":"export_pcb_3d","title":null,"description":"Export a board as a STEP 3D model with kicad-cli, for mechanical CAD.\n\nThe model has the board and the 3D models of its footprints. kicad-cli does not\nadd a 3D model that it cannot find or read: the tool then gives a warning with the\nfootprints and the reason. Tell the user about each such footprint. The tool\nreplaces an existing STEP file with the same name.","inputs":[{"name":"board_only","type":"boolean","required":false,"description":"True gives only the board, with no models of the footprints."},{"name":"output_path","type":"string","required":false,"description":"Optional .step or .stp file. Default: <board>.step next to the\nboard."},{"name":"pcb_path","type":"string","required":true,"description":"The .kicad_pcb file."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":168},{"name":"export_schematic_svg","title":null,"description":"Export the pages of a schematic as SVG files with kicad-cli.\n\nkicad-cli renders the pages of the project with the hierarchy of its root\nschematic (the schematic of the project name), thus each page has the\nreferences of its sheet path. For the root schematic, the files are all pages\nof the project. For an other file (a sub-sheet), the files are the pages of\nits sheet paths (a sheet that the hierarchy uses two times gives two pages).\nAn SVG file is a vector image: a zoom shows each detail with no loss. The tool\nneeds kicad-cli. The tool replaces a file with the same name in output_dir; the\nother files of the folder stay.","inputs":[{"name":"output_dir","type":"string","required":false,"description":"Optional folder of the files. Default: <schematic>_svg next\nto the schematic."},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":205},{"name":"assign_footprint","title":null,"description":"Assign footprints to placed symbols, as CvPcb (\"Assign Footprints\") of KiCad 10\ndoes it when it saves.\n\nThe tool writes the footprint into the Footprint field of each unit of the\nreference, in the symbol, not in a variant. A variant with a Footprint of its own\nkeeps it (the tool gives a warning; set_symbol_fields with the variant changes it).\nWhen the old footprint is empty and the field is visible, the field becomes\nhidden, as the save of CvPcb does (\"Footprint field visible\" in the table), also\nwhen the footprint stays empty. CvPcb hides such a field in each symbol of the\nnetlist; the tool changes only the references of the call. An empty footprint\nremoves the footprint.\n\nThe tool checks each footprint as CvPcb has it:\n- The footprint must be in a library that KiCad loads (the global and the project\n  footprint library tables, an enabled row of the type \"KiCad\"), with the same\n  case: else an error.\n- The footprint filters of the symbol (anchored wildcards, with no difference of\n  case; a filter with \":\" compares \"<library>:<footprint>\") and the pin count (the\n  pins of the symbol against the pads of the footprint) give a warning when they do\n  not match. CvPcb then does not show the footprint in that filtered list. The\n  tool still writes the footprint.\n\nThe tool gets the pin count and the filters from the netlist of kicad-cli (the\nnetlist that CvPcb reads). It refuses a reference that the netlist does not have\n(a symbol that is excluded from the board, or in a sheet that is excluded from the\nboard), a power symbol (a reference that starts with \"#\"), a reference that is not\nannotated (U?), a duplicate reference, a symbol with no Footprint field, a Footprint\nfield with a text variable (KiCad compares the resolved text), a footprint ID with\nno library name, and a library of an other type than \"KiCad\". With kicad-cli\n10.0.0 to 10.0.6, a project with more than one top-level sheet is an error.\n\nA symbol in a sheet that the hierarchy uses more than one time has one Fo…","inputs":[{"name":"assignments","type":"array","required":true,"description":"One item for each reference: the reference and the footprint\n(\"<library>:<footprint>\", or empty to remove it)."},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project. The tool finds the\nreferences in the full project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":686},{"name":"ipc_status","title":null,"description":"Show the state of the IPC connection to the running KiCad.\n\nThe IPC tools change the board that is open in the PCB editor of a running KiCad.\nUse this tool first: it shows if the IPC tools can operate now, and the limits of\nthe running KiCad version.","inputs":[{"name":"board_path","type":"string","required":false,"description":"The path of a .kicad_pcb file (optional). The tool then shows if\nthe PCB editor has this board."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":100},{"name":"ipc_get_selection","title":null,"description":"Show the items that the user selected in the PCB editor of the running KiCad.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":52},{"name":"ipc_select_items","title":null,"description":"Select items in the PCB editor of the running KiCad, by reference or by net.\n\nThe selection is no change of the board: KiCad makes no undo step for it. The\nselection filter of the PCB editor does not apply: the API cannot read it.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."},{"name":"mode","type":"string","required":false,"description":"\"replace\" (clear the selection, then select the items), \"add\", \"remove\"\n(remove the items from the selection), or \"clear\" (no references and no\nnets)."},{"name":"nets","type":null,"required":false,"description":"The net names, for example [\"GND\", \"/SDA\"]. They are case-sensitive. A net\ngives its tracks, arcs, vias and shapes: the item types of \"Select All\nTracks in Net\" of KiCad."},{"name":"references","type":null,"required":false,"description":"The references of footprints, for example [\"R1\", \"U3\"]. They are\ncase-sensitive."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":211},{"name":"ipc_place_footprints","title":null,"description":"Place footprints on the board in the PCB editor of the running KiCad.\n\nKiCad does the change. One call is one undo step. The tool checks all placements\nfirst, and changes nothing when a check fails. The tool can only change the side:\na change of the position, the rotation or the lock gives an error (the limits\nfootprint_update_loses_data and footprint_move_children of ipc_status). A\nfootprint that is not on F.Cu or B.Cu gives an error.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."},{"name":"flip_direction","type":"string","required":true,"description":"The flip of a footprint to the other side: \"left_right\" (around\nthe Y axis) or \"top_bottom\" (around the X axis). KiCad flips around the\nposition of the footprint. The API cannot read the flip directi…"},{"name":"override_locks","type":"boolean","required":false,"description":"Flip also a locked footprint, as the PCB editor does with\n\"Override locks\". With false, a locked footprint that must change its side\ngives an error."},{"name":"placements","type":"array","required":true,"description":"For each footprint: the reference, and the side (\"top\" or\n\"bottom\"). x_mm, y_mm, rotation_deg and locked give an error."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":300},{"name":"ipc_save_board","title":null,"description":"Save the board of the PCB editor of the running KiCad into its file.\n\nKiCad saves the board as File > Save does, also the project file. KiCad writes the\nfile version of the running KiCad.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":80},{"name":"ipc_refill_zones","title":null,"description":"Fill all zones of the board in the PCB editor of the running KiCad.\n\nKiCad fills the zones as \"Fill All Zones\" does, with its progress dialog. The tool\nwaits for the end of the fill.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."},{"name":"timeout_s","type":"number","required":false,"description":"The longest time to wait for the end of the fill, 1 to 3600 s."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":110},{"name":"ipc_add_tracks","title":null,"description":"Add straight tracks and through vias on one net of the board in the PCB editor.\n\nKiCad adds the items in one undo step. The sizes come from the netclass of the net,\nor from the arguments (the router of the PCB editor uses the sizes that the user\nselected in the editor, which can be other sizes). KiCad checks no\nclearance: the answer tells the user to run DRC. The tool refuses a net that the\nboard does not have. KiCad 10.0.6 must have the schematic editor closed (KiCad bug\n#24966).\n\nWhen the running KiCad has the limit free_via (ipc_status), each via must be at an\nend of a new track of the same call: an other via gives an error. A track with the\nsame start and end, and a via drill that is not smaller than the via size, give\nan error. After an error, the tool changed nothing.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."},{"name":"net","type":"string","required":true,"description":"The name of the net, for example \"GND\" or \"/SDA\" (case-sensitive)."},{"name":"tracks","type":null,"required":false,"description":"The tracks: start, end (mm) and copper layer of each one."},{"name":"via_drill_mm","type":null,"required":false,"description":"The via drill. Default: the via drill of the netclass."},{"name":"via_size_mm","type":null,"required":false,"description":"The via diameter. Default: the via size of the netclass."},{"name":"vias","type":null,"required":false,"description":"The positions of the through vias (mm)."},{"name":"width_mm","type":null,"required":false,"description":"The track width. Default: the track width of the netclass."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":352},{"name":"ipc_add_zone","title":null,"description":"Add a copper zone with a solid fill on one net and one copper layer of the board in\nthe PCB editor.\n\nThe API gives no default zone settings: the settings are required arguments. When\nthe user did not give them, ask the user. KiCad adds the zone in one undo step, with\nno fill: fill it with ipc_refill_zones. KiCad checks no clearance: the answer tells\nthe user to run DRC. KiCad 10.0.6 must have the schematic editor closed (KiCad bug\n#24966). An outline that crosses itself, has the same point two times one after the\nother, or has no area gives an error.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."},{"name":"border_pitch_mm","type":"number","required":true,"description":"The pitch of the border hatch, 0.1 to 2 mm."},{"name":"border_style","type":"string","required":true,"description":"The border of the zone in the editor: \"solid\", \"hatched_edge\" or\n\"hatched_full\"."},{"name":"clearance_mm","type":null,"required":false,"description":"An own clearance of the zone, 0 to 100 mm: KiCad uses the larger\nof it and the current clearance of the netclass and the rules. Default:\nnone (0), thus only the netclass and the rules apply."},{"name":"connection","type":"string","required":true,"description":"The connection of pads: \"thermal\" (thermal reliefs), \"solid\",\n\"none\", or \"thermal_pth\" (thermal reliefs for through-hole pads only)."},{"name":"island_removal","type":"string","required":true,"description":"Remove isolated islands of the fill: \"always\" or \"never\". (The\nmode with a minimum area is not possible: the API gives no unit for it.)"},{"name":"layer","type":"string","required":true,"description":"A copper layer of the board, for example F.Cu."},{"name":"min_thickness_mm","type":"number","required":true,"description":"The minimum width of the fill, 0.025 mm or more."},{"name":"name","type":"string","required":false,"description":"The name of the zone (optional, not the name of an other zone)."},{"name":"net","type":"string","required":true,"description":"The name of the net, for example \"GND\" (case-sensitive)."},{"name":"outline","type":"array","required":true,"description":"The corners of the zone outline in mm (3 or more points, the first point\nnot again at the end)."},{"name":"priority","type":"integer","required":true,"description":"The zone priority (0 or more)."},{"name":"thermal_gap_mm","type":"number","required":true,"description":"The thermal relief gap (KiCad keeps it also for a solid\nconnection: a pad can have its own thermal connection)."},{"name":"thermal_spoke_width_mm","type":"number","required":true,"description":"The thermal spoke width, not smaller than\nmin_thickness_mm."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":557},{"name":"ipc_add_board_outline","title":null,"description":"Add the board outline: one closed polygon on Edge.Cuts of the board in the PCB\neditor, when the board has no Edge.Cuts shapes.\n\nKiCad adds the outline in one undo step. A board that has Edge.Cuts shapes gives an\nerror: the tools delete no items (KiCad 10.0.6 gives no result of a delete, limit\ndelete_results); the user deletes the old outline in the PCB editor. Footprints can\nhave Edge.Cuts shapes too: the tool does not count them. KiCad 10.0.6 must have the\nschematic editor closed (KiCad bug #24966). An outline that crosses itself, has the\nsame point two times one after the other, or has no area gives an error.","inputs":[{"name":"board_path","type":"string","required":true,"description":"The path of the .kicad_pcb file that is open in the PCB editor."},{"name":"line_width_mm","type":null,"required":false,"description":"The line width. Default: the graphics defaults of the board for\nEdge.Cuts."},{"name":"outline","type":"array","required":true,"description":"The corners of the outline in mm (3 or more points, the first point not\nagain at the end)."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":248},{"name":"job_status","title":null,"description":"Give the background jobs of the tool calls, the state or the result of one job, or\ncancel a job.\n\nA tool call that takes longer than 20 s becomes a background job: its answer starts\nwith \"⏳\" and gives the job ID, and the work continues (also when the client stops to\nwait for the call). This tool gives the result of the job: the same text that the\ntool gives, or the same error. A call of the same tool with the same arguments while\nits job runs starts no second run: it waits for that job again (up to 20 s) and\ngives its result or its ID. The list also has the calls that run in their first\n20 s. The jobs are in the memory of the server process: a restart of the server (of\nthe MCP client) loses them. A finished job stays 1 h (the 50 newest finished jobs).\n\nA cancel stops the task of the job at its next step. Work in a thread does not stop:\nkicad-cli, the Python of KiCad or a file write can still end and change files. Only\nthe schematic edit tools (add_component_from_library, add_wire and the label tools)\ndo not save when the cancel comes before their save. Check the files after a cancel.\nCancel a job only when the user asks.","inputs":[{"name":"cancel","type":"boolean","required":false,"description":"True: cancel the running job job_id."},{"name":"job_id","type":"string","required":false,"description":"The ID of a job. Empty: the list of the jobs of the server process."}],"outputs":[],"hasOutputSchema":false,"hasExamples":false,"tokenEstimate":330},{"name":"create_project_library","title":null,"description":"Make a new, empty library and add it to the project library table, as \"New Library\"\nof the symbol editor and of the footprint editor of KiCad 10 does.\n\nA symbol library is a .kicad_sym file with no symbols, in the format of KiCad 10.0.\nA footprint library is an empty .pretty folder. The new row has the nickname name,\nthe type KiCad, and a URI with a path variable of KiCad or ${KIPRJMOD} when one\nholds the library. The tool does not replace a library that exists. KiCad must not\nhave the project open: KiCad reads the project tables only when it opens the\nproject. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"folder","type":null,"required":false,"description":"The folder of the new library: an absolute path, or a path relative to\nthe project folder. Default: the project folder."},{"name":"kind","type":"string","required":true,"description":"\"symbol\" or \"footprint\"."},{"name":"name","type":"string","required":true,"description":"The name of the library: the file name with no extension, and the\nnickname in the table."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":256},{"name":"add_library_to_table","title":null,"description":"Add a KiCad library that exists to the project library table, as the table dialog\nof KiCad 10 does.\n\nThe library must be of the KiCad format: a .kicad_sym file or a folder with\n.kicad_sym files (symbols), a folder with .kicad_mod files (footprints). The tool\nrefuses other formats. A nickname that the project table has is an error. A\nnickname of the global table gives a warning: the project row hides the global\nlibrary. A library of an older file version gives a warning with the step for its\nupgrade; a library of a newer file version is an error. KiCad must not have the\nproject open. The installed KiCad must be KiCad 10.0.\n\nThe URI of the new row has a path variable of KiCad when its folder holds the\nlibrary (the variable with the most folder levels), else ${KIPRJMOD} when the\nproject folder holds it, else the absolute path (NormalizePath). As the table\ndialog, the tool writes some characters of the nickname as escapes, for example\n\":\" as \"{colon}\".","inputs":[{"name":"description","type":"string","required":false,"description":"The description of the row."},{"name":"kind","type":"string","required":true,"description":"\"symbol\" or \"footprint\"."},{"name":"library_path","type":"string","required":true,"description":"The library file or folder: an absolute path, or a path relative\nto the project folder."},{"name":"nickname","type":null,"required":false,"description":"The nickname in the table. Default: the name of the library with no\nextension, as KiCad gives it."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":347},{"name":"remove_library_from_table","title":null,"description":"Remove a library from the project library table, as the table dialog of KiCad 10\ndoes. The library files stay: KiCad does not delete them.\n\nKiCad must not have the project open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"kind","type":"string","required":true,"description":"\"symbol\" or \"footprint\"."},{"name":"nickname","type":"string","required":true,"description":"The nickname of the row."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":110},{"name":"set_library_table_row","title":null,"description":"Enable, disable, show or hide a library of the project library table, as the table\ndialog of KiCad 10 does.\n\nKiCad does not load a disabled library. A hidden symbol library is loaded, but the\nsymbol chooser and the library tree do not show it. Only a symbol table has the\nvisible flag. KiCad must not have the project open. The installed KiCad must be\nKiCad 10.0.","inputs":[{"name":"enabled","type":null,"required":false,"description":"True enables the library, False disables it. None: no change."},{"name":"kind","type":"string","required":true,"description":"\"symbol\" or \"footprint\"."},{"name":"nickname","type":"string","required":true,"description":"The nickname of the row."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."},{"name":"visible","type":null,"required":false,"description":"True shows the library, False hides it (symbol tables only). None: no\nchange."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":186},{"name":"upgrade_project_libraries","title":null,"description":"Convert the libraries of the project tables to the file version of the installed\nKiCad 10, with kicad-cli (`kicad-cli sym upgrade`, `kicad-cli fp upgrade`).\n\nKiCad converts each library of an older version into a temporary folder. Then\nKiCad saves the result again: the bytes must not change, and the names of the\nsymbols or the footprints must stay. Only then the tool writes the files of that\nlibrary, all or none. The tool makes no backup: git gives the way back, and the\noutput names a library that git cannot give back. A converted library cannot be\nread by an older KiCad. A library outside the project folder (other projects can\nuse it) is converted only when libraries names it or include_outside is True. A\nlibrary of a newer version, and a folder of symbol files, give an error. KiCad must\nnot have the project open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"include_outside","type":"boolean","required":false,"description":"True also converts the libraries outside the project folder."},{"name":"libraries","type":null,"required":false,"description":"The nicknames of the libraries to convert. Default: all libraries\nof the project tables."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":278},{"name":"copy_symbol_to_library","title":null,"description":"Copy a symbol into a library of the project table, as \"Save As\" of the symbol\neditor of KiCad 10 does.\n\nTo an other library, a derived symbol goes with its parents (KiCad copies the full\nparent chain; only the symbol gets the new name). flatten=True saves only the\nflattened symbol, as the \"Flatten\" check box. The Value gets the new name when it\nwas equal to the old name.\n\nThe copy starts from the symbols as KiCad loads them: the text of a save of the\nlibrary in kicad-cli (about 0.2 s, a cache keeps the last saves). Thus a library\nthat KiCad did not save gives the texts of KiCad: no blanks at the ends of a\nmandatory field, the canonical field names (\"value\" is \"Value\"), \"<name>_1\" for a\nsecond field of one name. The Value follows the new name also when the file has\n\"value\" or blanks at the ends of the old name. KiCad saves the library\n(kicad-cli), and a second save must give the same bytes.\n\nThe target must be a symbol library file of the project table in the version of\nthe installed KiCad (else: upgrade_project_libraries first). KiCad must not have\nthe project open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"flatten","type":"boolean","required":false,"description":"True saves only the flattened symbol, with no parent."},{"name":"lib_id","type":"string","required":true,"description":"The symbol, \"<library>:<symbol>\", for example \"Device:R\"."},{"name":"new_name","type":null,"required":false,"description":"The new name. KiCad changes spaces to \"_\". Default: the old name."},{"name":"overwrite","type":"boolean","required":false,"description":"True replaces the symbols with the same names in the target\n(KiCad: Overwrite / Overwrite All). False refuses them."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."},{"name":"target_library","type":"string","required":true,"description":"The nickname of the target in the project symbol table."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":426},{"name":"copy_footprint_to_library","title":null,"description":"Copy a footprint into a library of the project table, as \"Save As\" of the\nfootprint editor of KiCad 10 does.\n\nThe Value gets the new name when it was equal to the old name. KiCad saves the\nfootprint (kicad-cli), and a second save must give the same bytes. The target must\nbe a footprint library of the project table in the version of the installed KiCad\n(else: upgrade_project_libraries first). A footprint that is not on F.Cu is refused.\nKiCad must not have the project open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"lib_id","type":"string","required":true,"description":"The footprint, \"<library>:<footprint>\"."},{"name":"new_name","type":null,"required":false,"description":"The new name. Default: the old name."},{"name":"overwrite","type":"boolean","required":false,"description":"True replaces a footprint with the same name in the target (KiCad:\nOverwrite). False refuses it."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."},{"name":"target_library","type":"string","required":true,"description":"The nickname of the target in the project footprint table."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":240},{"name":"set_library_symbol_properties","title":null,"description":"Change the properties of a symbol of a project library, as the Symbol Properties\ndialog of the symbol editor of KiCad 10 does.\n\nA field name that the symbol has gets the new text (a mandatory name in any case).\nA new name gives a new hidden field at (0, 0), with the text size of the symbol\neditor settings. A text of None removes a user field (the five mandatory fields\ncannot be removed). As in the dialog, a text that is a path to a file that exists\n(\"/\", \"${\", \"./\", \"../\") gets \"file://\" before it, the escapes (\"{slash}\") become\ncharacters, and the text of a mandatory field has no white space at its ends. The\nfootprint filters replace the list (spaces become \"_\"). KiCad saves the library\n(kicad-cli), and a second save must give the same bytes. The library must be in the\nproject table, in the version of the installed KiCad. KiCad must not have the\nproject open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"fields","type":null,"required":false,"description":"The field texts by name. None as a text removes the user field."},{"name":"footprint_filters","type":null,"required":false,"description":"The new list of footprint filters. None: no change."},{"name":"keywords","type":null,"required":false,"description":"The new keywords. None: no change. \"\" removes them."},{"name":"lib_id","type":"string","required":true,"description":"The symbol, \"<library>:<symbol>\", of a library of the project table."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":329},{"name":"create_derived_symbol","title":null,"description":"Make a new symbol that extends a symbol of the same project library, as \"Derive\nfrom existing symbol\" of the symbol editor of KiCad 10 does.\n\nThe new symbol has the units, the pins and the drawings of its parent (extends).\nIts mandatory fields are copies of the fields of the parent: the Footprint and the\nDatasheet are empty unless keep_footprint and keep_datasheet; the Value of a power\nsymbol is the new name. With transfer_user_fields, the new symbol gets a copy of each\nuser field of the parent (MPN, for example), with an empty text unless\nkeep_user_field_content. The arguments have the defaults of the dialog of KiCad (the\ncheck boxes are off). KiCad 10.0 saves the keywords and the footprint filters of the\nparent into the new symbol (LIB_SYMBOL::GetKeyWords). Set the Value, the MPN and the\nother fields after this with set_library_symbol_properties.\n\nThe parent must be in a library of the project table, in the version of the\ninstalled KiCad: for a symbol of a global library, copy it first with\ncopy_symbol_to_library. As the dialog, the tool writes the escapes of the name\n(\"{colon}\" for \":\") and a space as \"_\". A name that the library has already is an\nerror: the tool does not replace a symbol. KiCad saves the library (kicad-cli), and\na second save must give the same bytes. KiCad must not have the project open. The\ninstalled KiCad must be KiCad 10.0.","inputs":[{"name":"keep_datasheet","type":"boolean","required":false,"description":"Keep the Datasheet of the parent (\"Keep linked datasheet\")."},{"name":"keep_footprint","type":"boolean","required":false,"description":"Keep the Footprint of the parent (\"Keep linked footprint\")."},{"name":"keep_user_field_content","type":"boolean","required":false,"description":"With transfer_user_fields, keep their texts (\"Keep\ncontent of user-defined fields\")."},{"name":"name","type":"string","required":true,"description":"The name of the new symbol."},{"name":"parent_lib_id","type":"string","required":true,"description":"The parent, \"<library>:<symbol>\", of a library of the project\ntable. The new symbol goes into the same library."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."},{"name":"transfer_user_fields","type":"boolean","required":false,"description":"Copy the user fields of the parent (\"Transfer\nuser-defined fields\")."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":498},{"name":"rename_library_symbol","title":null,"description":"Give a symbol of a project library an other name, as \"Rename\" of the library tree\nof the symbol editor of KiCad 10 does.\n\nAs the rename dialog, the tool removes the white space at the two ends of the name\nand writes the escapes of the name (\"{colon}\" for \":\"). A space stays a space (not\n\"_\", as in create_derived_symbol). The Value gets the new name when it was equal to\nthe old name. The symbols derived from the symbol extend the new name.\n\nA name that the library has already is an error, also with an other case (KiCad\ncompares the names with no difference of case): the tool does not replace a symbol.\nA change of only the case of the name of the symbol itself is not an error.\n\nKiCad does not change the schematics that use the old name, and neither does the\ntool: the answer gives the placed symbols with the old lib_id as a warning.\n\nThe library must be a symbol library file of the project table, in the version of\nthe installed KiCad (else: upgrade_project_libraries first). KiCad saves the library\n(kicad-cli), and a second save must give the same bytes. KiCad must not have the\nproject open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"lib_id","type":"string","required":true,"description":"The symbol, \"<library>:<symbol>\", of a library of the project table."},{"name":"new_name","type":"string","required":true,"description":"The new name."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":338},{"name":"delete_library_symbol","title":null,"description":"Delete a symbol from a project library, as \"Delete\" of the library tree of the\nsymbol editor of KiCad 10 does.\n\nKiCad deletes a symbol together with all symbols derived from it (also the derived\nsymbols of a derived symbol). With delete_derived=False, a symbol with derived\nsymbols is an error that gives their names. delete_derived=True deletes them all, as\n\"Delete All Listed Symbols\" of KiCad.\n\nKiCad does not change the schematics that use a deleted symbol, and neither does\nthe tool: the answer gives the placed symbols with a deleted lib_id as a warning.\nThe schematic keeps its copy of each symbol, but an update from the library then\nfails.\n\nThe library must be a symbol library file of the project table, in the version of\nthe installed KiCad (else: upgrade_project_libraries first). KiCad saves the library\n(kicad-cli), and a second save must give the same bytes. KiCad must not have the\nproject open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"delete_derived","type":"boolean","required":false,"description":"True deletes the symbols derived from the symbol too."},{"name":"lib_id","type":"string","required":true,"description":"The symbol, \"<library>:<symbol>\", of a library of the project table."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":291},{"name":"rename_library_footprint","title":null,"description":"Give a footprint of a project library an other name, as \"Rename\" of the library\ntree of the footprint editor of KiCad 10 does.\n\nKiCad saves the footprint as \"<new name>.kicad_mod\", then removes the old file. The\nValue gets the new name when it was equal to the old name. As the rename dialog, the\ntool removes the white space at the two ends of the name. A name with one of the\ncharacters \\ / : \" < > | * ? is an error: KiCad changes them to \"_\" in the file\nname, and reads the name from the file name.\n\nA name that the library has already is an error: the tool does not replace a\nfootprint. On a file system with no difference of case in file names (Windows,\nmacOS), a change of only the case of the name is one file: KiCad 10.0.7 and later\ndelete the old footprint first, then save the new one, and so does the tool. With\nKiCad 10.0.6 (it saves first, then deletes, and thus removes the footprint) the tool\nrefuses such a rename: do it in two steps.\n\nKiCad does not change the uses of the old name, and neither does the tool: the\nanswer gives as a warning the Footprint fields of the placed symbols (also of their\nvariants) and of the symbols of the project symbol libraries, and the footprints of\nthe board of the project, that have the old library ID.\n\nThe library must be a footprint library of the project table, in the version of the\ninstalled KiCad (else: upgrade_project_libraries first). A footprint that is not on\nF.Cu is refused. KiCad saves the footprint (kicad-cli), and a second save must give\nthe same bytes. KiCad must not have the project open. The installed KiCad must be\nKiCad 10.0.","inputs":[{"name":"lib_id","type":"string","required":true,"description":"The footprint, \"<library>:<footprint>\", of a library of the project\ntable."},{"name":"new_name","type":"string","required":true,"description":"The new name."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":473},{"name":"delete_library_footprint","title":null,"description":"Delete a footprint from a project library, as \"Delete\" of the library tree of\nthe footprint editor of KiCad 10 does: KiCad removes the file of the footprint.\n\nKiCad does not change the uses of the footprint, and neither does the tool: the\nanswer gives as a warning the Footprint fields of the placed symbols (also of their\nvariants) and of the symbols of the project symbol libraries, and the footprints of\nthe board of the project, that have its library ID. The board keeps its copy of\neach footprint.\n\nThe library must be a footprint library of the project table, in the version of the\ninstalled KiCad (else: upgrade_project_libraries first). KiCad must not have the\nproject open. The installed KiCad must be KiCad 10.0.","inputs":[{"name":"lib_id","type":"string","required":true,"description":"The footprint, \"<library>:<footprint>\", of a library of the project\ntable."},{"name":"project_path","type":"string","required":true,"description":"The .kicad_pro file or the project folder."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":222},{"name":"update_symbols_from_library","title":null,"description":"Update placed symbols from their library symbols, as \"Update Symbols from Library\"\nof the schematic editor of KiCad 10 does it.\n\nEach matching symbol gets the library symbol of its library ID (from the global and\nthe project symbol library tables, flattened): the new shape and pins, the keywords\nand the footprint filters (always, as the dialog). The fields, the attributes and the\nalternate pins follow the options, with the defaults of the dialog. The library\nsymbol is the text of a save in kicad-cli, as KiCad loads it: kicad-cli saves each\nlibrary symbol with its parents one time (about 0.2 s), and again after a change of\ntheir text; a cache keeps the last 256 saves.\n\nThe pins follow the new library symbol (SCH_SYMBOL::UpdatePins): a pin keeps its\nUUID when the library symbol has its number; a new pin gets a new UUID, and a pin\nthat the library symbol does not have goes. KiCad makes random UUIDs, and the order\nof a new pin comes from the memory: the tool uses the order of the placed pins in\nthe file and of the library pins in the save of KiCad.\n\nThe fields of the update (fields): with no list, the dialog defaults: Footprint,\nDatasheet and Description, and each user field of the matching symbols and of their\nlibrary symbols; not Reference and not Value. A private field is always updated. The\nposition of a field (update_field_positions, and a new field) is the position of the\nsymbol plus the position of the library field, rotated and mirrored as the symbol\n(SCH_FIELD::GetPosition). A user field of the library that the symbol does not have\nbecomes a new field.\n\nThe tool refuses these updates:\n\n- A match with no symbol, or a field name that the dialog does not list.\n- A library ID that is not valid, or that the libraries do not have. A library\n  symbol with fewer units than the symbol.\n- A symbol with no mandatory field (Reference, Value, Footprint, Datasheet or\n  Description), with two fields of one name, or with a field or a library ID that the\n  load changes (a fiel…","inputs":[{"name":"fields","type":null,"required":false,"description":"The names of the fields to update, or none for the dialog defaults. The\nnames of the user fields have case."},{"name":"match","type":"string","required":false,"description":"\"all\" (each symbol), \"reference\" or \"value\" (pattern with \"*\" and \"?\", no\ncase), or \"lib_id\" (pattern is \"<library>:<symbol>\")."},{"name":"options","type":null,"required":false,"description":"The update options of the dialog; a missing option has the default of\nthe dialog."},{"name":"pattern","type":"string","required":false,"description":"The text of the match \"reference\", \"value\" or \"lib_id\"."},{"name":"schematic_path","type":"string","required":true,"description":"A .kicad_sch file of the project. The tool finds the symbols in\nthe full project."}],"outputs":[{"name":"result","type":"string","required":true,"description":null}],"hasOutputSchema":true,"hasExamples":false,"tokenEstimate":913}],"toolsTruncatedAtCapture":false,"diagnostics":{"capturedAt":"2026-11-21T07:35:48.000Z","track":"package","endpoint":null,"declaredUrl":null,"truncated":false,"tls":null,"dnssec":null,"auth":null,"httpsRedirect":null,"transports":[],"provenance":{"outcome":"none","label":"No attestation","reason":"no_attestation","reasonLabel":"No attestation published","discovery":null,"discoveryLabel":null,"sourceRepo":null,"attestationSkipped":null,"attestationSkippedLabel":null},"installScripts":[{"hook":"build_backend","tier":"allowlisted"}],"installScriptsTotal":null,"vulnerabilities":[],"vulnerabilitiesTotal":null,"dependencies":{"nodes":37,"partial":false,"deprecated":null,"stale":1,"noRepo":null}},"mismatches":[],"changelog":{"trackingSince":"2026-11-08","recent":[{"id":"chg_01a1fd08-65f6-72ea-b754-fa1e6c03beea","kind":"check.reverified","summary":"Malware scan (unverified → pass)","materiality":"security","direction":"improvement","scoreDelta":null,"occurredOn":"2026-11-21","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fd08-65f6-72ea-b754-fa1e6c03beea"},{"id":"chg_01a1fd08-65fb-763d-80b7-cd316ea7e91d","kind":"score.total_changed","summary":"Trust score (57 → 72)","materiality":"functional","direction":"improvement","scoreDelta":15,"occurredOn":"2026-11-21","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fd08-65fb-763d-80b7-cd316ea7e91d"},{"id":"chg_01a1fa44-8bae-7694-9f4b-c7099553a779","kind":"check.measure","summary":"Schema quality (188 → 317)","materiality":"functional","direction":"regression","scoreDelta":null,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fa44-8bae-7694-9f4b-c7099553a779"},{"id":"chg_01a1fa44-8baf-7d80-b2e3-1b6aad427ef1","kind":"check.measure","summary":"Schema quality (good → excellent)","materiality":"functional","direction":"neutral","scoreDelta":null,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fa44-8baf-7d80-b2e3-1b6aad427ef1"},{"id":"chg_01a1fa44-8bb0-7dbf-8e9e-34b7c75ebf2e","kind":"check.verdict","summary":"Destructive annotations (pass → 0)","materiality":"functional","direction":"neutral","scoreDelta":null,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fa44-8bb0-7dbf-8e9e-34b7c75ebf2e"},{"id":"chg_01a1fa44-8bb1-7b07-92c6-7d4663088f94","kind":"package.version_changed","summary":"Package version (0.1.0 → 0.2.0)","materiality":"functional","direction":"neutral","scoreDelta":null,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fa44-8bb1-7b07-92c6-7d4663088f94"},{"id":"chg_01a1fa44-8bb2-7144-9ef0-a57e0b831c2c","kind":"score.total_changed","summary":"Trust score (59 → 57)","materiality":"functional","direction":"regression","scoreDelta":-2,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1fa44-8bb2-7144-9ef0-a57e0b831c2c"},{"id":"chg_01a1f88a-368b-788a-998e-62d27adb4a18","kind":"check.unverifiable","summary":"Malware scan (pass → unverified)","materiality":"security","direction":"regression","scoreDelta":null,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1f88a-368b-788a-998e-62d27adb4a18"},{"id":"chg_01a1f88a-368c-7ca8-89e1-6d14deb8516b","kind":"check.reverified","summary":"Stability (unverified → 0.40)","materiality":"functional","direction":"improvement","scoreDelta":null,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1f88a-368c-7ca8-89e1-6d14deb8516b"},{"id":"chg_01a1f88a-368d-7bbc-b439-29af53e67961","kind":"score.total_changed","summary":"Trust score (68 → 59)","materiality":"functional","direction":"regression","scoreDelta":-9,"occurredOn":"2026-11-20","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1f88a-368d-7bbc-b439-29af53e67961"},{"id":"chg_01a1f2c2-add6-7a6f-8928-9dad2d8e658d","kind":"check.reverified","summary":"Malware scan (unverified → pass)","materiality":"security","direction":"improvement","scoreDelta":null,"occurredOn":"2026-11-19","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1f2c2-add6-7a6f-8928-9dad2d8e658d"},{"id":"chg_01a1f2c2-add9-7ddf-a7fb-d13b646cea62","kind":"score.total_changed","summary":"Trust score (53 → 68)","materiality":"functional","direction":"improvement","scoreDelta":15,"occurredOn":"2026-11-19","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1f2c2-add9-7ddf-a7fb-d13b646cea62"},{"id":"chg_01a1d989-b7df-7d01-8152-d63539a1bb1e","kind":"check.unverifiable","summary":"Malware scan (pass → unverified)","materiality":"security","direction":"regression","scoreDelta":null,"occurredOn":"2026-11-14","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1d989-b7df-7d01-8152-d63539a1bb1e"},{"id":"chg_01a1d989-b7e0-7b4b-80a1-49b0a2bb3a42","kind":"score.total_changed","summary":"Trust score (68 → 53)","materiality":"functional","direction":"regression","scoreDelta":-15,"occurredOn":"2026-11-14","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1d989-b7e0-7b4b-80a1-49b0a2bb3a42"},{"id":"chg_01a1d48e-623d-76d7-88da-019453433745","kind":"check.reverified","summary":"Malware scan (unverified → pass)","materiality":"security","direction":"improvement","scoreDelta":null,"occurredOn":"2026-11-13","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1d48e-623d-76d7-88da-019453433745"},{"id":"chg_01a1d48e-623d-7c62-ba46-c24ea3a213b6","kind":"score.total_changed","summary":"Trust score (53 → 68)","materiality":"functional","direction":"improvement","scoreDelta":15,"occurredOn":"2026-11-13","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1d48e-623d-7c62-ba46-c24ea3a213b6"},{"id":"chg_01a1bcac-ae24-714d-88e6-751a1a3f983b","kind":"score.first_scored","summary":"First indexed and scored","materiality":"functional","direction":"neutral","scoreDelta":null,"occurredOn":"2026-11-08","url":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench#chg-chg_01a1bcac-ae24-714d-88e6-751a1a3f983b"}],"truncated":false,"feedUrl":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench/changelog.json"},"links":{"html":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench","markdown":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench.md","changelogJson":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench/changelog.json","changelogRss":"https://verifymcp.io/servers/turbyho-kicad-workbench/kicad-workbench.xml","external":[{"label":"PyPI project","href":"https://pypi.org/project/kicad-workbench/"},{"label":"Socket report","href":"https://socket.dev/pypi/package/kicad-workbench"},{"label":"Repository","href":"https://github.com/turbyho/kicad-workbench"}]}}