Conversions across 221 color spaces, tested against cited sources: CSS strings, gamut, LUTs
Eda Agent is installed from its publisher's own source and answers where it runs, so this marketplace is not in the path of a single call. There is no address here to send one to, and a panel that pretended otherwise would be showing you an answer we made up. Install it and call it from your own client — the Installation tab has the entry for each one.
What it does
Drive a live Altium Designer session: schematic, PCB and library tools. KiCad and EasyEDA too.
Quickstart
# 1 — add it to Claude Code
claude mcp add --scope user eda-agent-mcp '--' uvx eda-agent
# 2 — ask your agent for something these tools do
# tool_catalog, tool_invoke, app_find_menu_command and 517 more
Eda Agent costs nothing on mcprush: there is no plan to choose here, no cap to set and nothing mcprush can bill you for.
Collected from a public index. Nobody has claimed this account, so nothing here was written by its author — claim it if it is yours.
Where are you running it?
Every route below installs the same thing and ends at the same approval screen. This one runs on your machine: your client starts Eda Agent as a process under your own user, with your files and your network, so the tool surface below is what it can do to your computer rather than to a server somewhere else. Its scan result is on the Security tab — read the surface before you approve it.
This is a public server: you run it yourself and this marketplace is not in the path. You need uv (docs.astral.sh/uv): uvx comes with it. Claude Code registers it in one command; --scope user makes it available in every project. The '--' is in quotes so that PowerShell passes it on.
claude mcp add --scope user eda-agent-mcp '--' uvx eda-agentReconnect, or start a new session, and the tools appear in the model’s tool list.
Nothing is required, but it can take EDA_AGENT_BACKEND (The EDA tool to drive; both = Altium and KiCad), EDA_AGENT_TOOLSET (full lists every tool; minimal lists two meta-tools that reach them all) if you want to set them.
One config entry your client uses to start the process locally. A local server runs with your file system and your network, which is why it is priced without metering.
520 tools, with what each one reads, writes and reaches shown before you agree — the same list on every route above. Read the tool surface.
Tool surface
What the model actually sees. Descriptions are diffed on every release — see version history.
Read from its source code. A server that builds its tool list when it starts can list more tools than this.
Find tools by category, maturity, interaction or text, without loading every schema.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| category | string | no | — |
| maturity | string | no | — |
| interaction | string | no | — |
| query | string | no | — |
| with_description | boolean | no | — |
| with_schema | boolean | no | — |
Invoke any registered tool by name: the companion to
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| arguments | object | no | — |
Search every Altium menu item and the command behind it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | yes | words to find, all of which must match. |
| editor | string | no | PCB, SCH, PCBLIB or SCHLIB; empty searches all four. |
| limit | integer | no | how many hits to return. |
Check if Altium Designer is running and get status information.
Takes no parameters.
Where you are, in one call. Run this before anything else.
Takes no parameters.
Connect to a running Altium Designer instance.
Takes no parameters.
Flush every dirty Altium document to disk.
Takes no parameters.
Save ONE open document: `file_path`, or the focused one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | no | Absolute path of an open document. Empty saves the focused document. |
Close a transaction a crashed handler left open in Altium.
Takes no parameters.
Close ONE open document, found by its full path, whatever has focus.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | the document's full path, as app_list_documents reports it. |
| discard_changes | boolean | no | close it even when it reads modified, and LOSE the unsaved edits: the modified flag is cleared first so no save prompt appears. For scratch copies and documents Altium changed by merely opening them, |
Snapshot a project so the session can be rolled back.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| label | string | no | optional human note ("before routing pass"). |
| save_first | boolean | no | flush dirty Altium docs to disk before snapshotting so the checkpoint reflects in-editor changes (default True). |
| project_path | string | no | the .PrjPcb to snapshot. Left empty, the focused project is taken; with several open that may not be the one you are editing, so the reply names it and lists the rest. |
List saved checkpoints for the current workspace, newest first.
Takes no parameters.
Restore the focused project's files from a checkpoint.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| checkpoint_id | string | yes | id from app_list_checkpoints. |
| prune_added | boolean | no | delete files absent at checkpoint time (default False). |
Stop the Altium MCP polling loop. CALL THIS WHEN YOU'RE FINISHED.
Takes no parameters.
Check that Altium and its bridge script answer, and that the running script is the version on disk. A mismatch or a non-empty `stale_units` means Altium runs an old compile: close and reopen the script project to recompile.
Takes no parameters.
Report the health of the MCP bridge, workspace, and Altium link.
Takes no parameters.
Create a new blank document of a given kind and save it to disk.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | Document kind, 'PCB', 'SCH', 'PCBLIB', 'SCHLIB', 'OUTPUTJOB', 'HarnessWiringDiagram' (a .WirDoc in a .PrjHar), or any other kind Altium's server module registers under. |
| file_path | string | yes | Absolute path where the new document should live. Use Windows backslashes. |
| name | string | no | Optional display name. Defaults to the filename. |
| add_to_project | boolean | no | Attach the new file to a project. Default True. Set False to leave it as a free document. |
| project_path | string | no | The .PrjPcb to attach it to. An unknown path is refused before anything is created. |
Which Claude session is editing which open document.
Takes no parameters.
Take a document over from the session editing it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | The document's full path. |
List all documents known to the current Altium workspace.
Takes no parameters.
Diagnostic: enumerate workspace files via Altium's FindFiles helper.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| pattern | string | no | — |
Get information about the currently active (focused) document.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| session | boolean | no | True for this session's own document instead, brought back to the front first if something else is there. |
Set a specific document as the active (focused) document,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | Full path to the document to activate |
Get the version of Altium Designer.
Takes no parameters.
Get key Altium Designer preferences.
Takes no parameters.
Read, or set, Altium's auto-save: whether it saves backup
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enabled | boolean | no | Auto-save on (True) or off (False). |
| interval_minutes | integer | no | Minutes between saves, 1 or more. |
Read, write or clean up a component value. HOW IT IS WRITTEN IS THE USER'S CHOICE on the Config tab of the bridge panel in Altium, read on every call: RKM (IEC 60062, a letter where the decimal point would be: 4K7, 0R005, 2u2, 10uF, 3V3), SI (4.7k, 0.005, 2.2u, 3.3V), SI with the unit (2.2uF,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | `cleanup (text -> the proper text), fromstring (text -> value and kind) or tostring` (kind + value -> text). |
| text | string | no | The value as written, for cleanup / fromstring. |
| value | no | The value in the base unit (ohm, farad, henry, volt, ampere, %, ppm, degree C) for tostring: a string such as "0.0000022" or "1e3", or a number. | |
| kind | string | no | ohm, farad, henry, volt, ampere, percent, ppm or celsius (also R, C, L, V, A). Takes precedence over the text; a unit in the text that disagrees is a note. |
| decimal | string | no | The decimal separator of the SOURCE text, "." or ",", for "1,000" / "1.000"; default this machine's. |
Dispatch a menu command by path. DISPATCH IS NOT EXECUTION:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| menu_path | string | yes | Menu path using pipe separators (e.g., "File|Save All") |
Tell the dashboard what high-level task the agent is working on.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| intent | string | yes | Short human-readable description (one line, <=240 chars). |
Get text content from the Windows clipboard.
Takes no parameters.
Read the design discipline, and on request the DesignPlan schema.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| include_schema | boolean | no | Also return the DesignPlan JSON schema, which the plan tools (design_validate_plan, design_review_plan, design_compose_netlist) take. A schematic drawn from templates does not need it. |
Open a durable design-session journal for an autonomous run.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requirement | string | yes | the design requirement text this run implements. |
| session_id | string | no | optional explicit id; defaults to a timestamp. |
Append one event to a design-session journal.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| event | string | yes | — |
| session_id | string | no | — |
| stage | string | no | — |
| status | string | no | — |
| text | string | no | — |
| path | string | no | — |
| kind | string | no | — |
| question | string | no | — |
| revision | integer | no | — |
| topic | string | no | — |
| data | object/string | no | — |
Read a design session's derived state (stage map, artifacts, ...).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| session_id | string | no | — |
Resume a design run: state plus a plain-language next-action hint.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| session_id | string | no | — |
Decide the single next action for an autonomous design run.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| session_id | string | no | — |
The autonomous spec-to-board loop protocol, in one call.
Takes no parameters.
Write up a design run from its session journal, as markdown.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| session_id | string | no | the session to report; blank uses the most recently active one. |
| output_path | string | no | also write the markdown to this file. Its folder must exist, and a path inside the installed eda_agent package is refused. Blank writes nothing. |
Measure a board for the layout stages' exit gates. Changes nothing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| checks | array | no | names from the list above; None runs them all. |
| expect_file | string | no | full path of the focused board, for a live read; refused if another board is focused. |
| board_json_path | string | no | a saved LayoutBoard (.json or .json.gz) to audit offline instead. |
| nets | array | no | nets for `return_via_audit`; None checks diff-pair and high-speed nets, or every signal via. |
| max_distance_mils | number | no | return via distance, centre to centre. |
| limit | integer | no | findings listed per kind; counts are never cut. |
Start a long engine run as a background job; returns its id.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | registered job kind. Currently: `route (offline A* router; params needs a geometry dict, optional rules / net_classes / grid_pitch_mils`). |
| params | object | yes | keyword arguments for the engine. |
Status of a background job (or all jobs if `job_id` is blank).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| job_id | string | no | the job; blank lists every job. |
| wait_seconds | number | no | hold the call until the job finishes or this many seconds pass (capped at 100, inside the client's two-minute limit). 0 answers at once. |
Fetch a finished job's result payload (None until it's done).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| job_id | string | yes | the job. |
| full | boolean | no | return every entry inline, however long. |
Open a list of SchLib files and return what components live in them.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_paths | array | yes | Absolute paths to .SchLib files to scan. |
| name_filter | string | no | Case-insensitive substring; keep only components whose lib_ref or description contains it (e.g. `"10k", "NE555"`). Empty = no filter. |
| limit_per_library | integer | no | Cap components returned per library (default 60; 0 = unlimited). Each library reports `total and returned` so you know if it was capped. |
| include_descriptions | boolean | no | False drops the (often long) `description` from each row. Default True. |
Validate a candidate DesignPlan JSON against the schema + cross-check.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | Either a JSON string of the DesignPlan, or the DesignPlan as a JSON object/dict. The MCP framework auto-deserializes JSON-object literals to dicts before the tool sees them, so both shapes are accepte |
List the canonical circuit blocks and their parameter contracts.
Takes no parameters.
Add a standard sub-circuit to a DesignPlan, wired, in one call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | the DesignPlan as a JSON string or dict. |
| block | string | yes | block name from the list. |
| params | object | yes | block parameters. |
Add one part and wire its pins to named nets, in one call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | the DesignPlan as a JSON string or dict. |
| refdes | string | yes | the new part's designator (must be free in the plan). |
| lib_ref | string | yes | its library symbol name. |
| connections | object | yes | `{pin: net_name}` -- a net is created if absent or merged into if present. |
| value | string | no | — |
| footprint | string | no | — |
| lib_path | string | no | — |
| sheet | string | no | — |
| manufacturer | string | no | — |
| mpn | string | no | — |
| datasheet_url | string | no | — |
| role | string | no | — |
| power_nets | array | no | — |
| ground_nets | array | no | — |
| net_roles | object | no | `{net_name: role}` for nets created here. |
Wire a parallel bus across two+ parts in one call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | the DesignPlan as a JSON string or dict. |
| endpoints | array | yes | one dict per part on the bus, `{"refdes": str, "pins": [pin, ...]}. Every endpoint must list the same number of pins (the bus width); bit i joins pins[i]` of each endpoint. |
| net_names | array | no | explicit name per bit (length must equal the width); omitted -> `f"{net_prefix}{start_index+i}"` (D0, D1, ...). |
| net_prefix | string | no | prefix for auto-named bits. |
| start_index | integer | no | first bit number for auto-naming. |
Apply many authoring operations to a plan in ONE call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | the DesignPlan as a JSON string or dict. |
| operations | array | yes | ordered list of op dicts, each with an `"op" key: * {"op": "add_part", "refdes", "lib_ref", "connections", ...} -- plus any optional add-part field (value, footprint, lib_path, `po |
Derive the bill of materials from a plan's parts in one call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | the DesignPlan as a JSON string or dict. |
| set_on_plan | boolean | no | when True (default), the returned `plan carries the generated BOM in its bom field, ready for sch_draw_template`; the parts are unchanged. |
Edit an existing plan instead of re-emitting it. The tool does the bookkeeping (a deleted part leaves every net; merged nets de-dupe pins). Ops run in order and the result is validated once at the end, so a newly floating net surfaces.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | the DesignPlan as a JSON string or dict. |
| operations | array | yes | the ordered edit ops. |
Compute a component value snapped to an E-series, with the value actually achieved and its error. Use it instead of hand arithmetic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | — |
| series | string | no | E6/E12/E24/E48/E96 (default E96; E24 for jellybean). |
| v_in | number | no | — |
| v_out | number | no | — |
| v_ref | number | no | — |
| v_supply | number | no | — |
| v_forward | number | no | — |
| i_led_ma | number | no | — |
| f_cutoff_hz | number | no | — |
| r_ohms | number | no | — |
| c_farads | number | no | — |
| r_bottom_ohms | number | no | — |
| value | number | no | — |
| c_load_pf | number | no | — |
| c_stray_pf | number | no | — |
| v_bus | number | no | — |
| c_bus_pf | number | no | — |
| t_rise_ns | number | no | — |
| r_top_ohms | number | no | — |
| tol_pct | number | no | — |
Report the electrical behaviour of each recognised sub-circuit.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | — |
Recommend a controlled-impedance trace width for every differential pair in a plan.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | — |
| target_ohms | number | no | — |
| geometry | string | no | — |
| dielectric_height_mils | number | no | — |
| dielectric_constant | number | no | — |
| copper_oz | number | no | — |
| spacing_mils | number | no | — |
Offline FALLBACK review of a .SchDoc/.PrjPcb: OFF by default.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | a `.SchDoc sheet or a .PrjPcb` project (reviews all its sheets). |
Reconstruct a .SchDoc's netlist geometrically: OFF by default.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | — |
Consolidated BOM from a .SchDoc/.PrjPcb on disk: OFF by default.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | — |
Find the circuit loops whose physical size matters, and measure them on a placed board. Changes nothing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | no | — |
| board_json_path | string | no | — |
| expect_file | string | no | — |
| pin_names | object | no | — |
| kinds | array | no | restrict to these loop kinds. |
| limit | integer | no | loops listed; counts are never cut. |
Which circuit and field simulators are installed: ngspice
Takes no parameters.
Simulate a SPICE deck in ngspice or LTspice on this machine and return its .meas values, errors and waveforms.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| deck | string | yes | The SPICE text, with an analysis (.tran, .ac, .dc, .op) and any .meas lines. |
| engine | string | no | "auto", "ngspice" or "ltspice". |
| waves | array | no | Traces to report (e.g. ["V(out)"]); empty reports all. |
| points | integer | no | Also return this many samples of each trace in `waves` (AC traces in dB and degrees). |
| timeout_s | number | no | Stop the simulator after this many seconds. |
Loop gain, crossover, phase and gain margin of every feedback loop in a plan, simulated in ngspice. Changes nothing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | — |
| models | object | no | — |
| supplies | object | no | — |
| pin_names | object | no | — |
| f_start | number | no | — |
| f_stop | number | no | — |
Write a plan's circuit as a SPICE deck for ngspice or LTspice.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | a DesignPlan (object or JSON). |
| dialect | string | no | "ngspice" or "ltspice". |
| analyses | object | no | {"op": true}, {"tran": {"step", "stop"}}, {"ac": {"points", "start", "stop"}} (decade) or {"dc": {"source", "start", "stop", "step"}}; default .op. |
| models | object | no | — |
| supplies | object | no | — |
| pin_names | object | no | — |
| path | string | no | file to write; default <workspace>/sim/<title>.cir|.net. |
| allow_partial | boolean | no | write a deck that is missing parts. |
Design checks from TEMPORARY rules, evaluated offline. Writes no rule and changes nothing on the board.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| board_json_path | string | no | — |
| expect_file | string | no | — |
| spacing_mils | number | no | — |
| probe_mils | number | no | — |
| currents | object | no | — |
| pin_names | object | no | — |
| limit | integer | no | — |
One-call offline pre-flight: bundle every plan-level analysis.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | — |
Split a plan's parts into `n_groups` balanced groups with the fewest nets crossing between them (min-cut, Kernighan-Lin style), for PCB rooms or schematic sheets. Pure data; touches nothing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | A DesignPlan (dict or JSON string). |
| n_groups | integer | no | Number of groups. |
| max_fanout | integer | no | Nets touching more than this many parts are treated as rails and ignored. |
Read a DesignPlan back off a schematic so an edit becomes a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | yes | The .PrjPcb the sheet belongs to. Its compiled netlist is what supplies the nets. |
| sheet_document | string | no | Full path to the .SchDoc to read. Defaults to the active document. |
Structured visual/layout audit of the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional .PrjPcb path. None uses the focused project. |
| cluster_radius_mils | integer | no | Radius for stacked-port clustering. Default 600 mils. |
ERC + connectivity sanity report on the focused project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional absolute path to a .PrjPcb. If omitted, uses the focused project. |
Validate a DesignRequirement before part selection and planning (stage 1 of the autonomous flow). Pure Python, no Altium.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| requirement | object | yes | DesignRequirement as a JSON object/dict. Units are SI with the unit in the field name (`voltage_v, current_a, temp_min_c); mechanical dimensions are MILLIMETRES (board_size_mm, `height |
Validate a fab capability profile and echo the normalized form.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| profile | object | yes | FabProfile as a JSON object/dict: `name, optional source citation, copper_layer_counts, the seven min_*_mils floors, and optional stackups`. |
Fab houses whose published capabilities ship with this server.
Takes no parameters.
A fab profile for one build at a fab, ready for
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vendor | string | yes | a fab from design_list_fab_vendors ("JLCPCB", "Eurocircuits", "Sierra Circuits", ...) |
| copper_layers | integer | no | copper layer count of the board |
| outer_oz | number | no | outer copper weight, oz |
| tier | string | no | the vendor's tier, "standard" by default |
| fill | object | no | {FabProfile field: mils} for figures the fab does not publish, e.g. {"min_hole_to_hole_mils": 10} |
The fabs' own stack-ups that ship with this server.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vendor | string | no | limit to one fab ("" for all) |
| copper_layers | integer | no | limit to one copper count (0 for all) |
One fab stack-up ply by ply, with optional trace widths for
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | stack-up name, e.g. "JLC04161H-7628" |
| impedance_targets | array | no | e.g. [{"ohms": 50}, {"ohms": 90, "spacing_mils": 6}] (spacing makes it differential) |
| board_stackup | object | no | a `pcb_get_layer_stackup` result to compare with; the template's plies are first collapsed to one dielectric per copper gap, as Altium keeps them |
A laminate's datasheet figures and the Dk to design with.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | e.g. "RO4350B", "370HR", "MEGTRON 6" (prefix matches) |
| frequency_ghz | number | no | the frequency to pick a typical Dk at (0: the highest listed) |
Synthesize PCB design rules + stackup ops from a fab profile.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| profile | object | yes | FabProfile as a dict (see `design_load_fab_profile`). |
| plan_json | string/object | no | Optional DesignPlan (JSON string or dict). When given and `net_class_map` is not, net classes are derived from the plan (flags + net roles, naming-agnostic). |
| net_class_map | object | no | Optional explicit `{net_name: class} map; takes precedence over plan_json` derivation. |
| options | object | no | Optional synthesis targets: `stackup (name, default first), class_current_a ({class: amps} -> per-class width rules), delta_t_c, track_margin, layer, copper_oz, geometry, ` |
Propose a multi-sheet hierarchy for a dense DesignPlan.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | DesignPlan as a JSON string or dict. |
| max_parts_per_sheet | integer | no | Split threshold (default 20). At or below it the plan stays single-sheet (`split=False`). |
Rewrite a DesignPlan onto the sheets a hierarchy proposes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | string/object | yes | DesignPlan as a JSON string or dict. |
| hierarchy | object | yes | The dict returned by `design_plan_hierarchy`. |
The checks that close one stage on the way to production, and how the product stands against them.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| stage | string | yes | feasibility, prototype, evt, dvt or pvt (also "design validation" and similar). |
| revision | string | no | The board revision in question; answers given for another revision stop counting, and the check says so. |
| product | string | no | Whose ledger, when there are several products. |
| with_reasons | boolean | no | Include each check's `why_now`. |
Record the answer to one stage check in the product's ledger.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| key | string | yes | The check's key from design_phase_gate, e.g. "prototype:drc". |
| outcome | string | yes | met, unmet, waived or open. |
| detail | string | no | The evidence: a count, a measurement, a document. |
| source | string | no | The tool that answered, or the person who confirmed it. |
| revision | string | no | The board revision it applies to. |
| product | string | no | Whose ledger. |
Which stage the product is in, and what that stage still needs.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| revision | string | no | — |
| product | string | no | — |
Query schematic OR PCB objects and read their properties.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | yes | Altium object type constant. Schematic: "eNetLabel", "ePort", "ePowerObject", "eSchComponent", "eWire", "eBus", "eBusEntry", "eParameter", "eParameterSet", "ePin", "eLabel", "eLine", "ePolyline", "eRe |
| properties | string | yes | Comma-separated property names to return. SCHEMATIC objects use the dotted spelling: "Text,Location.X,Location.Y" for net labels; "Designator,Name,ConnectionX,ConnectionY" for pins (ConnectionX/Y is t |
| scope | string | no | "active_doc" (default); "project" (every sheet of the focused project); "doc:PATH" or the bare path (that sheet, no focus change); "project:PATH"; "lib_component:NAME" (a symbol in the active SchLib), |
| filter | string | no | Pipe-separated property=value conditions (AND), e.g. "Text=VCC" or "Designator.Text=R1"; "" matches all. A PCB length matches as a number in mils ('.' or ',' decimal). "Net!=GND" excludes; "Y>4250|Y<= |
| limit | integer | no | Maximum number of objects to return (0 = unlimited) |
Explain WHY a schematic pin is on the net it is on.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component designator, e.g. "U10". |
| pin | string | yes | Pin NUMBER (not pin name), e.g. "5". |
| sheet_path | string | no | Search only this open SchDoc. |
| project_path | string | no | Search this project's sheets (.PrjPcb path) instead of the focused project's; the active sheet is then not searched first. |
Apply ONE set of property values to every object matching ONE filter.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | no | Altium object type constant (see obj_query) |
| set | string | no | Pipe-separated assignments, e.g. "Text=NEW_NAME" or "Location.X=100|Location.Y=200". Board lengths are decimal mils; a non-number is reported failed, never written as 0. Board properties include, besi |
| scope | string | no | "active_doc" (default), "project" (all SCH sheets), "doc:C:\\path\\Sheet.SchDoc" (no focus change), or "lib_component:NAME" (a symbol in the active SchLib, selected for you). |
| filter | string | no | Pipe-separated property=value conditions (AND logic) |
| items | array | no | Several filter+set operations at once (see above). |
Create and place a schematic object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | no | Altium object type constant (see obj_query) |
| properties | string | no | Pipe-separated property=value assignments, e.g.: "Text=MY_NET|Location.X=100|Location.Y=200" |
| container | string | no | "document" (place on active schematic) or "component" (add to current library component) |
| items | array | no | Several objects at once (see above). |
Find and delete schematic or PCB objects.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | no | Altium object type constant (see obj_query) |
| scope | string | no | "active_doc", "project", "doc:PATH", or "lib_component:NAME" (a named symbol in the active SchLib). A PCB type takes only "active_doc". |
| filter | string | no | Pipe-separated property=value conditions (AND logic). WARNING: empty filter deletes ALL objects of the type. |
| confirm_delete_all | boolean | no | Must be True to delete all objects when filter is empty. |
| items | array | no | Several deletes at once (see above). Reply: operations_processed, total, total_deleted and per-item `results with deleted; partial: notes and operations_partial` as for a single delete. |
Get font properties for a given font ID.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| font_id | integer | yes | Font ID from an object's FontId property |
Get or create a font ID for the given font properties.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| size | integer | yes | Font size in points (e.g., 8, 10, 12) |
| font_name | string | no | Font family name (default "Arial") |
| bold | boolean | no | Whether the font is bold |
| italic | boolean | no | Whether the font is italic |
| rotation | integer | no | Text rotation in degrees (0, 90, 180, 270) |
| underline | boolean | no | Whether the font is underlined |
| strikeout | boolean | no | Whether the font has strikeout |
Select objects matching a filter on the active document.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | yes | Altium object type (schematic or PCB) |
| filter | string | no | Pipe-separated property=value conditions (AND logic) |
Clear all object selection on the active document.
Takes no parameters.
Control the viewport zoom level of the focused document.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | no | "fit" (Fit All Objects, which can cut a sheet's frame off), "document" (a schematic's Fit Document: the whole sheet with its frame), "board" (the board alone, not parts parked beside it; a schematic f |
| x | number | no | — |
| y | number | no | — |
| radius | number | no | half the width of the view round the point on a board or footprint, mils (default 200) |
Save, close and reopen one schematic sheet, then recompile its project, so nets and ERC are compiled from the sheet as it is.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | The open .SchDoc or .WirDoc. |
| save | boolean | no | Write it first; `saved` is measured on disk. False closes without writing, and a sheet Altium reads as modified is refused untouched; an edit Altium did not flag is lost. |
Post an Altium 365 review comment at a point on a schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | The comment. |
| x | number | yes | — |
| y | number | yes | — |
| document | string | no | The schematic's full path. Empty uses the focused document, which must be a schematic. |
Mirror a placed schematic component horizontally.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | component to mirror, e.g. "U1" |
| mirrored | boolean | no | True or False for an absolute state; omit to toggle. Asking for the state it already has is a no-op, not a second reflection. |
| doc_path | string | no | sheet to act on. Defaults to the focused schematic. |
Rename designators across a whole project, swaps included, refusing any collision before the first write.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | yes | The .PrjPcb, a full path. |
| changes | array | yes | `[{"designator": "R1", "to": "R2"}, ...], with sheet when needed, or unique_id in place of designator`. |
| dry_run | boolean | no | Check and plan only. |
Apply many filter+set operations in ONE call (obj_modify items).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| operations | array | yes | List of operation dicts, each with: - scope: "active_doc" (default), "project", "doc:C:\\path\ o\\file.SchDoc", or "lib_component:NAME" (a symbol in the active SchLib; ops may name different symbols) |
Run an Altium process command via the generic primitive layer.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| process_name | string | yes | The Altium process identifier (e.g., "Sch:Compile", "WorkspaceManager:OpenObject", "PCB:Zoom") |
| parameters | string | no | Optional pipe-separated key=value parameter pairs, e.g.: "ObjectKind=Document|FileName=C:\\path\ o\\file.SchDoc" |
Run Electrical Rules Check on the focused project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | integer | no | How many violations to return; 0 returns all of them. |
| include_suppressed | boolean | no | list those too, each with `suppressed and level`. |
Bulk-update parameters on placed schematic components, in one call and one undo group. The follow-up to the parameter audits.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| stamps | array | yes | One dict per component: `designator plus any parameter key/values, e.g. {"designator": "R1", "Value": "10k", "MPN": "..."}. A parameter the part lacks is created, hidden, at the part. Value` |
| sheet_path | string | no | Optional SchDoc path; default the focused one. |
Return the ERC violation list produced by the last
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | integer | no | How many violations to return; 0 returns all of them. |
| offset | integer | no | Index of the first violation, to page through a long list without running ERC again. |
| include_suppressed | boolean | no | also list violations a No ERC marker covers or whose type is set to No Report; left out and only counted by default, as Altium's Messages panel does. |
Highlight a net by name in the focused schematic or PCB document.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net_name | string | yes | Exact net name to highlight (e.g., "VCC", "GND", "NET_D0"). Returns NOT_FOUND if the net doesn't exist on the PCB, or highlighted=0 on schematic if no primitive carries that net name on the active s |
| clear_existing | boolean | no | Clear existing highlights first (default True). |
| context | string | no | Empty (default, follow the focused document), "schematic", or "pcb". |
Compare the schematic vs PCB membership of a named net.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net_name | string | yes | Exact net name as it appears in the schematic (case-sensitive). |
Clear all net highlights in the active schematic or PCB document.
Takes no parameters.
Create a new schematic sheet and add it to a project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | Name for the new sheet (without .SchDoc extension). Default "NewSheet". |
| project_path | string | no | The open project to add it to; empty means the focused project. |
Remove a schematic sheet from the focused project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | Full path to the .SchDoc file to remove |
Switch the focused board or footprint library (.PcbLib)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mode | string | no | "3d" or "2d" (default "3d"). |
| camera | string | no | 3D only, where the view ends: "top", "iso" (tilted), "bottom", "front", "back", "left" or "right"; empty keeps the current camera. |
| fit | boolean | no | frame everything (in 3D from above, one step out). |
| footprint_name | string | no | in a .PcbLib, the footprint to show; without it the editor shows whichever footprint is current. With another document in front, the only open .PcbLib is brought forward first. |
| views | string | no | 3D only, cameras to turn through first, each held a moment, e.g. "iso,bottom,front" to show a model from several sides. |
Force a redraw/refresh of the current document.
Takes no parameters.
Find unconnected/floating pins in the focused project.
Takes no parameters.
Draw a short wire stub + net label on every unconnected schematic pin.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| stub_length_mils | number | no | Length of each stub wire in mils (default 100) |
| only_designators | array | no | If given, only stub pins on these components |
Place a rectangle shape on the active schematic (decorative only).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
| solid | boolean | no | Fill the rectangle (default False = outline only) |
| line_width | integer | no | 1 (small), 2 (medium), 3 (large) |
Place a decorative line on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
| line_width | integer | no | 1 (small), 2 (medium), 3 (large) |
Place a text-box note on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
| text | string | yes | Note content |
Place a sheet symbol for a child .SchDoc of the project (exact file name). Add entries with sch_place_sheet_entry.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
| sheet_file_name | string | yes | e.g. "PSU.SchDoc". |
| sheet_name | string | no | Default: the file name. |
| repeat_first | integer | no | — |
| repeat_last | integer | no | — |
Put part designators and comments, and sheet-symbol names and file names, back where Altium positions them, on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | no | Designators and sheet names to fix; none means every part and sheet symbol on the sheet. |
| method | string | no | What makes Altium reposition: "rotate" (90 degrees and back), "move" (one grid step and back) or "modify" (an edit with no change). |
Place an entry on a sheet symbol; it joins the child sheet's port of the same name.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sheet_name | string | yes | The symbol's name (a repeated one by its plain name). |
| entry_name | string | yes | The child port's name. |
| io_type | string | no | "input" | "output" | "bidirectional" | "unspecified" |
| side | string | no | "left" | "right" | "top" | "bottom" |
| distance_from_top | number | no | Along the side, in mils. |
| font_id | integer | no | 0 takes the sheet's entry font, else its net labels'. |
| repeat | boolean | no | One signal per channel, named Repeat(entry_name). |
Place a bus entry (45 degree stub) connecting a wire to a bus.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
Set the sheet size / template style of the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| style | string | no | Sheet size name, e.g. "A", "A3", "A4", "Letter", "Custom" |
| custom_width | integer | no | Custom sheet width in mils (only if style="Custom") |
| custom_height | integer | no | Custom sheet height in mils (only if style="Custom") |
| orientation | string | no | "landscape" or "portrait"; empty leaves it as is |
Read, or set, the active sheet's reference zones, margin, border style and template graphics. Call with nothing to read.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| zones_x | integer | no | — |
| zones_y | integer | no | — |
| margin_width | number | no | Sheet margin in mils. |
| border_style | integer | no | Altium's border style number (read one back first; 0 is the standard border). |
| reference_zones | boolean | no | Show the zone letters and numbers. |
| show_template_graphics | boolean | no | Show the template's graphics. |
| custom_zones_x | integer | no | — |
| custom_zones_y | integer | no | — |
| custom_margin_width | number | no | — |
Read, set, update or remove the sheet template (.SchDot) of a schematic sheet, with no dialog.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | no | "get" (default), "set", "update" or "remove". |
| template_file | string | no | The .SchDot for "set". For "update" it is optional: without it the sheet's own template file is read again (it must still exist on this machine). |
| vault | boolean | no | Also read the vault link (vault, item and revision GUIDs and names) a sheet set from the server carries. |
| file_path | string | no | The sheet (.SchDoc). Empty uses the sheet in front. Set and update bring a named sheet forward for Altium's template command and then restore the view you had. |
Find anything drawn outside the active schematic's sheet, and with `apply` bring it back inside.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | integer | no | — |
| apply | boolean | no | — |
Place a bus segment between two XY coordinates on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | Start X coordinate in mils |
| y1 | number | yes | Start Y coordinate in mils |
| x2 | number | yes | End X coordinate in mils |
| y2 | number | yes | End Y coordinate in mils |
Place a net label at coordinates on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | Net name for the label (e.g., "VCC", "GND", "SDA") |
| x | number | yes | X coordinate in mils |
| y | number | yes | Y coordinate in mils |
| orientation | integer | no | Label rotation (0=0deg, 1=90deg, 2=180deg, 3=270deg) |
Place a port on the active schematic for inter-sheet connectivity.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Port name (maps to net name) |
| x | number | yes | X coordinate in mils |
| y | number | yes | Y coordinate in mils |
| style | string | no | The port's axis: "horizontal" (also "none", "left", "right", "left_right") or "vertical" (also "top", "bottom"). Altium keeps only the axis; the arrows follow io_type and the end that is wired. |
| io_type | string | no | I/O direction, "unspecified", "output", "input", "bidirectional" |
| width | number | no | Port length in mils. Auto-size is turned off so it holds; 0 leaves the port sizing itself to its name. |
| font_id | integer | no | The port's font. 0 takes the font the sheet's ports already use, else its net labels' font. |
Move each port's cross-reference off its wire, to the free end.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sheet_path | string | yes | The .SchDoc. |
| dry_run | boolean | no | True (default) only lists what would move. |
Place a power port symbol (VCC, GND, etc.) on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | Net name for the power port (e.g., "VCC", "GND", "+3V3") |
| x | number | yes | X coordinate in mils |
| y | number | yes | Y coordinate in mils |
| style | string | no | Symbol style: "circle", circle symbol (default, typical for VCC) "arrow", arrow symbol "bar", bar/line symbol "wave", wave symbol "gnd_power", power ground symbol "gnd_signal", signal ground symbol "g |
| orientation | integer | no | which way the glyph points from the connection point: 0=right, 1=up, 2=left, 3=down. Leave at -1 to let the bridge decide by style: the three ground glyphs point down, the supply glyphs (circle, arrow |
| font_id | integer | no | The net name's font. 0 takes the font the sheet's power ports already use, else its net labels' font. |
Get title block parameters (title, revision, date, etc.) from a schematic sheet.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | no | Full path to a specific .SchDoc file. If empty, reads from the active document. |
Copy matching schematic objects to the clipboard.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | yes | Altium schematic object type (see obj_query) |
| filter | string | no | Pipe-separated property=value conditions (AND logic) |
Quick count of objects by type, faster than obj_query when you only need the count.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| object_type | string | yes | Altium object type constant (see obj_query for options) |
| scope | string | no | "active_doc" (default), "project", or "doc:C:\\path\\Sheet.SchDoc" for a specific loaded sheet. |
| filter | string | no | Pipe-separated property=value conditions (AND logic) |
Place a No ERC marker on a pin's connection end. By default it is active and suppresses every violation, as Altium's own does.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| symbol | integer | no | Altium's Symbol integer. |
| orientation | integer | no | Quarter turns, 0 to 3. |
| suppress_all | boolean | no | False suppresses only `error_kinds and connection_pairs` (Altium's strings). |
| active | boolean | no | False places it switched off. |
| error_kinds | string | no | — |
| connection_pairs | string | no | — |
Place a MANUAL junction at coordinates on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | X coordinate in mils |
| y | number | yes | Y coordinate in mils |
Get comprehensive info about the active document.
Takes no parameters.
Set the snap, visible and electrical grids for the active
| Parameter | Type | Required | Notes |
|---|---|---|---|
| snap_grid | number | no | Snap grid size in mils (0 = don't change); a metric grid in mils keeps its fraction (0.5 mm = 19.685) |
| visible_grid | number | no | Visible grid size in mils (0 = don't change) |
| snap_grid_on | boolean | no | Switch the snap grid on or off (None = don't change) |
| visible_grid_on | boolean | no | Switch the visible grid on or off (None = don't change) |
| hotspot_grid | number | no | Electrical grid in mils, how far a wire end is pulled onto a pin or wire (0 = don't change) |
| hotspot_grid_on | boolean | no | Switch the electrical grid on or off (None = don't change) |
Tidy the wires on the active sheet with Altium's own wire
Takes no parameters.
Where each part, net label, port, power port, sheet symbol and off-sheet connector sits on the active sheet, as the border zone a printed drawing is read by ("B3"). The zone is Altium's own; a sheet without zones gives an empty one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kinds | array | no | Any of "component", "net_label", "port", "power_port", "sheet_symbol", "cross_sheet"; None for all. |
Read, or set, the schematic editor's preferences.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| snap_to_electrical_grid | boolean | no | Pull wire ends onto pins and wires. |
| electrical_grid_distance | integer | no | How far they are pulled (Altium's number). |
| drag_orthogonal | boolean | no | Wires stay at right angles when dragging. |
| components_cut_wires | boolean | no | A part dropped on a wire cuts it. |
| optimize_wires | boolean | no | Join and trim overlapping wires. |
| single_slash_negation | boolean | no | One leading backslash bars the whole name. |
| convert_special_strings | boolean | no | Show special strings as values. |
| mark_manual_parameters | boolean | no | Mark parameters moved by hand. |
| show_pin_direction | boolean | no | Draw each pin's direction arrow. |
| auto_zoom | boolean | no | Zoom to a part found by a cross-probe. |
| click_clears_selection | boolean | no | A click on empty space clears it. |
| double_click_runs_inspector | boolean | no | Double-click opens the Inspector. |
| undo_levels | integer | no | How many steps undo keeps. |
| pin_name_margin | integer | no | Gap between the body edge and a pin name, in mils. |
| pin_number_margin | integer | no | Gap from the body edge to a pin number, in mils. |
| multi_part_naming | integer | no | How multi-part designators are written (Altium's number: U1A, U1:1 ...). |
| increment_primary | string | no | The step for repeated placement, e.g. "1". |
| increment_secondary | string | no | The second step, e.g. "1". |
| power_ground_name | string | no | Net name of a new power ground port. |
| signal_ground_name | string | no | Net name of a new signal ground port. |
Set the unit system for the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| unit | string | yes | one of "mil" , imperial, mils (0.001 in) "inch" , imperial, inches "dxp" , DXP default "auto_imperial" , auto-scaled imperial display "mm" , metric, millimetres |
Place a directive ON a wire of the active schematic; its
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| param_name | string | no | — |
| param_value | string | no | — |
| parameters | object | no | Several, e.g. {"NetClass": "PWR", "Width": "20"}. |
| style | integer | no | Altium's Style integer. |
| orientation | integer | no | Quarter turns, 0 to 3. |
Enumerate parameter-set directives on the active schematic sheet.
Takes no parameters.
Place a blanket on the active schematic: a polygon whose directive applies to every net it encloses (a net class, a differential pair, No ERC over an area).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vertices | array | yes | Outline as [[x, y], ...] in mils, at least 3 points. |
| parameters | object | no | The directive's parameters, e.g. {"NetClass": "PWR"}. Omit for a bare blanket. |
| directive_x | number | no | — |
| directive_y | number | no | — |
| line_style | integer | no | Outline style, as Altium's integer. |
| collapsed | boolean | no | Draw the blanket collapsed. |
Place a compile mask on the active schematic: what it encloses is left out of the compile, netlist and ERC.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
| collapsed | boolean | no | Draw it collapsed. |
Put library parts on a harness wiring diagram as harness connectors.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| connectors | array | yes | [{lib_reference, library_path (.SchLib), designator, x, y (mils), rotation (0, 90, 180 or 270)}]. |
| document_path | string | no | The open .WirDoc. Empty uses the document in front. Anything other than a wiring diagram is refused. |
Draw harness wires and splices on a harness wiring diagram.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document_path | string | yes | The open .WirDoc. |
| wires | array | no | [{points [[x, y], ...] (mils, two or more), name ("W1"), colour ("#RRGGBB"), colour_name (the wire colour code, e.g. "RD")}]. |
| splices | array | no | [{x, y, name ("SPL1")}]. |
| connect | boolean | no | Save and reopen the diagram, then read the ends back (default True). False leaves the ends unlinked until the diagram is next opened. |
Read a harness wiring diagram (.WirDoc): every wire and what it joins.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document_path | string | no | The open .WirDoc. Empty reads the document in front. |
| limit | integer | no | The most wires to list (default 500). |
List the blankets on the active schematic sheet.
Takes no parameters.
Place an image/logo on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| image_path | string | yes | Full path to the image file (BMP, JPG, PNG, etc.) |
| x | number | yes | X coordinate in mils (bottom-left corner) |
| y | number | yes | Y coordinate in mils (bottom-left corner) |
| width | number | no | Image width in mils (default 500) |
| height | number | no | Image height in mils (default 500) |
Replace a part on the active sheet with another library part.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component designator to replace (e.g., "U1", "R3") |
| new_lib_ref | string | yes | New library reference / component name |
| new_library | string | no | New source library name for the relink (optional, keeps current if empty) |
| library_path | string | no | .SchLib holding `new_lib_ref`; swaps the symbol. |
| allow_pin_changes | boolean | no | Swap even when pins move or disappear; the wires on those pins are then left unconnected. |
Point placed parts at another library, without Altium's dialog.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designators | array | yes | the parts to relink, e.g. ["R1", "R2"]. |
| library_path | string | no | target .SchLib, .IntLib or .DbLib (full path to verify; a bare file name is written without checking). |
| lib_ref | string | no | the symbol name in that library. |
| dblib_table | string | no | DbLib table. |
| dblib_key | string | no | the row's key, which becomes the Design Item ID. |
| footprint | string | no | footprint name for the current footprint model. |
| footprint_library | string | no | .PcbLib the footprint model points at. |
| sheet_path | string | no | open .SchDoc; empty = the focused sheet. |
| all_sheets | boolean | no | every open schematic of the focused project. |
| dry_run | boolean | no | report what would change, write nothing. |
| verify | boolean | no | check the target before writing (default True). |
Unpin placed schematic components from a stale source library.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sheet_path | string | no | absolute .SchDoc path; empty = the focused sheet. For a whole project, call once per sheet (see proj_list_documents). |
| designators | array | no | restrict to these designators (whole-string, case-sensitive); None/empty = every component on the sheet. |
| clear_source_library | boolean | no | clear `SourceLibraryName`. |
| sync_design_item_id | boolean | no | set `DesignItemId` = LibReference where they differ. |
Enumerate IDocument.DM_ConstraintGroups on the active schematic.
Takes no parameters.
Place a harness connector on the active schematic sheet, with its entries.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| width | number | no | — |
| height | number | no | — |
| harness_type | string | no | Named harness type (optional). |
| entries | array | no | Entry names, top to bottom (e.g. ["USB+", "USB-"]). |
| entry_side | string | no | "left", "right", "top" or "bottom". |
| entry_pitch | number | no | mils from the top to the first entry and between entries; keep the height long enough for them. |
Draw a signal harness on the active sheet: the thick line that carries a harness from a harness connector or harness port to a sheet entry. Its ends must meet those objects' connection points.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vertices | array | yes | [[x, y], ...] in mils, two points or more. |
Place a cross-sheet connector (off-sheet port) on the active sheet.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| net | string | no | Net name the connector binds to. |
| side | string | no | "left" or "right" orientation (optional). |
Place a multi-line text frame (note block) on the active sheet.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | yes | — |
| y2 | number | yes | — |
| text | string | yes | Frame contents. |
| align | string | no | Horizontal alignment "left", "center", or "right". |
| font_id | integer | no | The frame's font. 0 takes the font the sheet's text frames already use, else its net labels' font. |
Place a table-of-contents note listing every schematic sheet.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | no | — |
| y1 | number | no | — |
| x2 | number | no | — |
| y2 | number | no | — |
| title | string | no | Heading line above the list. |
| project_path | string | no | Optional project; uses active if omitted. |
Mark a placed schematic component as a net tie.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component to convert (e.g. "NT1"). |
| mode | string | no | "nobom" (default, hidden from BOM, kept through sync) or "bom" (appears in the BOM). |
Offset the trailing number of schematic designators by a delta.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| delta | integer | yes | Non-zero integer added to each designator's number. |
| prefix | string | no | If set (e.g. "R"), only designators with this letter prefix are changed. |
Show or hide pin name / designator labels on schematic symbols.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | no | Component to target, or "" for all components. |
| show_name | boolean | no | True/False to set pin-name visibility (optional). |
| show_designator | boolean | no | True/False to set pin-designator visibility. |
Switch the active sub-part on a multi-part schematic component.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component reference (e.g., "U1"). |
| part_id | integer | yes | Sub-part index, 1-based (1=A, 2=B, ...). A value above PartCount is accepted by Altium and does not take, so the result is read back and a mismatch is reported. |
| location_x | number | no | Symbol X in mils, to choose one of several. |
| location_y | number | no | Symbol Y in mils, to choose one of several. |
Set UniqueId on every placed symbol with this designator.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component reference as drawn (e.g. "U_COMP2B"). |
| unique_id | string | yes | Target UniqueId, usually copied from the A unit. |
Copy a placed schematic part and share the master's UniqueId.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Source instance to copy (e.g. "U8"). |
| part_id | integer | no | 1-based CurrentPartID for the copy. 0 = keep source. |
| x | integer | no | — |
| y | integer | no | — |
| new_designator | string | no | Designator for the copy. Empty keeps the source designator (required for multi-part packing). |
Place a simulation voltage probe on the active schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| net_name | string | no | Echoed back; the net comes from the wire. |
| probe_method | string | no | Echoed back. |
| name | string | no | A name shown instead of the net's (ProbeCustomName). |
Attach a datafile link to a component's current implementation.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component reference (e.g., "U1"). |
| file_path | string | yes | Full path to the file being linked. |
| kind | string | no | Optional implementation-specific type (e.g., "SimModel", "IBIS"). |
Create many schematic objects in ONE call (obj_create items).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| operations | array | yes | List of create dicts, each with: - scope: "active_doc" (default), the only scope a create takes; any other is refused. - object_type: Altium type name (e.g. "eNetLabel", "eJunction", "eNoERC"). - prop |
Delete objects for many scope/type/filter sets (obj_delete items).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| operations | array | yes | List of delete dicts, each with: - scope: "active_doc" (default), "project", or "doc:<absolute_path>". - object_type: Altium type name (e.g. "eJunction", "eNoERC", "eWire", or a PCB type such as "eTra |
| confirm_delete_all | boolean | no | required when any operation has an empty filter; otherwise nothing is sent. |
Place MANY wire segments on the active schematic in ONE call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| wires | array | yes | List of wire dicts, each with x1, y1, x2, y2 in mils. Fractions are kept, so a pin end on a metric grid (30905.45) is met exactly. |
Place MANY schematic components from libraries in ONE call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| placements | array | yes | [{lib_reference (required), x, y (mils), library_path (empty: an open library), designator, rotation (0/90/180/270), footprint, part_id}]. With `footprint` naming one of the symbol's PCB models (any |
| document_path | string | no | .SchDoc to focus and place onto. |
| allow_manual_layout | boolean | no | True places your own coordinates onto an empty sheet anyway; say why. |
| tidy | boolean | no | Make each placed part match the sheet: its library link (a loaded part says "*", and Altium then will not change its Design Item ID), the parameters its models bring hidden, and the sheet's designator |
Place MANY managed (Workspace) components in ONE call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| placements | array | yes | dicts with "design_item_id" (required), `x, y (mils), optional designator, rotation and part_id` (which part of a multi-part component goes down; default 1, set before the part reach |
| vault | string | no | The Workspace name; usually read off managed parts on an open sheet. If refused, ask the user, don't invent it. |
| document_path | string | no | The .SchDoc to focus and place onto. |
| lib_identifier_kind | integer | no | Load kind, default 4 (VaultName). |
| allow_manual_layout | boolean | no | Place onto a near-empty sheet anyway. |
Attach SPICE primitives to MANY components in ONE call.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| attachments | array | yes | List of attach dicts, each with: - designator (str, required) - primitive (str, required), R/L/C/V/I/D/Q/M/X - value (str, optional), "10k", "100n", "DC 5", "SIN(0 1 1k)", etc. - spice_model (st |
How to do something correctly, and what is genuinely impossible.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| task | string | no | What you are trying to do, in your own words, e.g. "delete silkscreen from a footprint". Matched on keywords, so a rough phrase is fine. |
| document_kind | string | no | Narrow to one of library, board, schematic, project, any. Optional. |
| backend | string | no | altium, kicad or easyeda. Optional; omit to see every backend's answer. |
Check the live connection to a running KiCad; returns KiCad and API versions, or a reason (enable the API server, open a board).
Takes no parameters.
Move a component to an absolute board position (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
| x_mm | number | yes | — |
| y_mm | number | yes | — |
| save | boolean | no | — |
Set a component's orientation (degrees).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
| degrees | number | yes | — |
| save | boolean | no | — |
Place a component on the top or bottom copper layer ("top"/"bottom").
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
| side | string | yes | — |
| save | boolean | no | — |
Lock or unlock a component's placement.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
| locked | boolean | no | — |
| save | boolean | no | — |
Set a component's value field.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
| value | string | yes | — |
| save | boolean | no | — |
Delete a component from the board.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
| save | boolean | no | — |
Add a copper track segment on a layer ("F.Cu", "B.Cu", "In1.Cu"), assigned to a net, between two points (mm) at a given width (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net | string | yes | — |
| layer | string | yes | — |
| x1_mm | number | yes | — |
| y1_mm | number | yes | — |
| x2_mm | number | yes | — |
| y2_mm | number | yes | — |
| width_mm | number | yes | — |
| save | boolean | no | — |
Add a through via at a position (mm) with pad diameter and drill diameter (mm), assigned to a net.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net | string | yes | — |
| x_mm | number | yes | — |
| y_mm | number | yes | — |
| diameter_mm | number | yes | — |
| drill_mm | number | yes | — |
| save | boolean | no | — |
Add a text label at a position (mm) on a layer (default
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | — |
| x_mm | number | yes | — |
| y_mm | number | yes | — |
| layer | string | no | — |
| save | boolean | no | — |
Add a graphic line between two points (mm) on a layer (default "F.Silkscreen") with a stroke width (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1_mm | number | yes | — |
| y1_mm | number | yes | — |
| x2_mm | number | yes | — |
| y2_mm | number | yes | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Add a graphic circle at a centre (mm) with a radius (mm) on a layer, with a stroke width (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cx_mm | number | yes | — |
| cy_mm | number | yes | — |
| radius_mm | number | yes | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Add a graphic rectangle from top-left to bottom-right (mm) on a layer, with a stroke width (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1_mm | number | yes | — |
| y1_mm | number | yes | — |
| x2_mm | number | yes | — |
| y2_mm | number | yes | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Add a graphic arc through start, mid and end points (mm) on a layer, with a stroke width (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1_mm | number | yes | — |
| y1_mm | number | yes | — |
| mid_x_mm | number | yes | — |
| mid_y_mm | number | yes | — |
| x2_mm | number | yes | — |
| y2_mm | number | yes | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Add a copper zone (pour) on a layer, assigned to a net, with an outline given as a list of [x_mm, y_mm] points (at least 3).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net | string | yes | — |
| points | array | yes | — |
| layer | string | no | — |
| name | string | no | — |
| priority | integer | no | — |
| save | boolean | no | — |
Set a project text (substitution) variable, e.g. key "REV" value "B". Other variables are preserved.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| key | string | yes | — |
| value | string | yes | — |
| save | boolean | no | — |
Upgrade the open board's file format to the current KiCad version.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| force | boolean | no | — |
Upgrade the open schematic's file format to the current KiCad version. Rewrites the .kicad_sch on disk in place.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| force | boolean | no | — |
Run an arbitrary KiCad tool action by name (e.g. a TOOL_ACTION such as "pcbnew.Control.zoomFitScreen"). Escape hatch equivalent to Altium's run-process/run-menu.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | — |
Write the open board to disk.
Takes no parameters.
Copper tracks and arcs: net, layer, width, endpoints, length (mm).
Takes no parameters.
Total routed track length per net (mm), summed from the copper tracks. Useful for length-matching and impedance work.
Takes no parameters.
Vias: net, position, diameter and drill (mm).
Takes no parameters.
Per-layer routing usage: track count and total track length (mm), sorted by length.
Takes no parameters.
Via count and the distinct via sizes (pad diameter / drill) in use, each with a count. Fewer via types is cheaper to fabricate.
Takes no parameters.
Copper zones and rule areas: name, net, layers, fill, priority.
Takes no parameters.
Board stackup: layer name, type, material, thickness (mm).
Takes no parameters.
Enabled board layer names.
Takes no parameters.
Board edge bounding box (mm), from Edge.Cuts graphics.
Takes no parameters.
Title-block fields (title, date, revision, company, comments).
Takes no parameters.
Free board text items: value, layer, position (mm).
Takes no parameters.
Full detail for one component: value, footprint, position (mm), layer, lock state, and its pads with net assignments.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reference | string | yes | — |
Board fabrication statistics (component / pad / hole / track counts, board area) via kicad-cli. Runs on the board file on disk.
Takes no parameters.
Pads with no net assigned (potentially unconnected pins).
Takes no parameters.
Differential pairs inferred from net naming (X_P/X_N, X+/X-), naming-agnostic beyond the universal polarity suffix convention.
Takes no parameters.
All pads on a given net: reference and pin number.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net_name | string | yes | — |
Find components whose reference or value contains the query
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | yes | — |
Items currently selected in the KiCad PCB editor: type and, for footprints, reference.
Takes no parameters.
Graphic shapes: type (segment/arc/circle/rect/polygon), layer, net, and geometry points (mm).
Takes no parameters.
Item groups on the board: name and member count.
Takes no parameters.
Dimension annotations: layer, override text, height (mm).
Takes no parameters.
Documents currently open in KiCad (PCB and schematic) with
Takes no parameters.
Open project's name, directory, and net-class names.
Takes no parameters.
Project text (substitution) variables.
Takes no parameters.
Structured schematic netlist: components (reference, value,
Takes no parameters.
One-call comprehensive review of the open design: board stats, PCB connectivity review, schematic review, schematic-vs-PCB comparison, and (optionally) geometric DRC and schematic ERC. Sections that fail are reported under sections_failed rather than aborting the whole review.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| include_drc | boolean | no | — |
| include_erc | boolean | no | — |
Design review of the SCHEMATIC's intended connectivity: annotation, single-pin nets, shorts, unconnected parts, missing decoupling, net classes -- from the netlist, independent of PCB layout. Complements review_design (which reviews the PCB copper).
Takes no parameters.
Consolidated Bill of Materials from the schematic netlist: one line per value+footprint with quantity and the reference designators.
Takes no parameters.
Compare the schematic netlist against the open PCB and report components and nets present in one but not the other (the schematic/PCB sync differences an ECO would resolve).
Takes no parameters.
One-call board overview: object counts, board size (mm), layer count, distinct via sizes, and net/component counts.
Takes no parameters.
Per-net net-class assignment and each class's routing rules
Takes no parameters.
All pads on the board: number, net, position (mm), pad type.
Takes no parameters.
Plot Gerber files for every board layer into a directory.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Generate Excellon drill files into a directory.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the board as a STEP 3D model.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the board as a GLB (binary glTF) 3D model.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Plot the given board layers to a PDF (comma-separated layer names).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layers | string | no | — |
| output_dir | string | no | — |
Generate a component position (pick-and-place) file.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the board in IPC-2581 format.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the board in ODB++ format.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Plot the given board layers to DXF (mechanical CAD) files.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layers | string | no | — |
| output_dir | string | no | — |
Generate an IPC-D-356 netlist (bare-board electrical test).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the board as a VRML 3D model.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the board as an STL 3D model (3D printing / mechanical).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export an interactive 3D PDF of the board.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Render the board's 3D view to a PNG image.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Run an arbitrary kicad-cli command -- an escape hatch for anything not covered by a dedicated tool (e.g. pcb import, version formats).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| args | array | yes | — |
Run a KiCad jobset (a saved batch of output jobs -- KiCad's
| Parameter | Type | Required | Notes |
|---|---|---|---|
| jobset_path | string | yes | — |
| output | string | no | — |
Run any kicad-cli PCB export format not covered by a dedicated tool (e.g. gencad, brep, ply, xao, u3d, stpz, ps, hpgl, stats).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fmt | string | yes | — |
| layers | string | no | — |
| output_dir | string | no | — |
Generate a Bill of Materials (CSV) from the schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export a netlist from the schematic.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Run a SPICE simulation on the schematic via a standalone ngspice.
Takes no parameters.
Export a SPICE netlist from the schematic (the input to an ngspice simulation; requires SPICE models/directives on the schematic).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the schematic sheets to a PDF.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Export the schematic sheets to SVG (one per sheet).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
Run any kicad-cli schematic export format not covered by a dedicated tool (e.g. dxf, ps, hpgl, python-bom).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fmt | string | yes | — |
| output_dir | string | no | — |
Export a footprint (or a whole .pretty library) to SVG.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | — |
| footprint | string | no | — |
| output_dir | string | no | — |
Export a symbol (or a whole .kicad_sym library) to SVG.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | — |
| symbol | string | no | — |
| output_dir | string | no | — |
Generate a complete, openable KiCad project from a DesignPlan:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | yes | — | |
| output_dir | string | yes | — |
| name | string | no | — |
Generate a KiCad schematic (.kicad_sch) from a DesignPlan: embeds a box symbol per part, places every part on a grid, and carries net connectivity via global labels. The KiCad counterpart of Altium's design-execution (schematic side); the output opens in Eeschema.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | yes | — | |
| output_path | string | yes | — |
| render | boolean | no | — |
Generate a KiCad board (.kicad_pcb) from a DesignPlan: declares the nets and places a footprint per part with pads assigned to those nets.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plan_json | yes | — | |
| output_path | string | yes | — |
| render | boolean | no | — |
Create a footprint (.kicad_mod) in a .pretty library from a list of pads. Each pad: {number, x_mm, y_mm, w_mm, h_mm, shape (rect/roundrect/ circle/oval), type (smd/thru_hole), drill_mm (thru_hole only)}.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | — |
| name | string | yes | — |
| pads | array | yes | — |
| descr | string | no | — |
| tags | string | no | — |
| render | boolean | no | — |
Create a COMPLETE .kicad_mod footprint from a package drawing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | the .pretty directory (created if missing). |
| package | yes | the PackageSpec as an object or JSON text, in mm, the same schema as lib_create_footprint_from_package. | |
| name | string | no | footprint name; default the package's name. |
| density | string | no | L, N or M; default the package's own (N). |
| description | string | no | appended to the generated description. |
| tags | string | no | KiCad keyword tags. |
| drafting | object | no | drafting rule overrides. |
| overwrite | boolean | no | replace an existing footprint of the same name. Off by default: a footprint in a library may already be on boards. |
| render | boolean | no | export an SVG with kicad-cli to look at. |
Upgrade a footprint (.pretty) library to the current KiCad format.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | — |
| output_dir | string | no | — |
Create a schematic symbol in a .kicad_sym library. Each pin:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | — |
| name | string | yes | — |
| pins | array | yes | — |
| reference | string | no | — |
| body_w_mm | number | no | — |
| body_h_mm | number | no | — |
| render | boolean | no | — |
Upgrade a symbol (.kicad_sym) library to the current KiCad format.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | — |
| output_dir | string | no | — |
Find board items in the open PCB and read them (mm, degrees).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kinds | array | no | — |
| ids | array | no | — |
| nets | array | no | — |
| net_classes | array | no | — |
| layers | array | no | — |
| references | array | no | — |
| selected | boolean | no | — |
| inside_mm | array | no | — |
| count_only | boolean | no | — |
| limit | integer | no | — |
Pads of footprints by reference: number, net, type, shape, size, drill, position, angle, layers, tenting. with_polygons adds each pad's copper outline on its first copper layer (mm).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| references | array | yes | — |
| with_polygons | boolean | no | — |
Copper connected to the given items (by id, or a footprint's pad by reference and pad number), as KiCad's connectivity sees it:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | no | — |
| reference | string | no | — |
| pad | string | no | — |
| kinds | array | no | — |
The filled copper of zones (by id or name; all zones when none given): per layer, each polygon's outline and holes in mm, plus its area in mm2. Empty when the zone is unfilled: refill first.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | no | — |
| names | array | no | — |
Edge-to-edge copper distance (mm) between two items: tracks, arcs, vias, pads (their true outline) and filled zones. 0 means touching or overlapping.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id_a | string | yes | — |
| id_b | string | yes | — |
Footprints whose bodies overlap (bounding boxes without text, grown by clearance_mm), among the references given or all.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| references | array | no | — |
| clearance_mm | number | no | — |
The PCB editor's view state: visible layers, active layer,
Takes no parameters.
The whole board in KiCad's file format as it stands in the editor, unsaved edits included. With output_path it is written there and only the path and size come back.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | no | — |
Run KiCad's DRC on the board as it stands in the editor (a copy saved with the project's rules, so unsaved edits count). Lists each violation with its type, severity, description, position and items, and the unconnected items grouped by net.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| include_unconnected | boolean | no | — |
| limit | integer | no | — |
Draw copper tracks. Each item: points [[x_mm, y_mm], ...] (a polyline), and net, layer, width_mm, locked. One commit.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| net | string | no | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Draw copper arc tracks. Each item: start_mm, mid_mm, end_mm, or center_mm, radius_mm, start_deg, end_deg (counter-clockwise from +X); and net, layer, width_mm. One commit.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| net | string | no | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Place vias. Each item: x_mm, y_mm, and net, diameter_mm,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| net | string | no | — |
| diameter_mm | number | no | — |
| drill_mm | number | no | — |
| save | boolean | no | — |
Stitch vias on a grid at pitch_mm inside area_mm [x1,y1,x2,y2] or a zone's outline, on a net. A grid point is skipped when the via would come within clearance_mm of a pad, track or via of another net, or of the board edge. dry_run lists the points without placing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net | string | yes | — |
| pitch_mm | number | yes | — |
| area_mm | array | no | — |
| zone_id | string | no | — |
| clearance_mm | number | no | — |
| diameter_mm | number | no | — |
| drill_mm | number | no | — |
| max_vias | integer | no | — |
| dry_run | boolean | no | — |
| save | boolean | no | — |
Draw graphics on any layer. Each item: shape segment (start_mm, end_mm), rectangle (start_mm, end_mm corners), circle (center_mm, radius_mm), arc (start_mm, mid_mm, end_mm, or center_mm, radius_mm, start_deg, end_deg) or polygon (points); and layer, width_mm, filled, net. A filled copper rectangle…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| layer | string | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Place board text. Each item: text, x_mm, y_mm, and layer,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| layer | string | no | — |
| size_mm | number | no | — |
| save | boolean | no | — |
Add copper zones (pours) or rule areas. Each item: points
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| net | string | no | — |
| fill | boolean | no | — |
| save | boolean | no | — |
Place dimensions. Each item: start_mm, end_mm (centre and a point on the circle for radial and center), style (aligned, orthogonal, leader, center, radial), height_mm (line offset), layer,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| layer | string | no | — |
| save | boolean | no | — |
Replace the board edge: every Edge.Cuts graphic is removed and one closed outline drawn. Give points (a polygon), rect_mm [x1,y1,x2,y2], or fit_components_margin_mm to wrap all footprints' bodies plus a margin.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| points | array | no | — |
| rect_mm | array | no | — |
| fit_components_margin_mm | number | no | — |
| width_mm | number | no | — |
| save | boolean | no | — |
Change fields of board items in one commit, keeping the rest.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | no | — |
| where | object | no | — |
| set | object | no | — |
| save | boolean | no | — |
Move items (by id, or footprints by reference) by dx_mm, dy_mm, and/or turn them by rotate_deg counter-clockwise about about_mm (default: the centre of their positions). One commit.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | no | — |
| references | array | no | — |
| dx_mm | number | no | — |
| dy_mm | number | no | — |
| rotate_deg | number | no | — |
| about_mm | array | no | — |
| save | boolean | no | — |
Copy items (tracks, arcs, vias, shapes, text, zones, dimensions) count times, each copy offset by dx_mm, dy_mm and turned by
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | yes | — |
| dx_mm | number | no | — |
| dy_mm | number | no | — |
| count | integer | no | — |
| rotate_deg | number | no | — |
| about_mm | array | no | — |
| net | string | no | — |
| layer | string | no | — |
| save | boolean | no | — |
Delete board items by id, or every item matching where (the
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | no | — |
| where | object | no | — |
| save | boolean | no | — |
Remove zero-length tracks, tracks that duplicate another (same ends, layer and net) and vias stacked on another via of the same net. dry_run lists them without deleting.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| dry_run | boolean | no | — |
| save | boolean | no | — |
Move and turn footprints to absolute positions in one commit. Each
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| save | boolean | no | — |
Turn footprints over to the other side with KiCad's own Flip, which mirrors their pads, graphics and text. One undo step.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| references | array | yes | — |
| save | boolean | no | — |
Align or distribute footprints with KiCad's own tools. action:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| references | array | yes | — |
| action | string | yes | — |
| save | boolean | no | — |
Move footprints (the references given, or all) to the nearest point of a grid_mm grid measured from the grid origin. One commit.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| grid_mm | number | no | — |
| references | array | no | — |
| skip_locked | boolean | no | — |
| save | boolean | no | — |
Select items in the PCB editor: by id, footprints by reference, or every track, via, pad and zone of nets. mode: replace, add, remove, clear. highlight also highlights the selected items' nets (clear mode clears the highlight).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | no | — |
| references | array | no | — |
| nets | array | no | — |
| mode | string | no | — |
| highlight | boolean | no | — |
Refill every copper zone (KiCad 10.0 cannot refill only some), or unfill them all with unfill. Waits for the fill and reports each zone's filled state.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| unfill | boolean | no | — |
Set the board's copper layer count and enable or disable the technical and user layers (e.g. "User.1", "F.Adhes"). Copper layers are added or removed at the inside of the stack.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| copper_layers | integer | no | — |
| enable | array | no | — |
| disable | array | no | — |
Change what the PCB editor shows: visible_layers (the full set), or show and hide some; active_layer; inactive_layers (normal, dimmed, hidden); net_colors (all, ratsnest, off); ratsnest
| Parameter | Type | Required | Notes |
|---|---|---|---|
| visible_layers | array | no | — |
| show | array | no | — |
| hide | array | no | — |
| active_layer | string | no | — |
| inactive_layers | string | no | — |
| net_colors | string | no | — |
| ratsnest | string | no | — |
| board_flip | string | no | — |
Set the board's grid origin or its drill/place origin (kind
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x_mm | number | yes | — |
| y_mm | number | yes | — |
| kind | string | no | — |
Set the board's title block: title, date, revision, company, and comments {"1": "...", ...} for comment1 to comment9. Fields not given are kept.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| title | string | no | — |
| date | string | no | — |
| revision | string | no | — |
| company | string | no | — |
| comments | object | no | — |
| save | boolean | no | — |
Add or change net classes (each item: name, and clearance_mm, track_width_mm, diff_pair_width_mm, diff_pair_gap_mm,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | no | — |
| delete | array | no | — |
Save a copy of the board as it stands in the editor to path
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | — |
| overwrite | boolean | no | — |
Throw away unsaved board edits and reload the board file.
Takes no parameters.
Put review markers on the board among KiCad's DRC markers. Each
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| severity | string | no | — |
Write a fabrication package from the board as it stands in the
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | — |
| zip_gerbers | boolean | no | — |
The board's design rules from the project files: the board-setup constraints (mm) in the .kicad_pro, the net-class patterns that assign nets to classes, and each custom rule in the .kicad_dru with its name, layer, condition and constraints. Net-class values are read live with kicad_get_net_classes.
Takes no parameters.
Write design rules to the project files.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| constraints | object | no | — |
| rules | array | no | — |
| delete_rules | array | no | — |
| netclass_patterns | array | no | — |
| replace_patterns | boolean | no | — |
Write the board stackup (layer, type, material, thickness, Er, loss tangent) to a CSV file and return its path and rows.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | no | — |
Create a new, empty Altium project, made and saved by Altium.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | yes | Full path for the new project file. |
| project_type | string | no | Not needed; the extension decides the kind. |
Open an existing Altium project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | yes | Full path to the project file |
Save the current or specified project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional path to specific project. If None, saves active project. |
Close a project, saving its documents (default) or discarding their unsaved edits (save=False).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Project to close; omit for the focused one (a save=False prompt is then left for a human). |
| save | boolean | no | Write modified documents first (True) or discard (False). |
List all documents in a project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional path to specific project. If None, uses active project. |
Add an existing document to a project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document_path | string | yes | Full path to the document to add |
| project_path | string | no | Optional project path. If None, uses active project. |
Remove a document from a project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document_path | string | yes | Full path to the document to remove |
| project_path | string | no | Optional project path. If None, uses active project. |
| save_project | boolean | no | Write the .PrjPcb so the removal lasts (default). False leaves it for a later proj_save. |
Rename a project document, keeping the project and its sheet symbols pointing at it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document_path | string | yes | Full path of the document. |
| new_name | string | yes | The new file name (extension optional, same kind). |
| project_path | string | no | The project; defaults to the one holding it. |
Get all parameters defined at the project level.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Set a project-level parameter.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Parameter name |
| value | string | yes | Parameter value |
| project_path | string | no | Optional project path. If None, uses active project. |
Copy all project-level parameters onto each loaded schematic sheet.
Takes no parameters.
Get net-to-pin connectivity from the compiled project netlist.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| component | string | no | Filter by component designator. Empty = all. |
| net_name | string | no | Filter by net name. Empty = all. |
| project_path | string | no | Optional project path. If None, uses active. |
| limit | integer | no | Max pin records (default 500). Raise for big boards. |
| force_recompile | boolean | no | Save dirty docs and recompile from scratch (5-10 s more), for a netlist that is surely fresh, e.g. after the user edited sheets. `proj_get_compile_freshness` tells whether any doc is dirty. |
Write the compiled connectivity to a flat netlist file.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | no | Destination file. Defaults to workspace/netlist.<ext> if omitted. |
| net_format | string | no | "pads" (default) or "tabular". |
| project_path | string | no | Optional project path; uses active if omitted. |
Compile a project to check for errors.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Load every schematic sheet of a project into the Altium editor.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses focused project. |
Write the BOM and pick-and-place (CPL) files JLCPCB assembly takes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | yes | folder for the two files (made when missing). |
| lcsc_parameter | string | no | the parameter holding the LCSC number. Empty tries "LCSC Part #", "LCSC Part Number", "LCSC", "LCSC Part", "JLCPCB Part #". |
| name | string | no | file name stem; default the board's name. |
| not_placed | array | no | designators meant to be left off the assembly (fitted by hand, not fitted). Any other part without an LCSC number refuses the export. |
| board_path | string | no | the .PcbDoc to export. Empty uses the only open board; with several open the export is refused until one is named. |
Export a full BOM from the compiled project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
| limit | integer | no | Max components to return (default 1000). |
| variant | string | no | A variant's name or description. Leave empty for the base design. |
Get full information about one placed component.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | e.g. "U1". |
| project_path | string | no | Project (default: the active one). |
| with_pin_nets | boolean | no | Compile and give each pin's net (default True). |
| with_parameters | boolean | no | Include parameters (default True). |
| timeout | number | no | Poll timeout in seconds (raise to ~90 with pin nets on large projects). |
Full per-component info for MANY designators in ONE round-trip.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designators | array | yes | List of component designators. |
| project_path | string | no | Optional project path. If None, uses active. |
| with_pin_nets | boolean | no | When True (default) compile once and emit the flattened net for each pin on every component. Set False to skip the compile. |
| with_parameters | boolean | no | When True (default) include each component's parameter dict. |
| timeout | number | no | Optional bridge poll-timeout override (seconds). Raise this when keeping with_pin_nets=True on large hierarchical projects. |
Open Altium's PRINT dialog for the active document, for a PDF.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | yes | Full path for the output PDF file |
Jump to and highlight a component in the schematic or PCB.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component designator to find (e.g., "U1", "R8") |
| target | string | no | "schematic" or "pcb" |
Get design statistics from the compiled project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Get PCB board information, outline vertices, layer stack, origin.
Takes no parameters.
Annotate schematic designators programmatically, no dialog, no user interaction.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| order | string | no | Annotation traversal order: "down_then_across" (default: row-major top-to-bottom, left-to-right) "up_then_across" (row-major bottom-to-top, left-to-right) "across_then_down" (column-major left-to-ri |
Generate manufacturing output files from the active PCB.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_type | string | yes | Type of output, "gerber", "drill", "pick_place", "ipc_netlist" |
| output_path | string | no | Optional output directory/file path |
Get information about the currently focused project.
Takes no parameters.
Export a board to a STEP 3D model with Altium's own exporter.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | yes | Full path for the .step file. |
| board_path | string | no | Focus this .PcbDoc first; it must then be the board in front, since the export acts on the front view. Omit it to export the board already in front. |
| overwrite | boolean | no | Replace an existing file. Off by default, so an earlier export is never lost by accident. |
| options | object | no | Exporter settings to apply first, by the names `proj_step_export_options reads (folded, fold_rate, copper_option, holes_option` ...). Altium keeps them for later exports, as the dial |
Give a project an OutJob by copying one in the user's own style.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | yes | The target .PrjPcb. |
| source_outjob | string | no | The .OutJob to copy. |
| outjob_name | string | no | File name for the copy; defaults to the source's. |
| output_dir | string | no | Absolute folder for the outputs; defaults to "Project Outputs for <project>" beside the project. |
| use_fallback | boolean | no | With no source, copy Altium's shipped Fabrication template. Only once the user has agreed. |
Export the active PCB to DXF (AutoCAD) format.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | no | Full path for the output .dxf file (optional) |
Export the active schematic / PCB document, silent (no dialog).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | yes | Full path for the output file. The directory must already exist. The extension should be `.pdf`. |
| format | string | no | Output format. Only `"pdf" is silent today (default). "png", "jpg", "bmp" return an explicit IMAGE_FORMAT_UNSUPPORTED` error. |
| width | integer | no | — |
| height | integer | no | — |
List all output containers defined in an OutJob file.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outjob_path | string | no | Path to the .OutJob file. If omitted, uses the first OutJob found in the focused project. |
Execute a specific output container from an OutJob file.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| container_name | string | yes | Name of the output container to execute |
| outjob_path | string | no | Path to the .OutJob file. If omitted, uses the first OutJob found in the focused project. |
| fresh_window_seconds | number | no | files modified up to this many seconds before the run started still count as written, for file systems with coarse timestamps. Default 5s. |
| fab | string | no | — |
| fab_tier | string | no | — |
| outer_oz | number | no | — |
| fab_limits | object | no | with fab "custom", the user's own figures in mils (min_track, min_gap, min_drill, min_annular_ring, min_hole_to_hole, min_mask_sliver, copper_to_edge; copper_layer_counts a list), for a fab with no da |
Run every container in an OutJob and report what each produced.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outjob_path | string | no | Path to the .OutJob. Omit to use the first one in the focused project. |
| include_files | boolean | no | List each container's files (default True). |
| fresh_window_seconds | number | no | Files modified up to this long before a container started still count as new. Default 5 s. |
| fab | string | no | — |
| fab_tier | string | no | — |
| outer_oz | number | no | — |
| fab_limits | object | no | — |
Generate a fabrication package from an OutJob (Gerbers, NC drill, IPC-356, pick-and-place, assembly, BOM) and report every file produced.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outjob_path | string | no | path to the .OutJob; omit to use the first one in the focused project. |
| include_step | boolean | no | also export a STEP 3D model of the active PCB. |
| include_dxf | boolean | no | also export a DXF of the active PCB. |
| fresh_window_seconds | number | no | files modified within this window before a container ran still count as newly produced. |
| fab | string | no | — |
| fab_tier | string | no | — |
| outer_oz | number | no | — |
| fab_limits | object | no | — |
List all project variants with their component overrides.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Get the currently active project variant.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Switch the active project variant, or back to the base design.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| variant_name | string | yes | The variant's name or description, or "[No Variations]" for the base design. |
| project_path | string | no | Optional project path. If None, uses active project. |
Write the variant fitted/not-fitted matrix to a CSV.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_path | string | no | Destination .csv. Defaults to `workspace/variant_matrix.csv`. |
| project_path | string | no | Optional project path. If None, uses the focused project. |
Export a PDF for every project variant.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| output_dir | string | no | Folder for the per-variant PDFs. Defaults to the workspace directory. |
| project_path | string | no | Optional project path. If None, uses the focused project. |
Create a new project variant.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Name for the new variant |
| description | string | no | Optional description |
| project_path | string | no | Optional project path. If None, uses active project. |
Set one part's entry in a project variant: fitted, not fitted, an alternate part, or no entry at all.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| variant | string | yes | The variant's name or description. |
| designator | string | yes | The part, e.g. "R12". |
| kind | string | yes | "fitted", "not_fitted", "alternate" or "remove". |
| alternate_part | string | no | For `alternate`: the alternate part's name, which Altium keeps as the part's varied Comment. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
| alternate_library | string | no | For `alternate`: the library the alternate comes from, e.g. "Miscellaneous Devices.IntLib". Without it Altium saves the entry but loads it back as fitted when the project is reopened. |
| alternate_lib_ref | string | no | The alternate's symbol in that library; defaults to `alternate_part`. |
| alternate_footprint | string | no | The alternate's footprint when it differs from the base part's. |
Set or clear the parameter values one part takes in a variant, e.g. R5's Value 4k7 in variant "Lite" while the base design has 10k.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| variant | string | yes | The variant's name or description. |
| designator | string | yes | The part, e.g. "R5". |
| parameters | object | yes | Parameter name to value, e.g. {"Value": "4k7", "Comment": "4k7"}; None clears it. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
Rename a project variant.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| variant | string | yes | The variant's current name or description. |
| new_name | string | yes | Its new name. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
Start a new variant from an existing variant's entries.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | The variant to copy, by name or description. |
| name | string | yes | The new variant's name (saved as its description, which Altium shows as the name); one already in use is refused. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
Read, or set, the colour the project gives a net.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net | string | yes | The net name. |
| color | string | no | "#RRGGBB", "none" to clear the project's colour for the net, or empty to only read. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
Show what gives each compiled net its name, and where.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| net | string | no | One net (any case). Empty lists every net. |
| named_only | boolean | no | Skip nets that nothing names. |
| limit | integer | no | The most nets to list (default 500); `truncated` says when more were left out. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
| structure | boolean | no | Add how each net is built, from the compiled model: `sub_wires, lines, all_items, removed_items, scope, signal_type, calculated_name, hidden_name, bus_width, `net_n |
Read, or change, the settings Altium's STEP exporter keeps.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| options | object | no | Settings to write, by name: `folded (bool), fold_rate (int), component_option, models_option, holes_option, copper_option (Altium's codes, read them first), `mechanical_pad_hol |
List the sheet instances of a multi-channel design, as compiled.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
The compiled sheet hierarchy: each sheet's `parents`,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | The .PrjPcb. Default: the focused project. |
Show where each part's models resolve, as Altium finds them.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
| designator | string | no | One part. Empty lists every part. |
| limit | integer | no | The most parts to list (default 300). |
Ask Altium's own library manager about a library or a part.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | `locate (where Altium finds component, in library or across the installed ones when it is empty), contents (the parts of the library at library`, a full path, with model counts, whet |
| library | string | no | A library name for locate, a full path otherwise. |
| component | string | no | The part, for locate. |
| destination | string | no | The folder for extract. |
| limit | integer | no | The most parts contents lists (default 500). |
Read the lines in Altium's Output panel, newest last.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| last | integer | no | — |
| clear | boolean | no | — |
List a file the project produced under its Generated documents.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | — |
| project_path | string | no | — |
Read, or change, a project's document order, library search
| Parameter | Type | Required | Notes |
|---|---|---|---|
| move_document | string | no | Full path of a document to move. |
| move_to_index | integer | no | Its new position, from 0 (with move_document). |
| add_search_path | string | no | A folder to add to the library search paths. |
| include_subfolders | boolean | no | Search below that folder too. |
| allow_port_net_names | boolean | no | Ports name nets. |
| allow_sheet_entry_net_names | boolean | no | Sheet entries name nets. |
| hierarchy_mode | string | no | The net identifier scope: automatic, flat, hierarchical, global or strict_hierarchical (or Altium's number 0 to 4, in that order). |
| output_path | string | no | The folder outputs are written to. |
| append_sheet_number_to_local_nets | boolean | no | Add the sheet number to the names of nets local to one sheet. |
| pin_swap_by_net_label | boolean | no | Pin swaps on the board may change net labels on the schematic. |
| pin_swap_by_pin | boolean | no | Pin swaps on the board may move pins on the schematic. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
Make a schematic library of every symbol placed in the project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| out_path | string | yes | Full path of the new .SchLib. |
| add_to_project | boolean | no | Add the library to the project. |
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
Make an integrated library of every part the project places.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | The .PrjPcb. Defaults to the focused project. |
The net classes, component classes, differential pairs and rooms the project's schematics declare, from the compiled project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | — |
Delete a project variant, with every component variation in it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| variant_name | string | yes | name of the variant to remove. |
| project_path | string | no | optional project path; defaults to the focused project. |
List all currently open projects in the Altium workspace.
Takes no parameters.
Get all messages from the Messages panel (compile errors, ERC violations, etc.).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Search for components across all project sheets.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| search_text | string | yes | Text to search for (e.g., "U1", "100nF", "LM317") |
| search_by | string | no | Property to search, "designator", "value", or "comment" (default "designator") |
| project_path | string | no | Optional project path. If None, uses active project. |
Get pin-to-net connectivity for a specific component.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component designator (e.g., "U1", "R8") |
| project_path | string | no | Optional project path. If None, uses active. |
| force_recompile | boolean | no | SaveAll + invalidate cache + recompile before reading. Use when you need a guaranteed-fresh netlist. |
Pin-net connectivity for MANY components in ONE round-trip.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designators | array | yes | List of component designators. |
| project_path | string | no | Optional project path. |
| force_recompile | boolean | no | SaveAll + invalidate cache + recompile before reading. Use when you need a guaranteed-fresh netlist. |
The project's ERC report level for every violation type (Project Options > Error Reporting): no_report, warning, error or fatal.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| match | string | no | only types whose description contains this text, e.g. "multiple names" or "driving source". |
| project_path | string | no | the .PrjPcb; default the focused project. |
Set ERC report levels (Project Options > Error Reporting).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| levels | object | yes | {violation type: level}. A type is its exact description as proj_get_erc_levels lists it ("Nets with multiple names") or its kind number; a level is no_report, warning, error or fatal. Example: {"Nets |
| project_path | string | no | the .PrjPcb; default the focused project. |
| save | boolean | no | save the project file afterwards so the setting persists. |
Flush all dirty docs, invalidate the compile cache, and recompile.
Takes no parameters.
Report the age of the cached netlist and which docs are dirty.
Takes no parameters.
Import a document into the focused project from an external path.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source_path | string | yes | Full path to the source document (SchDoc, PcbDoc, etc.) |
Get the full path of the currently focused project file.
Takes no parameters.
Set a document-level parameter on a specific schematic sheet.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file_path | string | yes | Full path to the schematic document (.SchDoc). Use Windows-style backslashes (e.g. C:\\path\\Sheet.SchDoc), not forward slashes. |
| name | string | yes | Parameter name |
| value | string | yes | Parameter value |
Compare schematic and PCB component counts.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Push schematic changes to the PCB (Design > Update PCB Document).
Takes no parameters.
Update the project's parts from their libraries: Tools > Update From Libraries (symbols, parameters, models) or Update From PCB Libraries (the board's footprints). Run as Altium's own process, so neither the menu nor the focus is touched.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | string | no | "schematic" or "pcb". |
| document_path | string | no | a sheet (schematic) or the board (pcb) of the project, focused first. Default: the document in front. |
Push PCB changes back to schematic (back-annotate ECO).
Takes no parameters.
Get detailed differences between schematic and PCB netlist.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Lock or unlock component designators to prevent re-annotation.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| designator | string | yes | Component designator (e.g., "U1", "R3") or "all" for all components |
| lock | boolean | no | True to lock, False to unlock (default True) |
Get project options: output path, hierarchy mode, compiler settings.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| project_path | string | no | Optional project path. If None, uses active project. |
Drive Tools > Update From Libraries, ECO included, from the GUI.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | string | no | "schematic" (Update From Libraries) or "pcb" (Update From PCB Libraries). |
| launch | string | no | "already_open" (default; attach to a wizard you opened) or "menu" (open it via the menu bar). |
| dry_run | boolean | no | Report what it would press, press nothing (default). |
| confirm_execute_eco | boolean | no | Must be True for a real run. |
| answer_confirmations | boolean | no | Answer routine "continue?" prompts, needed to finish; prompts about deleting or overwriting are never answered. |
| menu_may_steal_focus | boolean | no | Required for launch="menu", which brings Altium to the front and moves the pointer. |
| first_step_timeout | number | no | Seconds to wait for the first dialog. |
Read or change a checkbox, radio, field or list row in the open dialog, found by its label (e.g. `"Include Variants"`). Buttons are pressed by the dialog driver instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control_label | string | yes | the control's visible label. |
| checked | boolean | no | desired state for a checkbox. |
| text | string | no | desired contents for an edit field. |
| select_row | string | no | for a list, grid or tree, the row to select by name. |
| dialog_title | string | no | substring to pick one dialog when several are open. Empty uses the first. |
| list_only | boolean | no | change nothing, just report every control in the dialog with its role, state and whether it is enabled. |
Invoke ANY Altium menu command by clicking the real menu. Unlike `app_run_menu`, which can report success for commands it never ran, this either runs the command or says why not. A last resort:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| menu_path | string | yes | Pipe-separated path, top level first. |
| may_steal_focus | boolean | no | Required to click anything. |
| list_only | boolean | no | Only list the top-level menus on screen. |
| expect_dialog | string | no | Part of the title the command should open; `ok` then means that dialog appeared. |
What Altium has on screen, what it says, and if it is stuck.
Takes no parameters.
Press ONE named button in an open Altium dialog.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| button_caption | string | no | the visible caption. |
| dialog_title | string | no | substring picking one dialog when several are open. Empty uses the first. |
| allow_irreversible | boolean | no | permit a committing press. |
| button | string | no | the same as `button_caption`, the name clients reach for first. |
Answer dialogs reactively until none is left.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| intent | string | no | "proceed" to carry the operation forward, or "cancel" to back out of whatever is open. |
| allow_commit | boolean | no | permit the design-changing press. |
| allow_confirm | boolean | no | permit answering a confirmation. |
| dry_run | boolean | no | decide and report, press nothing. Default True. |
| wait_first | number | no | seconds to wait for the first dialog, since a caller fires a command and then drives. |
| budget | number | no | seconds before giving up on a wedged editor. |
Invoke a menu command and answer the dialogs it raises, in one call (a modal blocks the scripting engine, so the two cannot be separate bridge calls). Prefer an API tool when one exists.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| menu_path | string | yes | pipe-separated, for example "Tools|Annotation|Force Annotate All Schematics...". Discover paths with app_click_menu(list_only=True). |
| allow_commit | boolean | no | permit a design-changing press. |
| allow_confirm | boolean | no | permit answering confirmations. |
| dry_run | boolean | no | invoke the command but press nothing. |
| may_steal_focus | boolean | no | opening a menu needs real input. |
| wait_first | number | no | seconds to wait for the first dialog. |
| budget | number | no | seconds before giving up. |
| expect_dialog | string | no | part of the title of the dialog the command should open. When a different dialog (or none) appears, the reply fails at the menu stage and nothing is driven. |
Altium's dockable panels that are currently on screen.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| offered_too | boolean | no | also read what View > Panels lists, which is what COULD be opened rather than what is open. That needs a real menu click and steals focus, so it is off by default. |
Open a dockable panel by name, and confirm it appeared.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | the panel's name as View > Panels spells it, e.g. "Projects", "Messages", "PCB", "Properties". |
| settle | number | no | how long to allow for it to appear. |
Read what is inside an open panel.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
Choose an option in a combo box or drop list, and verify it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control_label | string | yes | the combo's label. |
| option | string | yes | the option to choose, matched by name. |
| dialog_title | string | no | which dialog, when several are open. |
| list_only | boolean | no | report the options and change nothing. |
Open or close a node in a tree, and verify the state changed.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control_label | string | yes | the tree's label. |
| node_name | string | yes | the node to open, matched by name. |
| expand | boolean | no | True to open, False to close. |
| dialog_title | string | no | which dialog, when several are open. |
Type into one cell of a grid, and read it back.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control_label | string | yes | the grid's label. |
| row | string | yes | the row, matched by name. |
| column | string | yes | the column name, or an index for unnamed cells. |
| text | string | yes | what to type. |
| dialog_title | string | no | which dialog, when several are open. |
| list_only | boolean | no | report the row's cells and change nothing; do it first to see the column names. |
Send a key sequence to whatever currently has focus.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | yes | — |
Type literal text into whatever has focus.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | — |
Right click at a point: read the context menu, or pick from it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | integer | yes | — |
| y | integer | yes | — |
| item | string | no | the entry to choose. Nested entries take a '|' path, matched by name at each level like the menu bar. |
| relative_to | string | no | "window" takes x, y as pixels of the main window, as app_screenshot pictures it. |
List toolbar buttons, or press one by name.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | — |
List a dialog's tab pages, or switch to one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | — |
| dialog_title | string | no | — |
Scroll a list, grid or tree so more of it comes into view.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control_label | string | yes | — |
| lines | integer | no | — |
| dialog_title | string | no | — |
Invoke a row, rather than merely selecting it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control_label | string | yes | — |
| row | string | yes | — |
| double | boolean | no | — |
| dialog_title | string | no | — |
Capture Altium, or one dialog, to a PNG.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | no | where to write the PNG. Defaults to the workspace directory, so the file is somewhere findable. |
| dialog_title | string | no | capture that dialog rather than the main window. |
Clear a crashed bridge script and restart the loop.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| force | boolean | no | restart even when Altium's title does not name the script project and the loop answers a ping. Without it a loop that does not answer, while no session's call is running, is restarted. |
Click or drag on the editor canvas, at screen coordinates.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | integer | yes | — |
| y | integer | yes | — |
| to_x | integer | no | — |
| to_y | integer | no | — |
| double | boolean | no | — |
| relative_to | string | no | — |
Block until a dialog appears, and report which one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| title | string | no | — |
| timeout | number | no | — |
Everything on screen, in one call: menus, panels, dialogs, toolbars.
Takes no parameters.
Read a window through UI Automation, which sees what MSAA cannot.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| dialog_title | string | no | — |
| with_text | boolean | no | — |
Press, set or expand an element through UI Automation patterns.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | the element's name or automation id. A Button of that name is preferred over a label carrying the same text. |
| dialog_title | string | no | which dialog. Empty uses the frontmost open dialog, or the main window when no dialog is open. |
| text | string | no | set this value instead of pressing. |
| expand | string | no | "true" or "false" to open or close a node instead. |
Find nets where the maximum and minimum track widths differ
Takes no parameters.
Find pairs of same-net tracks meeting at < 90° interior
Takes no parameters.
Find SCH component parameters containing obvious "I'll
Takes no parameters.
Find schematic power-port markers (GND, VCC, +3V3 etc.)
Takes no parameters.
Find schematic net labels whose location is NOT on any
Takes no parameters.
Find net labels that silently merge, short, or do nothing.
Takes no parameters.
Find schematic components with a VISIBLE supplier-PN
Takes no parameters.
Find placed components whose internal primitives are NOT
Takes no parameters.
Find board objects a search by area or a net's list misses.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| board_path | string | no | The board to check; the focused board when empty. |
| types | string | no | Comma-separated type names to check (track, arc, via, pad, fill, region, text, component_body, component, polygon); all of them when empty. |
| limit | integer | no | Most items to list. |
Find free-floating PCB text (eTextObject) that's mirrored
Takes no parameters.
Find PCB silkscreens where designators face BOTH 0 and 180
Takes no parameters.
Find schematic images that are NOT embedded -- they hold
Takes no parameters.
Find nets that have EXACTLY ONE pin AND at least one
Takes no parameters.
Find groups of ICs with the same (lib_ref, comment) but
Takes no parameters.
Find ICs (designator U*) with no fetchable datasheet URL in
Takes no parameters.
Find IC pins whose NAME looks like a power / ground pin but
Takes no parameters.
Find ICs whose power pins lack a nearby decoupling cap.
Takes no parameters.
Find IC pins with an empty / unset net (excluding pins
Takes no parameters.
Check that every placed component shows the parameters its class requires for a legible schematic and a procurable BOM.
Takes no parameters.
Check that schematic power-symbol orientations follow the standard convention so reviewers' eyes can scan the sheet quickly.
Takes no parameters.
Count tented vs untented via SURFACES on the active board and report the tented ratio.
Takes no parameters.
Find schematic ports that aren't actually connected to anything.
Takes no parameters.
Find PCB tracks / arcs with endpoints that are close to another same-net primitive but don't actually touch.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| tolerance_mils | number | no | Coord tolerance in mils. 0 = exact match required (rare, since router can place tracks on sub-mil grid). Defaults to 1 mil; bump to 5 or 10 to surface gross misalignments only. |
Find signal vias that have no nearby ground / power via for
| Parameter | Type | Required | Notes |
|---|---|---|---|
| radius_mils | number | no | How close a return via must be. Default 50. |
Find PCB pads / vias closer than `clearance_mils` to the
| Parameter | Type | Required | Notes |
|---|---|---|---|
| clearance_mils | number | no | Minimum gap to flag (default 25). |
Find PCB components whose origin sits outside the board outline.
Takes no parameters.
Find schematic components placed off the snap grid.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| grid_mils | number | no | Grid size to check against (default 100). Use 50 if your sheets are set to a half-step grid. |
Find pads / vias whose copper annular ring has been removed
Takes no parameters.
Find schematic components that share a designator across sheets.
Takes no parameters.
Find vias connected on only one layer (resonating stubs).
Takes no parameters.
Find schematic nets with port-direction mismatches across sheets.
Takes no parameters.
List components marked Not Fitted in the project's CURRENT variant.
Takes no parameters.
Find PCB polygon regions whose area is zero or unset.
Takes no parameters.
The symbol or footprint libraries (kind) the open project sees:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | no | — |
Add (action "add", with path) or remove (action "remove") a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | — |
| nickname | string | yes | — |
| kind | string | no | — |
| path | string | no | — |
| scope | string | no | — |
| description | string | no | — |
The symbols in a .kicad_sym library, or the footprints in a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| kind | string | no | — |
| filter | string | no | — |
One library symbol: properties, units, whether it is a power symbol, the symbol it extends, and every pin's number, name, type, unit, position (library mm, Y up), angle and length.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| name | string | yes | — |
One library footprint: description, tags, properties, attributes, every pad's number, type, shape, position, angle, size, drill and layers (mm from the footprint origin), graphic counts per layer, and its 3D model paths.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| name | string | yes | — |
Search every library the project sees for symbols or footprints (kind) whose name, description or keywords hold every word of query. Returns "Library:Name" ids ready for placing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | yes | — |
| kind | string | no | — |
| limit | integer | no | — |
Copy a symbol or footprint (kind) within a library or into another (to_library, an existing .kicad_sym or .pretty, by nickname or path), as new_name (default: the same name).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| library | string | yes | — |
| to_library | string | no | — |
| new_name | string | no | — |
| kind | string | no | — |
Delete symbols or footprints (kind) from a library. A symbol that others extend is refused.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | yes | — |
| library | string | yes | — |
| kind | string | no | — |
Rename a symbol or footprint (kind) in its library. Symbols that extend it follow. Placed copies in schematics and boards keep the old name until updated from the library.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| new_name | string | yes | — |
| library | string | yes | — |
| kind | string | no | — |
Set properties of library symbols. Each item: library, name, properties {name: value, or null to remove}: Value, Footprint, Datasheet, Description, ki_keywords, ki_fp_filters, or any field (MPN, Manufacturer: added hidden).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| library | string | no | — |
Add pins to a library symbol's unit. Each pin: number, name, type (input, output, bidirectional, passive, power_in, power_out, open_collector, no_connect...), x_mm, y_mm (its connection end, library coordinates, Y up), angle_deg (0 for a pin on the body's left, 180 on its right), length_mm, shape,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| name | string | yes | — |
| pins | array | yes | — |
| unit | integer | no | — |
Draw on a library symbol's unit (library mm, Y up). Each item:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| name | string | yes | — |
| items | array | yes | — |
| unit | integer | no | — |
Set a library footprint's description, tags, mounting (smd,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| name | string | yes | — |
| description | string | no | — |
| tags | string | no | — |
| mounting | string | no | — |
| add_models | array | no | — |
| remove_models | array | no | — |
Add pads and graphics to a library footprint (mm from its origin, Y down). Each item: kind pad (number, type smd/pth/npth, shape roundrect/rect/circle/oval, position_mm, size_mm, drill_mm,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| name | string | yes | — |
| items | array | yes | — |
Check a symbol or footprint library (kind) for common faults.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
| kind | string | no | — |
Read a schematic sheet from its file (default the root). kinds:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sheet | string | no | — |
| kinds | array | no | — |
Place library symbols on a sheet (default the root). Each item:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| lib_id | string | no | — |
| sheet | string | no | — |
Place power ports. Each item: name (the net: GND, +3V3), x_mm, y_mm (its pin), angle_deg, lib_id (default "power:<name>").
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| sheet | string | no | — |
Draw wires. Each item: points [[x_mm, y_mm], ...] (a polyline), bus (true for a bus). With junctions, one is added where a wire end lands mid-wire.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| junctions | boolean | no | — |
| sheet | string | no | — |
Place net labels. Each item: text (the net), x_mm, y_mm (on a wire end or pin), angle_deg, kind (local, global, hierarchical), shape (input, output, bidirectional, tri_state, passive), size_mm.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| kind | string | no | — |
| sheet | string | no | — |
Place junctions, no-connect flags or bus entries. Each item: x_mm, y_mm, kind (junction, no_connect, bus_entry); a bus entry takes size_mm [dx, dy] (default [2.54, 2.54]).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| kind | string | no | — |
| sheet | string | no | — |
Place notes and drawing. Each item: shape text (text, x_mm,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| sheet | string | no | — |
Add a hierarchical sheet: name, file (a .kicad_sch in the project folder, made empty when missing), position and size (mm), and pins [{name, shape (input, output, bidirectional, tri_state, passive), side (left, right), offset_mm (from the top)}]. Pins on the sheet symbol pair with hierarchical…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| file | string | yes | — |
| x_mm | number | yes | — |
| y_mm | number | yes | — |
| width_mm | number | no | — |
| height_mm | number | no | — |
| pins | array | no | — |
| sheet | string | no | — |
Change placed symbols, each named by reference (which_unit picks one unit of a multi-unit part) or uuid, with the changes beside it:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | — |
| sheet | string | no | — |
Delete schematic items by uuid (any item: symbol, wire, label, junction, sheet...) or symbols by reference, from one sheet file.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| uuids | array | no | — |
| references | array | no | — |
| sheet | string | no | — |
Number symbols across every sheet of the project (sheet: any of its files, default the open one). References ending "?" get the lowest free number for their prefix, ordered by position (order x:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reset | boolean | no | — |
| order | string | no | — |
| dry_run | boolean | no | — |
| sheet | string | no | — |
Set a sheet's paper size (A4, A3, A2, A1, A0, A, B, C, D, E, USLetter, USLegal) and title block: title, date, revision, company, comments {"1": "..."} for comments 1 to 9. Fields not given are kept.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| paper | string | no | — |
| title | string | no | — |
| date | string | no | — |
| revision | string | no | — |
| company | string | no | — |
| comments | object | no | — |
| sheet | string | no | — |
Characteristic impedance of a PCB trace (IPC-2141 / Wadell).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| geometry | string | yes | microstrip / microstrip_diff / stripline / stripline_diff. |
| width_mils | number | yes | trace width. |
| dielectric_height_mils | number | yes | for microstrip the height above the reference plane; for stripline the FULL thickness between the two planes. |
| dielectric_constant | number | no | er, 4.2 for common FR-4. |
| copper_oz | number | no | copper weight; 1 oz is 1.378 mils finished. |
| spacing_mils | number | no | edge-to-edge gap, required for the _diff geometries. |
Trace width (mils) to hit a target impedance for a geometry
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target_ohms | number | yes | — |
| geometry | string | yes | — |
| dielectric_height_mils | number | yes | — |
| dielectric_constant | number | no | — |
| copper_oz | number | no | — |
| spacing_mils | number | no | — |
Assess whether a net is electrically long for its edge rate and, if so, recommend a termination (series for point-to-point, Thevenin / parallel for a multi-load bus) with E24 values.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| length_mils | number | yes | routed length of the net. |
| rise_time_ns | number | yes | driver edge rate. |
| z0 | number | no | characteristic impedance in ohms. The Altium build spells this `z0_ohms`; either is accepted. |
| er | number | no | dielectric constant, spelled `dielectric_constant` on the Altium build; either is accepted. |
| geometry | string | no | `microstrip or stripline`. |
| driver_impedance | number | no | driver output impedance in ohms, also spelled `driver_impedance_ohms`. |
| vcc | number | no | supply rail, for Thevenin values. |
| width_mils | number | no | trace width, if the propagation delay is to be derived rather than assumed. |
| height_mils | number | no | dielectric height, also spelled `dielectric_height_mils`. |
| multi_load | boolean | no | true for a bus with several receivers. |
| z0_ohms | number | no | alias for `z0`. |
| dielectric_constant | number | no | alias for `er`. |
| driver_impedance_ohms | number | no | alias for `driver_impedance`. |
| dielectric_height_mils | number | no | alias for `height_mils`. |
Resolve the effective Er and a match tolerance from a skew budget (or match_fraction * rise_time_ns), then optionally report a group of net lengths against it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| dielectric_constant | number | no | — |
| geometry | string | no | — |
| width_mils | number | no | — |
| dielectric_height_mils | number | no | — |
| skew_budget_ps | number | no | — |
| rise_time_ns | number | no | — |
| match_fraction | number | no | — |
| lengths | object | no | — |
Size a thermal-via field for a target thermal resistance (given directly, or as power_w with a delta_t_c budget), or score an existing via_count. Fourier conduction, R = L/(k*A).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| drill_mm | number | yes | via drill diameter, in mm. |
| plating_um | number | yes | barrel plating thickness, in microns. |
| length_mm | number | no | conduction length, which for a via through the board is the board thickness. The Altium build spells this `board_thickness_mm`; either is accepted. |
| filled_copper | boolean | no | whether the barrels are copper filled. |
| power_w | number | no | power to remove, in watts. |
| delta_t_c | number | no | permitted temperature rise, in Celsius. |
| target_k_per_w | number | no | thermal resistance target, given directly. |
| via_count | integer | no | score this many vias instead of sizing a field. |
| board_thickness_mm | number | no | alias for `length_mm`. |
Minimum track width (mils) to carry a current at a temperature rise (IPC-2221), widened by `margin` and snapped to a 0.1 mil grid.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| current_a | number | no | the current to carry, in amps. The Altium build spells this `current_amps`; either is accepted. |
| copper_oz | number | no | copper weight in ounces. |
| delta_t_c | number | no | permitted temperature rise, in Celsius. |
| layer | string | no | `external or internal`. |
| margin | number | no | fractional widening applied to the IPC result. |
| length_mils | number | no | run length, for the voltage-drop figure. |
| current_amps | number | no | alias for `current_a`. |
Forward IPC-2221: the current a track of this width sustains at a given temperature rise.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| width_mils | number | yes | — |
| copper_oz | number | no | — |
| delta_t_c | number | no | — |
| layer | string | no | — |
Reactance of an inductor and/or capacitor at a frequency.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| frequency_hz | number | yes | — |
| inductance_h | number | no | — |
| capacitance_f | number | no | — |
Resonant frequency and characteristic impedance of an LC pair, in henries and farads. Exact.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| inductance_h | number | yes | — |
| capacitance_f | number | yes | — |
Wavelength and quarter wave at a frequency, and the electrical length of `length_mils in degrees. er_eff` is the effective
| Parameter | Type | Required | Notes |
|---|---|---|---|
| frequency_hz | number | yes | — |
| er_eff | number | no | — |
| length_mils | number | no | — |
The power network's target impedance: allowed ripple over the load's current step. The step is the device datasheet's to give;
| Parameter | Type | Required | Notes |
|---|---|---|---|
| supply_v | number | yes | — |
| ripple_pct | number | yes | — |
| transient_a | number | yes | — |
AWG size: diameter, area and kcmil for a gauge (-3 for 0000 up to 40), or the nearest gauge for a diameter. Exact (ASTM B258).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| awg | integer | no | — |
| diameter_mils | number | no | — |
Current that melts a copper conductor in `seconds`
| Parameter | Type | Required | Notes |
|---|---|---|---|
| seconds | number | yes | — |
| area_sq_mils | number | no | — |
| width_mils | number | no | — |
| copper_oz | number | no | — |
| ambient_c | number | no | — |
Loop inductance a via adds between two planes, with its return (ground via or plane capacitor) `return_spacing_mils` away, centre to centre (Johnson, 'Via Inductance II', within about 10 % of his measurements). Only the interplane part.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| plane_spacing_mils | number | yes | — |
| via_diameter_mils | number | yes | — |
| return_spacing_mils | number | yes | — |
DC inductance of a planar spiral: square, hexagonal, octagonal or circle (Mohan, Hershenson, Boyd, Lee, IEEE JSSC 1999), by the modified Wheeler and the current-sheet expressions. Give
| Parameter | Type | Required | Notes |
|---|---|---|---|
| turns | number | yes | — |
| outer_mils | number | yes | — |
| width_mils | number | no | — |
| spacing_mils | number | no | — |
| inner_mils | number | no | — |
| shape | string | no | — |
Smallest pad and inner-layer clearance a fab builds around a hole, from its published ring and hole-to-copper figures, each quoted (design_list_fab_vendors). `kind` is "via" or "pth"; a figure the fab does not publish is said so, not filled in.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vendor | string | yes | — |
| copper_layers | integer | yes | — |
| drill_mils | number | yes | — |
| kind | string | no | — |
| outer_oz | number | no | — |
| tier | string | no | — |
Decode an IPC-7351 footprint name into its package, in mm.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
Check that every footprint with an IPC-7351 name has the pads the name claims: the pin count and, for leaded packages, the pitch.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library_path | string | yes | The .PcbLib. |
| footprints | array | no | Just these; all of them by default. |
| limit | integer | no | The most footprints read. |
Check names against the company naming policy (naming.json in EDA_AGENT_POLICY_DIR); without one nothing is enforced.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | footprint, symbol or component. |
| names | array | no | The names to check; or library_path to take them from a .PcbLib (footprints) or .SchLib (symbols). |
| library_path | string | no | The library to take names from. |
Build a name from the naming policy's template for a kind and check it against the policy's pattern.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | footprint, symbol or component. |
| tokens | object | yes | Values for the template, e.g. {"mpn": "TPS62130RGTR", "manufacturer": "Texas Instruments"}; a manufacturer gives `mfr_short` from the policy's abbreviations. |
Check a pin table copied from a datasheet and turn it into symbol pins.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| table_csv | string | yes | The table. |
| package_pins | integer | no | The package's pin count, to catch a missing pin. |
Check the open design against one of the company's rules files.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| rules | string/object | no | — |
| project_path | string | no | — |
| data | object | no | — |
Read an Altium design-rules export (.RUL): one record per rule, with its fields as Altium wrote them (they differ by rule kind and version). Reads only the file; the open board's own rules come from pcb_get_design_rules.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | — |
Bring the active board's design rules to the policy's
| Parameter | Type | Required | Notes |
|---|---|---|---|
| apply | boolean | no | False (default) only reports what it would do. |
Bring a project's ERC levels to an ERC set in the policy
| Parameter | Type | Required | Notes |
|---|---|---|---|
| set_name | string | no | The named set; "" for erc_levels.json. |
| apply | boolean | no | False (default) only reports the differences. |
| project_path | string | no | The .PrjPcb. Default: the focused project. |
Run every part of the policy folder that can be applied: the board rules (needs a board open) and the ERC set (needs a project).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| apply | boolean | no | False (default) only reports. |
| erc_set | string | no | The ERC set's name; "" for erc_levels.json. |
| project_path | string | no | The .PrjPcb for the ERC set. |
Compare two DesignPlans: parts new, dropped or edited (library reference, value, footprint, maker, part number, sheet), nets new, dropped or rewired, and pins that changed net.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| before | string/object | yes | — |
| after | string/object | yes | — |
Download a datasheet PDF into the workspace and return its path.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| url | string | yes | the datasheet's http or https URL, ideally the manufacturer's own. |
| part_number | string | no | recorded in the sidecar, for the citation. |
List the pages of a datasheet PDF that mention given words.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | the PDF on disk (from datasheet_fetch, or a local file). |
| terms | array | no | words or phrases to find, case ignored. |
Render part of a datasheet page as a zoomed image, to read a drawing's small numbers.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| path | string | yes | the PDF on disk. |
| page | integer | yes | 1-based. |
| region | array | no | [left, top, right, bottom] as fractions of the page from its top left, e.g. [0.3, 0.2, 0.75, 0.6]; empty is the whole page. |
| dpi | integer | no | 72 to 800 (default 400). |
Set the land-pattern figure beside the lands a package builds, to compare them by eye before the footprint is drawn.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| package | yes | the PackageSpec as for lib_create_footprint_from_package. | |
| region | array | yes | the figure on its page, [left, top, right, bottom] as fractions of the page from its top left. |
| view | string | no | "top", or "bottom" when the figure is drawn from below (the lands are mirrored to match it). |
| dpi | integer | no | 72 to 800 (default 400). |
| names_page | integer | no | the ball map's page in the same PDF. |
| names_region | array | no | the ball map on that page, as `region`. |
| names_view | string | no | "top" or "bottom", the side the ball map is drawn from (default `view`). |
Check a package description for numbers that cannot be right.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| package | yes | the PackageSpec as an object or JSON text, the same schema lib_create_footprint_from_package takes. |
Draw the land pattern a package gives, to compare with its datasheet.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| package | yes | the PackageSpec as an object or JSON text. | |
| density | string | no | L, N or M (least, nominal, most). |
| path | string | no | where to write the SVG; default `<workspace>/renders/<name>_<density>.svg`. |
| png | boolean | no | also write a PNG beside it through the headless browser the board renders use, when one is installed. |
Fetch a whole design-review snapshot in ONE call: the compiled netlist and part data that are the BASIS of a review. Judge
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sections | array | no | Sections to include. Default: project_info, design_stats, components, nets, design_rules, unrouted, diff, messages, board_stats, fab_stats. Extras: "bom", "drc", "erc", "unconnected_pins", "project_op |
| include_bom | boolean | no | Add "bom" (default True; best source of MPNs). |
| run_drc | boolean | no | Run DRC too (slow, 30-90 s; default off). |
| run_erc | boolean | no | Run ERC too (default off). |
| force_recompile | boolean | no | Save, drop the compile cache and recompile first (~5-10 s) when the user has edited in Altium. |
Run every design-lint audit and return one report.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| run_drc | boolean | no | Also run Altium's DRC (off by default; it rewrites the .DRC report). |
| bad_connection_tolerance_mils | number | no | Tolerance for `find_bad_connections` (default 1.0). |
| checks | array | no | Run only these section names, e.g. `["find_floating_ports", "find_missing_decoupling"]; None runs all. Unknown names come back in _unknown_checks`. |
Return the datasheet-first discipline checklist for design review.
Takes no parameters.
Route the focused board with the in-house engine, as a job.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| expect_file | string | yes | Full path of the board; refused if another board is focused. |
| nets | array | no | Route only these nets (default: every net with 2+ pads). |
| use_planes | boolean | no | Use inner layers a pour covers as planes (default True). |
| diff_pairs | boolean | no | Route differential pairs (defined, else _P/_N, +/-, DP/DM names) first, coupled (default True). |
| plane_fanout | boolean | no | Dog-bone via for every plane-net surface pad first (default False; it cost completion). |
| pin_lanes | boolean | no | Keep 0.8 mm straight out of IC pins at 0.65 mm pitch or finer (default True). |
| bus_lanes | boolean | no | Route 3+ nets between the same two parts as nested lanes (default True). |
| gloss | boolean | no | Lay the routed tracks again as the shortest clean 45/90 runs, pad entries straight along a pad axis (default True); the board's own tracks are left as they are. |
| axis_entry | boolean | no | Reach surface pads only straight out of their centre along an axis, turning clear of the pad; an IC's long pin only through its ends. |
| neck_pads | boolean | no | Route a net at its rule width, narrowing only on the stub into a pad narrower than the track. |
| join_existing | boolean | no | Route only what the board's copper leaves apart; a net it joins whole is left alone. |
| exclude_layers | array | no | Copper layers no route may use (not one a net's surface pad is on). |
Write a finished `pcb_autoroute` job's tracks and vias to the board.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| job_id | string | yes | a `layout_route` job that has finished. |
| expect_file | string | yes | full path of the board the job routed. |
| checkpoint | boolean | no | take a checkpoint first (default True). |
| repour | boolean | no | repour the board's polygons afterwards when the job relied on them, as planes or as pours joining a net, or routed through their old poured copper (default True). A poured net's connections are not th |
Place the focused board's parts with the in-house placer, as a job.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| expect_file | string | yes | Full path of the board; refused if another is focused. |
| parts | array | no | Designators to move (default: all movable parts). |
| compact | boolean | no | Use only the room the parts need (small circuit on a big board; analytic only). |
| strategy | string | no | "blocks" (default: by sub-circuit, decoupling round each IC, repeated channels tiled, signal-flow order) or "analytic" (wirelength only). "blocks" falls back to "analytic" when its floorplan would pus |
Move the parts of a finished `pcb_autoplace` job on the board.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| job_id | string | yes | a `layout_place` job that has finished. |
| expect_file | string | yes | full path of the board the job placed. |
| checkpoint | boolean | no | take a checkpoint first (default True). |
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
No parameter schema on file.
- Every tool, no call limit
- No card, and mcprush charges nothing for it
- Source published under Apache-2.0
- Runs on your machine — nothing of it reaches our gateway
- Nothing to cap, because mcprush bills nothing
What counts against your monthly calls
| Tool | Unit | Calls used | Out of the allowance |
|---|
Nothing here is billable: mcprush charges nothing to install Eda Agent or to call it, at any volume.
Two independent axes, because powerful and malicious are different questions. The grade is threat only. The capability level is blast radius, and it is never a penalty on the grade — it is priced as one subtract-only term in the score, where you can see it.
| Term | Level | What it prices | Points |
|---|---|---|---|
| capability-exposure | high | capability blast radius (high) — client exposure if the model is manipulated | −6 |
| verification-discount | source | publisher verification (provenance) — cryptographic build provenance ties the artifact to its source | −0 |
| coverage-honesty | source | inspection depth (source) — how much of the target the scan could see | −0 |
What the scan could actually read
A grade is only as meaningful as its coverage, so the scanner publishes its own depth before it publishes its result.
Tools were statically extracted from the published source (200 recovered), not enumerated from a running server. Tool-poisoning, Unicode-smuggling, capability and toxic-flow analysis ran on this inferred surface, but a mis-parsed registration could be missed or mis-attributed, so tool-derived findings are capped below “confirmed”. To grade the real runtime surface, scan the running server: --command "npx -y <package>".
Tool recovery stopped early in src/eda_agent/tools/generic.py, src/eda_agent/tools/guidance.py, src/eda_agent/tools/ipc_batch.py and 16 more — the file registers more tools than the scanner reads in one file, so some may be missing from this surface.
40 of the 200 recovered tools are registered only when hasattr(mcp, "prompt") is false (src/eda_agent/tools/design.py:545) — typically when a key or option is configured. They are part of the server's surface and were analysed; a server started without that configuration exposes only the other 160.
Capability — what it could do if the model were manipulated
Tags derived from each tool’s schema and the implementation, not from what the tool calls itself. high is the level these add up to.
160 tools are registered unconditionally · 40 more only when hasattr(mcp, "prompt") is false (src/eda_agent/tools/design.py:545) — typically when a key or option is configured. All 200 are in the table below and were analysed; the conditional ones are marked.
| Tool | Capability tags | Why the tag was assigned |
|---|---|---|
| altium365_check_setup | no tags | |
| altium365_list_workspaces | no tags | |
| altium365_list_projects | no tags | |
| altium365_get_project | no tags | |
| altium365_list_library_folders | no tags | |
| altium365_list_components | no tags | |
| altium365_get_component | no tags | |
| altium365_read_object | no tags | |
| altium365_describe_type | no tags | |
| altium365_run_query | no tags | |
| altium365_publish_library_file | no tags | |
| altium365_release_component | no tags | |
| altium365_set_component_parameters | no tags | |
| tool_catalog | no tags | |
| tool_invoke | no tags | |
| app_find_menu_command | no tags | |
| app_get_status | no tags | |
| app_attach | no tags | |
| app_save_all | no tags | |
| app_save_document | no tags | |
| app_exit_active_command | no tags | |
| app_close_document | no tags | |
| app_checkpoint | no tags | |
| app_list_checkpoints | no tags | |
| app_restore_checkpoint | no tags | |
| app_detach | no tags | |
| app_get_report | no tags | |
| app_create_document | no tags | |
| app_document_owners | no tags | |
| app_claim_document | no tags | |
| app_list_documents | no tags | |
| app_diag_workspace | no tags | |
| app_get_active_document | no tags | |
| app_set_active_document | no tags | |
| app_get_version | no tags | |
| app_get_preferences | no tags | |
| app_autosave | no tags | |
| app_format_value | no tags | |
| app_run_menu | no tags | |
| app_set_intent | no tags | |
| app_get_clipboard | no tags | |
| app_context | no tags | |
| app_ping | no tags | |
| audit_find_inconsistent_track_widths | no tags | |
| audit_find_acute_angles | no tags | |
| audit_find_placeholder_values | no tags | |
| audit_find_orphan_power_objects | no tags | |
| audit_find_orphan_net_labels | no tags | |
| audit_find_net_label_conflicts | no tags | |
| audit_find_visible_supplier_pn | no tags | |
| audit_find_unlocked_component_primitives | no tags | |
| audit_find_stale_read_paths | no tags | |
| audit_find_mirrored_pcb_text | no tags | |
| audit_find_mixed_designator_rotation | no tags | |
| audit_find_non_embedded_images | no tags | |
| audit_find_single_pin_nets | no tags | |
| audit_find_mpn_inconsistencies | no tags | |
| audit_find_missing_datasheets | untrusted-input | untrusted-input: keyword "web_search" |
| audit_find_pin_net_name_mismatches | no tags | |
| audit_find_missing_decoupling | no tags | |
| audit_find_unconnected_ic_pins | no tags | |
| audit_component_param_visibility | no tags | |
| audit_power_port_orientation | no tags | |
| audit_tented_via_ratio | no tags | |
| audit_find_floating_ports | no tags | |
| audit_find_bad_connections | no tags | |
| audit_find_signal_vias_without_return | no tags | |
| audit_find_pads_near_board_edge | no tags | |
| audit_find_components_outside_board_outline | no tags | |
| audit_find_off_grid_components | no tags | |
| audit_find_removed_pad_shapes | no tags | |
| audit_find_designator_collisions | no tags | |
| audit_find_via_antennas | no tags | |
| audit_find_unmatched_ports | no tags | |
| audit_variant_not_fitted | no tags | |
| audit_find_invalid_regions | no tags | |
| pcb_calc_impedance | no tags | |
| pcb_calc_trace_width_for_impedance | no tags | |
| pcb_calc_termination | no tags | |
| pcb_calc_length_match | no tags | |
| pcb_calc_thermal_vias | no tags | |
| pcb_calc_trace_width_for_current | no tags | |
| pcb_calc_track_current_capacity | no tags | |
| pcb_calc_reactance | no tags | |
| pcb_calc_resonance | no tags | |
| pcb_calc_wavelength | no tags | |
| pcb_calc_pdn_target_impedance | no tags | |
| pcb_calc_wire_gauge | no tags | |
| pcb_calc_fusing_current | no tags | |
| pcb_calc_via_inductance | no tags | |
| pcb_calc_spiral_inductance | no tags | |
| pcb_calc_padstack | no tags | |
| footprint_read_ipc_name | no tags | |
| lib_verify_ipc_names | no tags | |
| lib_check_naming | no tags | |
| lib_make_name | no tags | |
| lib_read_pin_table | no tags | |
| design_check_company_rules | no tags | |
| design_read_rules_export | no tags | |
| pcb_apply_policy_rules | no tags | |
| proj_apply_policy_erc | no tags | |
| design_apply_policy | no tags | |
| design_compare_plans | no tags | |
| proj_convert_to_kicad | no tags | |
| design_get_discipline | no tags | |
| design_session_start | no tags | |
| design_session_log | no tags | |
| design_session_status | no tags | |
| design_session_resume | no tags | |
| design_next_action | no tags | |
| design_autonomy_guide | no tags | |
| design_session_report | no tags | |
| pcb_layout_audit | no tags | |
| design_job_start conditional | no tags | |
| design_job_status conditional | no tags | |
| design_job_result conditional | untrusted-input | untrusted-input: keyword "fetch" |
| design_snapshot_inventory conditional | no tags | |
| design_validate_plan | no tags | |
| design_list_circuit_blocks conditional | no tags | |
| design_add_circuit_block conditional | no tags | |
| design_add_part conditional | no tags | |
| design_connect_bus conditional | no tags | |
| design_compose_netlist conditional | no tags | |
| design_generate_bom conditional | no tags | |
| design_edit_plan conditional | no tags | |
| design_compute_component_value conditional | no tags | |
| design_describe_circuits conditional | no tags | |
| design_suggest_diff_pair_traces conditional | no tags | |
| design_review_file conditional | no tags | |
| design_solve_netlist_file conditional | no tags | |
| design_bom_file conditional | no tags | |
| design_find_loops conditional | no tags | |
| design_simulators conditional | no tags | |
| design_simulate_deck conditional | no tags | |
| design_simulate_loops conditional | no tags | |
| design_export_spice_deck conditional | no tags | |
| pcb_smart_drc conditional | no tags | |
| design_review_plan | no tags | |
| design_suggest_partition conditional | no tags | |
| design_plan_from_sheet conditional | no tags | |
| design_audit_schematic conditional | no tags | |
| design_validate conditional | no tags | |
| design_validate_requirement conditional | no tags | |
| design_load_fab_profile conditional | no tags | |
| design_list_fab_vendors conditional | no tags | |
| design_fab_vendor_profile conditional | no tags | |
| design_list_stackups conditional | no tags | |
| design_get_stackup conditional | no tags | |
| design_get_laminate conditional | no tags | |
| design_synthesize_rules conditional | no tags | |
| design_plan_hierarchy conditional | no tags | |
| design_apply_hierarchy conditional | no tags | |
| design_phase_gate conditional | no tags | |
| design_phase_answer conditional | no tags | |
| design_phase_standing conditional | no tags | |
| review_design | no tags | |
| get_board_info | no tags | |
| list_components | no tags | |
| run_drc | no tags | |
| run_erc | no tags | |
| list_nets | no tags | |
| datasheet_fetch | untrusted-input | untrusted-input: keyword "fetch" |
| datasheet_find_pages | no tags | |
| datasheet_view_page | no tags | |
| footprint_compare_drawing | no tags | |
| footprint_check_package | no tags | |
| footprint_render_package | no tags | |
| obj_query | no tags | |
| obj_explain_pin | no tags | |
| obj_modify | no tags | |
| obj_create | no tags | |
| obj_delete | no tags | |
| obj_get_font_spec | no tags | |
| obj_get_font_id | no tags | |
| obj_select | no tags | |
| obj_deselect_all | no tags | |
| obj_zoom | no tags | |
| sch_reload_document | no tags | |
| sch_place_comment | no tags | |
| sch_mirror_component | no tags | |
| sch_rename_designators | no tags | |
| obj_batch_modify | no tags | |
| obj_run_process | no tags | |
| proj_run_erc | no tags | |
| sch_set_components_parameters | no tags | |
| proj_get_erc_violations | no tags | |
| obj_highlight_net | no tags | |
| obj_crossref_net | no tags | |
| obj_clear_highlights | no tags | |
| proj_add_sheet | no tags | |
| proj_delete_sheet | no tags | |
| obj_switch_view | no tags | |
| obj_refresh_document | no tags | |
| proj_get_unconnected_pins | no tags | |
| sch_stub_pins | no tags | |
| sch_place_rectangle | no tags | |
| sch_place_line | no tags | |
| sch_place_note | no tags | |
| sch_place_sheet_symbol | no tags | |
| sch_autoposition_labels | no tags |
Toxic-flow graph
The lethal trifecta, checked as a graph rather than as a checklist: untrusted input, a sensitive source and an external sink have to meet before there is a path worth worrying about.
The public result for this release does not print the flow graph, so there is nothing to show here. That is not the same as "no paths were found": what the scan did read is above, under coverage.
Supply chain and provenance
This is the first scan of this surface here, so there is nothing yet to compare it against.
Every result on this tab comes from one deterministic pass over the published package — offline, rule by rule, and auditable line by line above. Same methodology version, same bytes, same score.
Release history
Always latest — the install command names no version, so it installs the newest release when it runs; the current release on file is 0.8.1. Pin a release below and the command asks for exactly that one.
No release note was published with this version.
One review per account, from a signed-in account that does not publish this listing. Nothing else is asked — you can say what you think before you install it. Publishers can reply once per review, and a review can be edited or deleted by whoever wrote it.
Any signed-in account that does not publish Eda Agent can review it, once — before installing it or after. A review from an account that has installed it is marked as one.
Nobody has reviewed this listing. The rating on the card is the mean of the reviews written here and nothing else, so there is no rating until somebody writes the first — which takes a signed-in account that does not publish it, and nothing else.