Tool reference

Auto-generated by scripts/gen_tool_reference.py from the live tool surface + tools/metadata.py. Do not edit by hand.

776 tools across 21 categories.

Maturity: offline = pure Python, CI-tested; simulator = runs against the simulator, no Altium needed; live_only = needs a running editor; being listed here is not evidence that it has been run against one.

Interaction: modal = ⚠ opens a blocking Altium dialog (needs a human click); partial = ◑ leaves the job incomplete (needs a follow-up tool); readonly = read-only; silent = mutates, no dialog.

core (6)

Tool	Interaction	Maturity	Summary
get_board_info	readonly	live_only	Object counts and net-class summary for the open board, from the
list_components	readonly	live_only	Every component on the open board (reference, value, footprint,
list_nets	readonly	live_only	Every net on the open board with pin count and class (power / ground
review_design	silent	live_only	EDA-agnostic design review of the open board.
run_drc	silent	live_only	Run geometric design-rule check (DRC) on the open board.
run_erc	silent	live_only	Run the schematic Electrical Rules Check (ERC) on the open design.

meta (3)

Tool	Interaction	Maturity	Summary
tool_catalog	readonly	offline	Discover tools by category / maturity / interaction without
tool_guide	readonly	offline	How to do something correctly, and what is genuinely impossible.
tool_invoke	readonly	offline	Invoke any registered tool by name: the companion to

parts (2)

Tool	Interaction	Maturity	Summary
part_fetch	silent	offline	Fetch one part's detail, by the ref a search returned.
part_search	readonly	offline	Search EVERY enabled part provider and merge the results.

application (47)

Tool	Interaction	Maturity	Summary
app_activate_row	silent	live_only	Invoke a row, rather than merely selecting it.
app_attach	silent	live_only	Connect to a running Altium Designer instance.
app_canvas	silent	live_only	Click or drag on the editor canvas, at screen coordinates.
app_checkpoint	silent	live_only	Snapshot the focused project so the session is revertible.
app_click_menu	silent	live_only	Invoke ANY Altium menu command by path, by driving the menu.
app_context	silent	simulator	Where you are, in one call. Run this before anything else.
app_context_menu	silent	live_only	Right click at a point: read the context menu, or pick from it.
app_create_document	silent	live_only	Create a new blank document of a given kind and save it to disk.
app_detach	silent	simulator	Stop the Altium MCP polling loop. CALL THIS WHEN YOU'RE FINISHED.
app_diag_workspace	silent	live_only	Diagnostic: enumerate workspace files via Altium's FindFiles helper.
app_dialog_tab	silent	live_only	List a dialog's tab pages, or switch to one.
app_drive_dialogs	silent	live_only	Answer dialogs reactively until none is left.
app_exit_active_command	silent	live_only	Close a transaction a crashed handler left open in Altium.
app_expand_tree_node	silent	live_only	Open or close a node in a tree, and verify the state changed.
app_get_active_document	readonly	simulator	Get information about the currently active (focused) document.
app_get_clipboard	readonly	live_only	Get text content from the Windows clipboard.
app_get_preferences	readonly	live_only	Get key Altium Designer preferences.
app_get_report	readonly	live_only	Report the health of the MCP bridge, workspace, and Altium link.
app_get_status	readonly	live_only	Check if Altium Designer is running and get status information.
app_get_version	readonly	simulator	Get the version of Altium Designer.
app_invoke_element	silent	live_only	Press, set or expand an element through UI Automation patterns.
app_list_checkpoints	readonly	live_only	List saved checkpoints for the current workspace, newest first.
app_list_documents	readonly	simulator	List all documents known to the current Altium workspace.
app_list_open_dialogs	readonly	live_only	What Altium has on screen, what it says, and if it is stuck.
app_list_panels	readonly	live_only	Altium's dockable panels that are currently on screen.
app_open_panel	silent	live_only	Open a dockable panel by name, and confirm it appeared.
app_ping	silent	live_only	Test if the Altium script is responding and report script version.
app_press_dialog_button	silent	live_only	Press ONE named button in an open Altium dialog.
app_read_panel	silent	live_only	Read what is inside an open panel.
app_read_window	silent	live_only	Read a window through UI Automation, which sees what MSAA cannot.
app_restore_checkpoint	silent	live_only	Restore the focused project's files from a checkpoint.
app_run_menu	silent	live_only	Dispatch a menu command by path. DISPATCH IS NOT EXECUTION.
app_run_ui_command	silent	live_only	Invoke a menu command AND answer the dialogs it raises.
app_save_all	silent	live_only	Flush every dirty Altium document to disk.
app_screenshot	silent	live_only	Capture Altium, or one dialog, to a PNG.
app_scroll_control	silent	live_only	Scroll a list, grid or tree so more of it comes into view.
app_send_keys	silent	live_only	Send a key sequence to whatever currently has focus.
app_set_active_document	silent	simulator	Set a specific document as the active (focused) document.
app_set_dialog_control	silent	live_only	Read or CHANGE a control inside whatever dialog is open.
app_set_dropdown	silent	live_only	Choose an option in a combo box or drop list, and verify it.
app_set_grid_cell	silent	live_only	Type into one cell of a grid, and read it back.
app_set_intent	silent	live_only	Tell the dashboard what high-level task the agent is working on.
app_toolbar	silent	live_only	List toolbar buttons, or press one by name.
app_type_text	silent	live_only	Type literal text into whatever has focus.
app_ui_snapshot	readonly	live_only	Everything on screen, in one call: menus, panels, dialogs, toolbars.
app_update_from_libraries	modal	live_only	Drive Tools > Update From Libraries, ECO included.
app_wait_for_dialog	silent	live_only	Block until a dialog appears, and report which one.

project (61)

Tool	Interaction	Maturity	Summary
proj_add_document	silent	simulator	Add an existing document to a project.
proj_add_sheet	silent	live_only	Create a new schematic sheet and add it to the focused project.
proj_annotate	silent	simulator	Annotate schematic designators programmatically, no dialog, no user interaction.
proj_close	modal	simulator	Close a project.
proj_compare_sch_pcb	readonly	live_only	Compare schematic and PCB component counts.
proj_compile	silent	simulator	Compile a project to check for errors.
proj_create	silent	simulator	Create a new Altium project.
proj_create_variant	silent	live_only	Create a new project variant.
proj_cross_probe	silent	simulator	Jump to and highlight a component in the schematic or PCB.
proj_delete_sheet	silent	live_only	Remove a schematic sheet from the focused project.
proj_delete_variant	silent	live_only	Delete a project variant, with every component variation in it.
proj_export_bom_html	silent	simulator	Export the project BOM as a self-contained interactive HTML file.
proj_export_dxf	silent	live_only	Export the active PCB to DXF (AutoCAD) format.
proj_export_image	silent	live_only	Export the active schematic / PCB document, silent (no dialog).
proj_export_netlist	silent	simulator	Write the compiled connectivity to a flat netlist file.
proj_export_pdf	modal	simulator	Export the active document to PDF.
proj_export_step	silent	live_only	Export the active PCB to a STEP 3D model file.
proj_export_variant_matrix_csv	silent	live_only	Write the variant fitted/not-fitted matrix to a CSV.
proj_find_component	readonly	live_only	Search for components across all project sheets.
proj_force_recompile	silent	live_only	Flush all dirty docs, invalidate the compile cache, and recompile.
proj_generate_fab_package	silent	live_only	Generate a fabrication package from an OutJob (Gerbers, NC drill,
proj_get_active_variant	readonly	live_only	Get the currently active project variant.
proj_get_board_info	readonly	simulator	Get PCB board information, outline vertices, layer stack, origin.
proj_get_bom	readonly	simulator	Export a full BOM from the compiled project.
proj_get_compile_freshness	readonly	live_only	Report the age of the cached netlist and which docs are dirty.
proj_get_component_info	readonly	simulator	Get full information about a single component.
proj_get_component_info_many	readonly	live_only	Full per-component info for MANY designators in ONE round-trip.
proj_get_connectivity	readonly	live_only	Get pin-to-net connectivity for a specific component.
proj_get_connectivity_many	readonly	live_only	Pin-net connectivity for MANY components in ONE round-trip.
proj_get_differences	readonly	live_only	Get detailed differences between schematic and PCB netlist.
proj_get_erc_violations	readonly	live_only	Return the ERC violation list produced by the last
proj_get_focused	readonly	simulator	Get information about the currently focused project.
proj_get_messages	readonly	live_only	Get all messages from the Messages panel (compile errors, ERC violations, etc.).
proj_get_nets	readonly	simulator	Get net-to-pin connectivity from the compiled project netlist.
proj_get_options	readonly	live_only	Get project options: output path, hierarchy mode, compiler settings.
proj_get_parameters	readonly	simulator	Get all parameters defined at the project level.
proj_get_path	readonly	live_only	Get the full path of the currently focused project file.
proj_get_stats	readonly	simulator	Get design statistics from the compiled project.
proj_get_unconnected_pins	readonly	live_only	Find unconnected/floating pins in the focused project.
proj_import_document	silent	live_only	Import a document into the focused project from an external path.
proj_list_documents	readonly	simulator	List all documents in a project.
proj_list_open	readonly	live_only	List all currently open projects in the Altium workspace.
proj_list_outjob_containers	readonly	live_only	List all output containers defined in an OutJob file.
proj_list_variants	readonly	live_only	List all project variants with their component overrides.
proj_load_sheets	silent	live_only	Load every schematic sheet of a project into the Altium editor.
proj_lock_designator	silent	live_only	Lock or unlock component designators to prevent re-annotation.
proj_open	silent	simulator	Open an existing Altium project.
proj_print_all_variants	silent	live_only	Export a PDF for every project variant.
proj_push_parameters	silent	live_only	Copy all project-level parameters onto each loaded schematic sheet.
proj_remove_document	modal	simulator	Remove a document from a project.
proj_replace_component	silent	live_only	Replace a component with a different library part.
proj_run_erc	silent	live_only	Run Electrical Rules Check on the focused project.
proj_run_outjob	silent	live_only	Execute a specific output container from an OutJob file.
proj_run_outjob_all	silent	live_only	Run every container in an OutJob and report what each produced.
proj_run_output	modal	simulator	Generate manufacturing output files from the active PCB.
proj_save	silent	simulator	Save the current or specified project.
proj_set_active_variant	silent	live_only	Switch the active project variant.
proj_set_document_parameter	silent	live_only	Set a document-level parameter on a specific schematic sheet.
proj_set_parameter	silent	simulator	Set a project-level parameter.
proj_sync_pcb	modal	live_only	Push schematic changes to PCB (ECO): Design ▸ Update PCB Document.
proj_sync_schematic	modal	live_only	Push PCB changes back to schematic (back-annotate ECO). Attempts silent execution.

library (71)

Tool	Interaction	Maturity	Summary
lib_add_footprint_arc	silent	simulator	Add an arc to the current footprint.
lib_add_footprint_pad	silent	simulator	Add a pad to the current footprint.
lib_add_footprint_pads	silent	simulator	Add MANY pads to the current footprint in ONE call.
lib_add_footprint_text	silent	live_only	Add a text primitive to a PcbLib footprint.
lib_add_footprint_track	silent	simulator	Add a track to the current footprint (for silkscreen/courtyard).
lib_add_footprint_tracks	silent	simulator	Add MANY tracks to the current footprint in ONE call.
lib_add_pins	silent	simulator	Add MANY pins to the current symbol in ONE call.
lib_add_symbol_arc	silent	live_only	Add an arc to the current library symbol.
lib_add_symbol_lines	silent	live_only	Add MANY lines to the current symbol body in ONE call.
lib_add_symbol_polygon	silent	live_only	Add a polygon (filled shape) to the current library symbol.
lib_add_symbol_rectangle	silent	simulator	Add a rectangle to the current symbol body.
lib_add_symbol_text	silent	simulator	Add MANY body-text items to the current symbol in ONE call.
lib_audit_footprint_policies	silent	live_only	Sweep a PcbLib and flag footprints that break the library's own
lib_audit_footprint_vs_datasheet	silent	live_only	Audit a footprint against the manufacturer's land pattern.
lib_audit_styles	silent	live_only	Bulk visual-style audit across every component in a library.
lib_auto_link_3d_models	silent	live_only	Batch-link STEP models to footprints by matching file names.
lib_batch_rename	silent	simulator	Batch rename components in a schematic library.
lib_batch_set_params	silent	simulator	Batch set parameters on library components.
lib_clear_source_library	silent	live_only	Unpin a SchLib's symbols from their source-library provenance.
lib_convert_designators_to_stroke	silent	live_only	Convert every TrueType .Designator in a PcbLib to a stroke font.
lib_copy_component	silent	live_only	Copy a component WITHIN or BETWEEN schematic libraries.
lib_copy_footprint	silent	live_only	Copy one footprint (all pads/primitives) into a PcbLib, optionally renaming.
lib_create_footprint	silent	simulator	Create a new PCB footprint in the active library.
lib_create_ic_symbol	silent	simulator	Create a COMPLETE, discipline-compliant IC symbol in ONE call.
lib_create_passive_symbol	silent	live_only	Create a standard 2-pin PASSIVE symbol in ONE call.
lib_create_standard_footprint	silent	simulator	Create a COMPLETE standard footprint in ONE call.
lib_create_symbol	silent	simulator	Create a new schematic symbol in the active library.
lib_delete_component	silent	live_only	Delete one symbol from a schematic library (.SchLib).
lib_delete_footprint	silent	live_only	Delete one footprint from a PCB library (.PcbLib).
lib_delete_footprint_primitives	silent	live_only	Delete primitives inside ONE footprint of a PCB library.
lib_diff_libraries	readonly	simulator	Compare two schematic libraries and report differences.
lib_easyeda_import	silent	live_only	Convert an EasyEDA / LCSC part to KiCad files or an Altium plan.
lib_easyeda_search	readonly	live_only	Search LCSC / EasyEDA for parts by MPN or description.
lib_export_kicad_footprint	silent	live_only	Export a PcbLib footprint to a KiCad .kicad_mod file.
lib_export_kicad_symbol	silent	live_only	Export a SchLib symbol to a KiCad .kicad_sym file.
lib_extract_cse_zip	silent	live_only	Extract a Component Search Engine zip and build its install plan.
lib_extract_intlib	silent	live_only	Extract .SchLib + .PcbLib sources from an .IntLib.
lib_fix_designators	silent	live_only	Bring every footprint's .Designator onto the library's OWN
lib_get_component_details	readonly	simulator	Get full inspection of one library component in a single call.
lib_get_components	readonly	simulator	Get all components in a library.
lib_get_footprints	readonly	live_only	Enumerate every footprint in a PcbLib.
lib_get_installed_libraries	readonly	live_only	List the libraries installed in the Altium environment.
lib_get_pad_geometry	readonly	live_only	Full-precision pad geometry of one PcbLib footprint, in mm.
lib_get_pin_list	readonly	live_only	Get all pins of a library component.
lib_inspect_cse_zip	silent	live_only	Identify the library members of a Component Search Engine zip.
lib_install_library	silent	live_only	Register a library with the environment's Available Libraries.
lib_kicad_import	silent	live_only	Convert a KiCad .kicad_sym / .kicad_mod into an Altium plan.
lib_link_3d_model	silent	simulator	Link a 3D STEP model to a PcbLib footprint.
lib_link_footprint	silent	simulator	Link a footprint to a schematic component.
lib_move_components	silent	live_only	Move matching components (symbol + params + models) between SchLibs.
lib_move_footprints	silent	live_only	Move matching footprints between PcbLibs (the PcbLib analog of move).
lib_normalize_implementations	silent	live_only	Clean up every component's models in a SchLib for a self-contained package.
lib_probe_designator	silent	live_only	Diagnostic: dump one footprint's raw designator geometry.
lib_probe_footprint	silent	live_only	Read-only dump of a PcbLib footprint's name-bearing fields.
lib_reload_library	modal	live_only	Close and reopen a PcbLib so Altium rebuilds its caches from disk.
lib_remove_model	silent	live_only	Remove models (implementations) from a SchLib component by name.
lib_rename_component	silent	live_only	Rename one symbol's LibReference in a schematic library (.SchLib).
lib_rename_footprint	silent	live_only	Rename a footprint in a PCB library (.PcbLib).
lib_run_across	silent	live_only	Run one library command against several libraries in one call.
lib_search	readonly	simulator	Search open SchLib documents for components.
lib_set_component_description	silent	live_only	Set the description field on a library component.
lib_set_current_component	silent	live_only	Make a named component the editor's current selection in the
lib_set_footprint_height	silent	live_only	Set one footprint's Height directly, up or down.
lib_set_label_formats	silent	live_only	Multi-target label-style writer for SchLib symbols.
lib_set_mech_layers	silent	live_only	Name, enable and kind the mechanical layers of one library.
lib_set_model_name	silent	live_only	Set a model's model_name (footprint reference) on a SchLib symbol.
lib_set_model_source	silent	live_only	Write the datafile-link Location (source library) on a footprint model.
lib_set_pin_owner_part	silent	live_only	Reassign pins of a multi-part symbol to a sub-part, or to Part Zero.
lib_split_pin_functions	silent	live_only	Split slash-delimited pin names into pin function lists.
lib_uninstall_library	silent	live_only	Unregister a library from the environment's Available Libraries.
lib_update_footprint_heights_from_3d	silent	live_only	Sweep the active PCB Library: for every footprint, find the

schematic (37)

Tool	Interaction	Maturity	Summary
sch_add_datafile_link	silent	live_only	Attach a datafile link to a component's current implementation.
sch_add_directive	silent	live_only	Place a parameter-set directive at (x, y) on the active schematic.
sch_clear_source_library	silent	live_only	Unpin placed schematic components from a stale source library.
sch_generate_toc	silent	live_only	Place a table-of-contents note listing every schematic sheet.
sch_get_constraint_groups	readonly	live_only	Enumerate IDocument.DM_ConstraintGroups on the active schematic.
sch_get_directives	readonly	live_only	Enumerate parameter-set directives on the active schematic sheet.
sch_get_sheet_parameters	readonly	live_only	Get title block parameters (title, revision, date, etc.) from a schematic sheet.
sch_increment_designators	silent	live_only	Offset the trailing number of schematic designators by a delta.
sch_place_bus	silent	live_only	Place a bus segment between two XY coordinates on the active schematic.
sch_place_bus_entry	silent	live_only	Place a bus entry (45 degree stub) connecting a wire to a bus.
sch_place_components	silent	live_only	Place MANY schematic components from libraries in ONE call.
sch_place_cross_sheet_connector	silent	live_only	Place a cross-sheet connector (off-sheet port) on the active sheet.
sch_place_harness_connector	silent	live_only	Place a harness connector on the active schematic sheet.
sch_place_image	silent	live_only	Place an image/logo on the active schematic.
sch_place_junction	silent	live_only	Place a wire junction at coordinates on the active schematic.
sch_place_line	silent	live_only	Place a decorative line on the active schematic.
sch_place_net_label	silent	live_only	Place a net label at coordinates on the active schematic.
sch_place_no_erc	silent	live_only	Place a No-ERC marker at coordinates to suppress specific ERC violations.
sch_place_note	silent	live_only	Place a text-box note on the active schematic.
sch_place_port	silent	live_only	Place a port on the active schematic for inter-sheet connectivity.
sch_place_power_port	silent	live_only	Place a power port symbol (VCC, GND, etc.) on the active schematic.
sch_place_probe	silent	live_only	Place a probe/measurement marker on the active schematic.
sch_place_rectangle	silent	live_only	Place a rectangle shape on the active schematic (decorative only).
sch_place_sheet_entry	silent	live_only	Place a sheet entry port on an existing sheet symbol.
sch_place_sheet_symbol	silent	live_only	Place a sheet symbol linking to a child schematic document.
sch_place_text_frame	silent	live_only	Place a multi-line text frame (note block) on the active sheet.
sch_place_wires	silent	live_only	Place MANY wire segments on the active schematic in ONE call.
sch_render_svg	silent	live_only	Render the active SchDoc to an SVG file (in-house renderer).
sch_replicate_component	silent	live_only	Copy a placed schematic part and share the master's UniqueId.
sch_set_component_part_id	silent	live_only	Switch the active sub-part on a multi-part schematic component.
sch_set_component_unique_id	silent	live_only	Set UniqueId on every placed symbol with this designator.
sch_set_components_parameters	silent	live_only	Bulk-update parameters on PLACED schematic components.
sch_set_net_tie	silent	live_only	Mark a placed schematic component as a net tie.
sch_set_sheet_size	silent	live_only	Set the sheet size / template style of the active schematic.
sch_set_units	silent	live_only	Set the unit system for the active schematic.
sch_stub_pins	silent	live_only	Draw a short wire stub + net label on every unconnected schematic pin.
sch_toggle_pin_visibility	silent	live_only	Show or hide pin name / designator labels on schematic symbols.

generic (23)

Tool	Interaction	Maturity	Summary
obj_batch_create	silent	live_only	Create many schematic objects in ONE IPC round-trip.
obj_batch_delete	silent	live_only	Delete matching objects across many scope/type/filter operations.
obj_batch_modify	silent	live_only	Apply many filter+set operations in ONE IPC round-trip.
obj_clear_highlights	silent	live_only	Clear all net highlights in the active schematic or PCB document.
obj_copy	silent	live_only	Copy matching schematic objects to the clipboard.
obj_count	silent	live_only	Quick count of objects by type, faster than obj_query when you only need the count.
obj_create	silent	simulator	Create and place a schematic object.
obj_crossref_net	silent	live_only	Compare the schematic vs PCB membership of a named net.
obj_delete	silent	simulator	Find and delete schematic objects.
obj_deselect_all	silent	simulator	Clear all object selection on the active document.
obj_explain_pin	readonly	live_only	Explain WHY a schematic pin is on the net it is on.
obj_get_document_info	readonly	live_only	Get comprehensive info about the active document.
obj_get_font_id	readonly	simulator	Get or create a font ID for the given font properties.
obj_get_font_spec	readonly	simulator	Get font properties for a given font ID.
obj_highlight_net	silent	live_only	Highlight a net by name in the focused schematic or PCB document.
obj_modify	silent	simulator	Apply ONE set of property values to every object matching ONE filter.
obj_query	silent	simulator	Query schematic OR PCB objects and read their properties.
obj_refresh_document	silent	live_only	Force a redraw/refresh of the current document.
obj_run_process	silent	simulator	Run an Altium process command via the generic primitive layer.
obj_select	silent	simulator	Select objects matching a filter on the active document.
obj_set_grid	silent	live_only	Set the snap grid and/or visible grid size for the active schematic.
obj_switch_view	silent	live_only	Toggle between 2D and 3D view for PCB documents.
obj_zoom	silent	simulator	Control the viewport zoom level.

pcb (112)

Tool	Interaction	Maturity	Summary
pcb_add_layer	silent	live_only	Insert a copper layer into the PCB layer stack.
pcb_add_teardrops	modal	live_only	Add teardrops to pad/via-track junctions board-wide.
pcb_add_testpoints_for_net_class	silent	live_only	For each net in a netclass that does NOT already have a
pcb_align_components	silent	live_only	Align multiple PCB components along a common edge or center.
pcb_apply_dnp_paste_exclusion	silent	live_only	Suppress stencil paste on Not-Fitted (DNP) components.
pcb_audit_pad_center_connected	silent	live_only	Find pads whose center has no copper entering it (acid-pad check).
pcb_auto_size_board_outline	silent	live_only	Fit the board outline around the embedded-board array(s) plus a margin.
pcb_autoplace_silkscreen	silent	live_only	Reposition component designators to clear pads and other silk.
pcb_bevel_polygon_corners	silent	live_only	Chamfer the corners of a copper polygon pour.
pcb_bind_pad_nets	silent	simulator	Assign component pads to existing board nets, batch in ONE call.
pcb_build_from_project	silent	simulator	Build the PCB's net set and pad connectivity from the netlist.
pcb_calc_impedance	readonly	offline	Characteristic impedance of a PCB trace via IPC-2141 / Wadell
pcb_calc_length_match	readonly	offline	Length-match tolerance and serpentine compensation for a bus / pair.
pcb_calc_polygon_area	readonly	live_only	Report the area of each copper polygon on the active board.
pcb_calc_termination	readonly	offline	Decide if a net needs termination and size the resistor(s).
pcb_calc_thermal_vias	readonly	offline	Size a thermal-via field under a power pad (Fourier conduction).
pcb_calc_trace_width_for_current	readonly	offline	Minimum track WIDTH to carry a target current (inverse IPC-2221).
pcb_calc_trace_width_for_impedance	readonly	offline	Trace WIDTH to hit a target impedance (inverse of pcb_calc_impedance).
pcb_calc_track_current_capacity	readonly	offline	IPC-2221 current-carrying capacity for a PCB track.
pcb_check_placement_collision	silent	live_only	Dry-run check whether moving a component to (x, y[, rotation])
pcb_cleanup_tracks	silent	live_only	Tidy stray track geometry: delete slivers and/or merge collinear runs.
pcb_clear_source_footprint_library	silent	live_only	Clear Comp.SourceFootprintLibrary on board components.
pcb_copy_component_placement	silent	live_only	Clone placement from source components onto destination components.
pcb_copy_designators_to_mech	silent	live_only	Copy each component designator onto a mechanical layer (assembly prep).
pcb_copy_tracks_radial	silent	live_only	Array the selected tracks/arcs/vias radially about a center point.
pcb_create_design_rule	silent	live_only	Create a new design rule on the active PCB.
pcb_create_diff_pair	silent	live_only	Create a differential pair object from two existing nets.
pcb_create_net_class	silent	live_only	Create a net class (or add nets to an existing one) on the active PCB.
pcb_create_nets_from_list	silent	simulator	Create net objects on the active PCB for names not already there.
pcb_create_room	silent	live_only	Create a room for component grouping on the active PCB.
pcb_delete_design_rule	silent	live_only	Delete a design rule by name from the active PCB.
pcb_delete_invalid_objects	silent	live_only	Remove degenerate primitives from the active PCB.
pcb_delete_net	silent	live_only	Delete nets from the active PCB.
pcb_delete_object	silent	live_only	Delete a PCB object closest to specific coordinates on a layer.
pcb_distribute_components	silent	live_only	Evenly space components along an axis.
pcb_export_coordinates	silent	live_only	Export component placement coordinates formatted for pick-and-place (like pcb_get_components, but the pick-and-place shape: adds side, omits bbox detail).
pcb_export_stackup_csv	silent	live_only	Write the layer stackup to a conventional fab CSV report.
pcb_filter_variant_components	silent	live_only	Select a variant's components of one fitted-class on the board.
pcb_flip_component	silent	live_only	Flip a component to the other side of the board (top to bottom
pcb_focus_board	silent	live_only	Make a specific PCB the focused/current board.
pcb_get_board_outline	readonly	simulator	Get the board outline vertices and bounding rectangle.
pcb_get_board_statistics	readonly	simulator	Get comprehensive statistics for the active PCB board.
pcb_get_clearance_violations	readonly	live_only	Read the violations ALREADY on the board, optionally filtered
pcb_get_component_pads	readonly	live_only	Get all pads of a specific PCB component.
pcb_get_components	readonly	simulator	Get all components from the active PCB with position and properties.
pcb_get_design_rules	readonly	live_only	Get all design rules from the active PCB.
pcb_get_diff_pair_rules	readonly	live_only	Get all differential pair routing rules from PCB design rules.
pcb_get_differential_pairs	readonly	live_only	Enumerate every IPCB_DifferentialPair on the active PCB
pcb_get_fab_stats	readonly	live_only	DFM (Design For Manufacturing) summary -- the numbers fab
pcb_get_layer_display	readonly	live_only	Visibility and colour for every layer on the active board.
pcb_get_layer_stackup	readonly	live_only	Get the full PCB layer stackup information.
pcb_get_mech_layer_names	readonly	live_only	Every enabled mechanical layer on the board, and what is on it.
pcb_get_net_classes	readonly	live_only	Get all net classes from the active PCB.
pcb_get_nets	readonly	simulator	Get all unique net names from the active PCB board.
pcb_get_pad_properties	readonly	live_only	Get detailed pad information filtered by net or component.
pcb_get_polygons	readonly	live_only	Get all polygon pours on the active PCB with copper area.
pcb_get_room_rules	readonly	live_only	Get all room-like rules (confinement constraint design rules).
pcb_get_rule_properties	readonly	live_only	Read properties of a named PCB design rule.
pcb_get_selected_objects	readonly	live_only	Get properties of currently selected objects on the active PCB.
pcb_get_trace_lengths	readonly	live_only	Get total routed track length per net on the active PCB.
pcb_get_unrouted_nets	readonly	simulator	Get list of nets with unrouted connections (ratsnest lines).
pcb_get_vias	readonly	simulator	Get all vias on the active PCB board.
pcb_import_placement	silent	live_only	Position components from a coordinate list (pick-and-place import).
pcb_lock_net_routing	silent	live_only	Lock or unlock track / arc / via primitives on a list of nets.
pcb_make_paste_grid	silent	live_only	Split a single pad's solder-paste opening into a grid of
pcb_modify_layer	silent	live_only	Tune properties on an existing copper layer.
pcb_modify_polygon	silent	live_only	Modify a polygon pour's properties and its pour options.
pcb_move_components	silent	simulator	Move and/or rotate MANY PCB components in ONE IPC round-trip.
pcb_move_tracks_to_layer	silent	live_only	Move all tracks of a net to one layer, adding vias where needed.
pcb_normalize_vias	silent	live_only	Snap every via to its dominant routing-via-style rule.
pcb_panelize	silent	live_only	Build a production panel on the CURRENT (blank) PCB document.
pcb_place_3d_body	silent	live_only	Place a STEP model directly on the open PCB, as a free 3D body.
pcb_place_angular_dimension	silent	live_only	Place an angular dimension (angle between two reference directions).
pcb_place_arc	silent	live_only	Place an arc on the active PCB.
pcb_place_components	partial	simulator	Place one or many footprints from PcbLibs onto the board in ONE call.
pcb_place_dimension	silent	live_only	Place a linear dimension between two points.
pcb_place_embedded_board	silent	live_only	Place an embedded-board array (panel) referencing a child PCB.
pcb_place_fill	silent	live_only	Place a rectangular copper fill on the active PCB.
pcb_place_pad	silent	live_only	Place a standalone pad on the active PCB.
pcb_place_polygon_rect	silent	live_only	Drop a copper polygon pour on a rectangular area.
pcb_place_radial_dimension	silent	live_only	Place a radial dimension around a center point with a given radius.
pcb_place_region	silent	live_only	Place a solid copper region on a rectangular area.
pcb_place_stitching_vias	silent	live_only	Place a grid of stitching vias on a named net within a rectangle.
pcb_place_text	silent	live_only	Place a text string on the active PCB.
pcb_place_thieving_pads	silent	live_only	Fill bare copper area with a grid of isolated thieving pads.
pcb_place_tracks	silent	simulator	Place many track segments on the active PCB in ONE IPC round-trip.
pcb_place_via	silent	simulator	Place a via at specific coordinates on the active PCB.
pcb_place_via_array	silent	live_only	Stitch vias in a regular grid across a rectangle.
pcb_plan_placement	silent	live_only	Connectivity-driven auto-placement: shorten wirelength, keep
pcb_remove_layer	silent	live_only	Remove a copper layer from the PCB layer stack.
pcb_remove_teardrops	modal	live_only	Remove teardrops board-wide.
pcb_render_svg	silent	live_only	Render the active PcbDoc to an SVG file (in-house renderer).
pcb_renumber_pads	silent	live_only	Renumber the current PcbLib footprint's pads in spatial order.
pcb_replicate_layout	silent	live_only	Replicate a routed channel's ROUTING onto a matching channel.
pcb_repour_polygons	silent	live_only	Repour all polygon pours on the active PCB.
pcb_run_drc	modal	simulator	Run Design Rule Check (DRC) on the active PCB. MODAL --
pcb_scale	silent	live_only	Scale the selected free primitives by a ratio about an anchor.
pcb_set_board_shape	silent	live_only	Define the physical PCB board outline as a rectangle.
pcb_set_layer_color	silent	live_only	Recolour one layer.
pcb_set_layer_visibility	silent	live_only	Show or hide a specific PCB layer.
pcb_set_mech_layer_kind	silent	live_only	Set what a mechanical layer is FOR, not what it is called.
pcb_set_mech_layers	silent	live_only	Name, enable and kind the mechanical layers of the open BOARD.
pcb_set_plane_net	silent	live_only	Tie an internal plane layer to a net.
pcb_set_rule_properties	silent	live_only	Update metadata AND constraint values of a named PCB design rule.
pcb_set_rules_enabled	silent	live_only	Bulk-toggle the DRC-enabled flag on design rules by name.
pcb_set_text_visibility	silent	live_only	Bulk-toggle component designator and / or comment visibility.
pcb_set_track_width	silent	live_only	Modify track width for all tracks on a specific net.
pcb_set_via_soldermask_relief	silent	live_only	Open soldermask over via barrels (barrel relief).
pcb_snap_to_grid	silent	live_only	Snap a component to the nearest grid point.
pcb_start_polygon_placement	partial	live_only	Start INTERACTIVE polygon pour placement on the active PCB.
pcb_trim_extend_track	silent	live_only	Trim or extend one track endpoint along the track's own slope.
pcb_tune_length	silent	live_only	Add approximate routed length to a net with a square serpentine.

audit (32)

Tool	Interaction	Maturity	Summary
audit_component_param_visibility	readonly	live_only	Check that every placed component shows the parameters its class
audit_find_acute_angles	readonly	live_only	Find pairs of same-net tracks meeting at < 90° interior
audit_find_bad_connections	readonly	live_only	Find PCB tracks / arcs with endpoints that are close to another
audit_find_components_outside_board_outline	readonly	live_only	Find PCB components whose origin sits outside the board outline.
audit_find_designator_collisions	readonly	live_only	Find schematic components that share a designator across sheets.
audit_find_floating_ports	readonly	live_only	Find schematic ports that aren't actually connected to anything.
audit_find_inconsistent_track_widths	readonly	live_only	Find nets where the maximum and minimum track widths differ
audit_find_invalid_regions	readonly	live_only	Find PCB polygon regions whose area is zero or unset.
audit_find_mirrored_pcb_text	readonly	live_only	Find free-floating PCB text (eTextObject) that's mirrored
audit_find_missing_datasheets	readonly	live_only	Find ICs (designator U*) with no fetchable datasheet URL in
audit_find_missing_decoupling	readonly	simulator	Find ICs whose power pins lack a nearby decoupling cap.
audit_find_mixed_designator_rotation	readonly	live_only	Find PCB silkscreens where designators face BOTH 0 and 180
audit_find_mpn_inconsistencies	readonly	live_only	Find groups of ICs with the same (lib_ref, comment) but
audit_find_net_label_conflicts	readonly	live_only	Find net labels that silently merge, short, or do nothing.
audit_find_non_embedded_images	readonly	live_only	Find schematic images that are NOT embedded -- they hold
audit_find_off_grid_components	readonly	live_only	Find schematic components placed off the snap grid.
audit_find_orphan_net_labels	readonly	live_only	Find schematic net labels whose location is NOT on any
audit_find_orphan_power_objects	readonly	live_only	Find schematic power-port markers (GND, VCC, +3V3 etc.)
audit_find_pads_near_board_edge	readonly	live_only	Find PCB pads / vias closer than clearance_mils to the
audit_find_pin_net_name_mismatches	readonly	simulator	Find IC pins whose NAME looks like a power / ground pin but
audit_find_placeholder_values	readonly	live_only	Find SCH component parameters containing obvious "I'll
audit_find_removed_pad_shapes	readonly	live_only	Find pads / vias whose copper annular ring has been removed
audit_find_signal_vias_without_return	readonly	live_only	Find signal vias that have no nearby ground / power via for
audit_find_single_pin_nets	readonly	live_only	Find nets that have EXACTLY ONE pin AND at least one
audit_find_unconnected_ic_pins	readonly	simulator	Find IC pins with an empty / unset net (excluding pins
audit_find_unlocked_component_primitives	readonly	live_only	Find placed components whose internal primitives are NOT
audit_find_unmatched_ports	readonly	live_only	Find schematic nets with port-direction mismatches across sheets.
audit_find_via_antennas	readonly	live_only	Find vias connected on only one layer (resonating stubs).
audit_find_visible_supplier_pn	readonly	live_only	Find schematic components with a VISIBLE supplier-PN
audit_power_port_orientation	readonly	live_only	Check that schematic power-symbol orientations follow the standard
audit_tented_via_ratio	readonly	live_only	Count tented vs untented via SURFACES on the active board and
audit_variant_not_fitted	readonly	live_only	List components marked Not Fitted in the project's CURRENT variant.

design (44)

Tool	Interaction	Maturity	Summary
design_add_circuit_block	readonly	offline	Fold a canonical circuit block into a DesignPlan in one call.
design_add_part	readonly	offline	Add one part and wire its pins to named nets, in one call.
design_apply_hierarchy	readonly	offline	Rewrite a DesignPlan onto the sheets a hierarchy proposes.
design_audit_schematic	silent	live_only	Structured visual/layout audit of the active schematic.
design_autonomy_guide	readonly	offline	The autonomous spec-to-board loop protocol, in one call.
design_bom_file	readonly	offline	Consolidated BOM from a .SchDoc/.PrjPcb on disk: OFF by default.
design_compose_netlist	readonly	offline	Apply many authoring operations to a plan in ONE call.
design_compute_component_value	readonly	offline	Compute a manufacturable component value, snapped to an E-series.
design_connect_bus	readonly	offline	Wire a parallel bus across two+ parts in one call.
design_datasheet_checklist	readonly	live_only	Return the datasheet-first discipline checklist for design review.
design_describe_circuits	readonly	offline	Report the electrical behaviour of each recognised sub-circuit.
design_edit_plan	readonly	offline	Edit an existing plan -- the MODIFY complement to the add tools.
design_execute_plan	silent	live_only	Instantiate a DesignPlan in Altium.
design_generate_bom	readonly	offline	Derive the bill of materials from a plan's parts in one call.
design_get_discipline	readonly	offline	Read the design discipline + DesignPlan JSON schema.
design_hints_from_sheet	silent	live_only	Current sheet positions, as placement_hints for a re-run.
design_job_result	readonly	offline	Fetch a finished job's result payload (None until it's done).
design_job_start	readonly	offline	Start a long engine run as a background job; returns its id.
design_job_status	readonly	offline	Status of a background job (or all jobs if job_id is blank).
design_layout_schematic	readonly	offline	Compute the schematic layout for a DesignPlan, as pure data.
design_learn_from_layout	silent	live_only	Capture your placement edits as training data.
design_lint_report	readonly	simulator	Run all design-lint checks and return a consolidated violation
design_list_circuit_blocks	readonly	offline	List the canonical circuit blocks and their parameter contracts.
design_load_fab_profile	readonly	offline	Validate a fab capability profile and echo the normalized form.
design_next_action	readonly	offline	Decide the single next action for an autonomous design run.
design_plan_from_sheet	silent	live_only	Read a DesignPlan back off a schematic, including one you did
design_plan_hierarchy	readonly	offline	Propose a multi-sheet hierarchy for a dense DesignPlan.
design_preview_plan	readonly	live_only	Render a DesignPlan to SVG without emitting to Altium.
design_review_file	readonly	offline	Offline FALLBACK review of a .SchDoc/.PrjPcb: OFF by default.
design_review_plan	readonly	offline	One-call offline pre-flight: bundle every plan-level analysis.
design_review_snapshot	readonly	live_only	Fetch a comprehensive design-review snapshot in ONE tool call.
design_session_log	readonly	offline	Append one event to a design-session journal.
design_session_resume	readonly	offline	Resume a design run: state plus a plain-language next-action hint.
design_session_start	readonly	offline	Open a durable design-session journal for an autonomous run.
design_session_status	readonly	offline	Read a design session's derived state (stage map, artifacts, ...).
design_snapshot_inventory	readonly	live_only	Open a list of SchLib files and return what components live in them.
design_solve_netlist_file	readonly	offline	Reconstruct a .SchDoc's netlist geometrically: OFF by default.
design_suggest_diff_pair_traces	readonly	offline	Recommend a controlled-impedance trace width for every differential
design_suggest_partition	readonly	offline	Suggest how to split a design into balanced functional groups.
design_synthesize_rules	readonly	offline	Synthesize PCB design rules + stackup ops from a fab profile.
design_validate	readonly	live_only	ERC + connectivity sanity report on the focused project.
design_validate_plan	readonly	offline	Validate a candidate DesignPlan JSON against the schema + cross-check.
design_validate_requirement	readonly	offline	Validate a structured DesignRequirement before planning starts.
design_visual_review	readonly	live_only	Render the active design and return it as a viewable image plus

simulation (4)

Tool	Interaction	Maturity	Summary
sim_attach_model	silent	live_only	Attach an external SPICE model file (.mdl / .ckt / .lib) to a component.
sim_attach_primitives	silent	live_only	Attach SPICE primitives to MANY components in ONE call.
sim_get_readiness	readonly	live_only	Audit every component on the active schematic for SPICE readiness.
sim_run	silent	live_only	Dispatch Altium's mixed-signal simulator on the active project.

routing (2)

Tool	Interaction	Maturity	Summary
route_plan	readonly	offline	Route the board offline (grid A*) and return placeable ops.
route_plan_repairs	readonly	offline	Turn a DRC violation payload into an ordered repair plan.

kicad (85)

Tool	Interaction	Maturity	Summary
kicad_add_arc	silent	live_only	Add a graphic arc through start, mid and end points (mm) on a layer,
kicad_add_circle	silent	live_only	Add a graphic circle at a centre (mm) with a radius (mm) on a
kicad_add_line	silent	live_only	Add a graphic line between two points (mm) on a layer (default
kicad_add_rectangle	silent	live_only	Add a graphic rectangle from top-left to bottom-right (mm) on a
kicad_add_text	silent	live_only	Add a text label at a position (mm) on a layer (default
kicad_add_track	silent	live_only	Add a copper track segment on a layer ("F.Cu", "B.Cu", "In1.Cu"),
kicad_add_via	silent	live_only	Add a through via at a position (mm) with pad diameter and drill
kicad_add_zone	silent	live_only	Add a copper zone (pour) on a layer, assigned to a net, with an
kicad_cli	silent	live_only	Run an arbitrary kicad-cli command -- an escape hatch for anything
kicad_compare_sch_pcb	readonly	live_only	Compare the schematic netlist against the open PCB and report
kicad_create_footprint	silent	live_only	Create a footprint (.kicad_mod) in a .pretty library from a list of
kicad_create_symbol	silent	live_only	Create a schematic symbol in a .kicad_sym library. Each pin:
kicad_delete_component	silent	live_only	Delete a component from the board.
kicad_export_3dpdf	silent	live_only	Export an interactive 3D PDF of the board.
kicad_export_bom	silent	live_only	Generate a Bill of Materials (CSV) from the schematic.
kicad_export_drill	silent	live_only	Generate Excellon drill files into a directory.
kicad_export_dxf	silent	live_only	Plot the given board layers to DXF (mechanical CAD) files.
kicad_export_footprint_svg	silent	live_only	Export a footprint (or a whole .pretty library) to SVG.
kicad_export_gerbers	silent	live_only	Plot Gerber files for every board layer into a directory.
kicad_export_glb	silent	live_only	Export the board as a GLB (binary glTF) 3D model.
kicad_export_ipc2581	silent	live_only	Export the board in IPC-2581 format.
kicad_export_ipcd356	silent	live_only	Generate an IPC-D-356 netlist (bare-board electrical test).
kicad_export_netlist	silent	live_only	Export a netlist from the schematic.
kicad_export_odb	silent	live_only	Export the board in ODB++ format.
kicad_export_pcb	silent	live_only	Run any kicad-cli PCB export format not covered by a dedicated tool
kicad_export_pdf	silent	live_only	Plot the given board layers to a PDF (comma-separated layer names).
kicad_export_pos	silent	live_only	Generate a component position (pick-and-place) file.
kicad_export_sch	silent	live_only	Run any kicad-cli schematic export format not covered by a dedicated
kicad_export_schematic_pdf	silent	live_only	Export the schematic sheets to a PDF.
kicad_export_schematic_svg	silent	live_only	Export the schematic sheets to SVG (one per sheet).
kicad_export_spice	silent	live_only	Export a SPICE netlist from the schematic (the input to an ngspice
kicad_export_step	silent	live_only	Export the board as a STEP 3D model.
kicad_export_stl	silent	live_only	Export the board as an STL 3D model (3D printing / mechanical).
kicad_export_symbol_svg	silent	live_only	Export a symbol (or a whole .kicad_sym library) to SVG.
kicad_export_vrml	silent	live_only	Export the board as a VRML 3D model.
kicad_find_component	readonly	live_only	Find components whose reference or value contains the query
kicad_full_review	silent	live_only	One-call comprehensive review of the open design: board stats, PCB
kicad_generate_pcb	silent	live_only	Generate a KiCad board (.kicad_pcb) from a DesignPlan: declares the
kicad_generate_project	silent	live_only	Generate a complete, openable KiCad project from a DesignPlan:
kicad_generate_schematic	silent	live_only	Generate a KiCad schematic (.kicad_sch) from a DesignPlan: embeds a
kicad_get_board_outline	readonly	live_only	Board edge bounding box (mm), from Edge.Cuts graphics.
kicad_get_board_summary	readonly	live_only	One-call board overview: object counts, board size (mm), layer
kicad_get_bom	readonly	live_only	Consolidated Bill of Materials from the schematic netlist: one line
kicad_get_component_details	readonly	live_only	Full detail for one component: value, footprint, position (mm),
kicad_get_diff_pairs	readonly	live_only	Differential pairs inferred from net naming (X_P/X_N, X+/X-),
kicad_get_fab_stats	readonly	live_only	Board fabrication statistics (component / pad / hole / track counts,
kicad_get_layer_usage	readonly	live_only	Per-layer routing usage: track count and total track length (mm),
kicad_get_layers	readonly	live_only	Enabled board layer names.
kicad_get_net	readonly	live_only	All pads on a given net: reference and pin number.
kicad_get_net_classes	readonly	live_only	Per-net net-class assignment and each class's routing rules
kicad_get_netlist	readonly	live_only	Structured schematic netlist: components (reference, value,
kicad_get_project_info	readonly	live_only	Open project's name, directory, and net-class names.
kicad_get_selection	readonly	live_only	Items currently selected in the KiCad PCB editor: type and, for
kicad_get_stackup	readonly	live_only	Board stackup: layer name, type, material, thickness (mm).
kicad_get_text_variables	readonly	live_only	Project text (substitution) variables.
kicad_get_title_block	readonly	live_only	Title-block fields (title, date, revision, company, comments).
kicad_get_trace_lengths	readonly	live_only	Total routed track length per net (mm), summed from the copper
kicad_get_unconnected_pins	readonly	live_only	Pads with no net assigned (potentially unconnected pins).
kicad_get_via_summary	readonly	live_only	Via count and the distinct via sizes (pad diameter / drill) in use,
kicad_list_dimensions	readonly	live_only	Dimension annotations: layer, override text, height (mm).
kicad_list_documents	readonly	live_only	Documents currently open in KiCad (PCB and schematic) with
kicad_list_groups	readonly	live_only	Item groups on the board: name and member count.
kicad_list_pads	readonly	live_only	All pads on the board: number, net, position (mm), pad type.
kicad_list_shapes	readonly	live_only	Graphic shapes: type (segment/arc/circle/rect/polygon), layer, net,
kicad_list_text	readonly	live_only	Free board text items: value, layer, position (mm).
kicad_list_tracks	readonly	live_only	Copper tracks and arcs: net, layer, width, endpoints, length (mm).
kicad_list_vias	readonly	live_only	Vias: net, position, diameter and drill (mm).
kicad_list_zones	readonly	live_only	Copper zones and rule areas: name, net, layers, fill, priority.
kicad_lock_component	silent	live_only	Lock or unlock a component's placement.
kicad_move_component	silent	live_only	Move a component to an absolute board position (mm).
kicad_ping	silent	live_only	Check the live connection to a running KiCad; returns KiCad and API
kicad_render_3d	silent	live_only	Render the board's 3D view to a PNG image.
kicad_review_schematic	readonly	live_only	Design review of the SCHEMATIC's intended connectivity: annotation,
kicad_rotate_component	silent	live_only	Set a component's orientation (degrees).
kicad_run_action	silent	live_only	Run an arbitrary KiCad tool action by name (e.g. a TOOL_ACTION such
kicad_run_jobset	silent	live_only	Run a KiCad jobset (a saved batch of output jobs -- KiCad's
kicad_run_spice	silent	live_only	Run a SPICE simulation on the schematic via a standalone ngspice.
kicad_save_board	silent	live_only	Write the open board to disk.
kicad_set_component_side	silent	live_only	Place a component on the top or bottom copper layer ("top"/"bottom").
kicad_set_component_value	silent	live_only	Set a component's value field.
kicad_set_text_variable	silent	live_only	Set a project text (substitution) variable, e.g. key "REV" value
kicad_upgrade_board	silent	live_only	Upgrade the open board's file format to the current KiCad version.
kicad_upgrade_footprint_library	silent	live_only	Upgrade a footprint (.pretty) library to the current KiCad format.
kicad_upgrade_schematic	silent	live_only	Upgrade the open schematic's file format to the current KiCad
kicad_upgrade_symbol_library	silent	live_only	Upgrade a symbol (.kicad_sym) library to the current KiCad format.

easyeda / application (30)

Tool	Interaction	Maturity	Summary
easyeda_activate_document	silent	live_only	Switch to an already-open TAB, by its tab id.
easyeda_checkpoint	silent	live_only	Save the open document so a later change can be undone.
easyeda_clear_findings	silent	live_only	Remove every marker drawn by easyeda_mark_findings.
easyeda_close_document	silent	live_only	Close an open document without deleting anything.
easyeda_create_folder	silent	live_only	Create a project folder, top-level or nested.
easyeda_create_panel	silent	live_only	Create a panel document.
easyeda_delete_panel	silent	live_only	Delete a panel document. There is no undo.
easyeda_get_capabilities	readonly	live_only	Which parts of the EasyEDA API exist in the CURRENT context.
easyeda_get_current_panel	readonly	live_only	The panel document currently open, if one is.
easyeda_get_environment	readonly	live_only	Which EasyEDA this is, and whether it is online.
easyeda_get_measured_shapes	readonly	live_only	What live sessions have established about the editor's replies.
easyeda_get_panel	readonly	live_only	One panel by uuid, from easyeda_list_panels.
easyeda_get_paths	readonly	live_only	Where the editor keeps documents, projects and libraries.
easyeda_get_team	readonly	live_only	The current team, whose uuid every folder operation needs.
easyeda_get_workspaces	readonly	live_only	Workspaces the editor knows about, and which is current.
easyeda_invoke	silent	live_only	Call any EasyEDA API method directly.
easyeda_invoke_batch	silent	live_only	Several easyeda_invoke calls in one round trip.
easyeda_list_boards_dmt	readonly	live_only	Boards in the workspace, at the document-manager level.
easyeda_list_checkpoints	readonly	live_only	Checkpoints taken on this machine, newest first.
easyeda_list_folders	readonly	live_only	Every project folder in a team, with its details.
easyeda_list_panels	readonly	live_only	Panels in the workspace.
easyeda_mark_findings	silent	live_only	Draw review findings ON the board, where the reader is looking.
easyeda_move_project_to_folder	silent	live_only	Move a project into a folder, or to the top level.
easyeda_open_document	silent	live_only	Open a document in the editor by uuid.
easyeda_ping	silent	live_only	Is an EasyEDA editor connected, and to which document?
easyeda_rename_panel	silent	live_only	Rename a panel document.
easyeda_render_image	silent	live_only	Render what the editor is currently showing, as an image.
easyeda_restore_checkpoint	silent	live_only	Put a saved document back, replacing what is open.
easyeda_zoom_to_all	silent	live_only	Frame everything in the current document.
easyeda_zoom_to_selection	silent	live_only	Frame the current selection.

easyeda / audit (38)

Tool	Interaction	Maturity	Summary
easyeda_audit_acute_angles	readonly	live_only	Track joints that meet at an acute angle.
easyeda_audit_capacitor_voltage_margin	readonly	live_only	Capacitors rated too close to the rail they sit on.
easyeda_audit_components_outside_outline	readonly	live_only	Components whose origin falls outside the board outline.
easyeda_audit_crystal_load_caps	readonly	live_only	Crystals whose load capacitors are missing or mismatched.
easyeda_audit_dangling_track_ends	readonly	live_only	Track ends that touch nothing else on their own net.
easyeda_audit_decoupling_schematic	readonly	live_only	Integrated circuits without a decoupling capacitor.
easyeda_audit_degenerate_copper	readonly	live_only	Fills and pours whose outline cannot enclose an area.
easyeda_audit_designator_collisions	readonly	live_only	Footprints on the board sharing one designator.
easyeda_audit_device_pin_parity	readonly	live_only	Do a device's symbol and footprint agree on their connections?
easyeda_audit_duplicate_designators	readonly	live_only	Two parts sharing one designator.
easyeda_audit_footprint_vs_datasheet	readonly	live_only	Audit the OPEN footprint against the manufacturer's land pattern.
easyeda_audit_mirrored_text	readonly	live_only	Bottom-side text that will read backwards on the real board.
easyeda_audit_missing_datasheets	readonly	live_only	ICs with no fetchable datasheet URL among their parameters.
easyeda_audit_missing_decoupling	readonly	live_only	ICs whose power pins have no capacitor on the same net.
easyeda_audit_mpn_inconsistencies	readonly	live_only	The same library part placed with different part numbers.
easyeda_audit_off_angle_components	readonly	live_only	Components rotated off the 90-degree grid.
easyeda_audit_off_grid_components	readonly	live_only	Components whose origin does not sit on the placement grid.
easyeda_audit_open_drain_pullups	readonly	live_only	Open-drain buses with a missing or badly sized pull-up.
easyeda_audit_pads_near_board_edge	readonly	live_only	Pads too close to the board edge to be made reliably.
easyeda_audit_parts_excluded_from_bom	readonly	live_only	Placed components that will not appear on the BOM.
easyeda_audit_placeholder_values	readonly	live_only	Components still carrying an "I'll fix this later" string.
easyeda_audit_placeholder_values_schematic	readonly	live_only	Parts still carrying a placeholder instead of a real value.
easyeda_audit_placement_collisions	readonly	live_only	Placed components whose extents overlap or nearly touch.
easyeda_audit_power_port_orientation	readonly	live_only	Power and ground glyphs pointing the wrong way.
easyeda_audit_signal_vias_without_return	readonly	live_only	Signal vias with no nearby ground / power via for return
easyeda_audit_single_pad_nets	readonly	live_only	Nets that reach exactly one pad on the board.
easyeda_audit_single_pin_nets_schematic	readonly	live_only	Nets that reach exactly one pin.
easyeda_audit_track_widths	readonly	live_only	Nets routed at more than one width.
easyeda_audit_unconnected_component_pads	readonly	live_only	Components with pads on no net, counted per component.
easyeda_audit_unconnected_schematic_pins	readonly	live_only	Schematic pins that sit on no net.
easyeda_audit_unlocked_components	readonly	live_only	Placed components that are not locked against being moved.
easyeda_audit_via_annular_ring	readonly	live_only	Vias whose copper ring around the drill is too thin to make.
easyeda_audit_via_antennas	readonly	live_only	Vias whose net has copper on fewer than two layers.
easyeda_audit_vias_near_board_edge	readonly	live_only	Vias too close to the board edge to survive routing.
easyeda_compare_schematic_pcb	readonly	live_only	Do the schematic and the board hold the same components?
easyeda_get_unconnected_pins	readonly	live_only	Which pins on the current PCB sit on no net.
easyeda_get_unrouted_nets	readonly	live_only	Nets with no routed copper at all.
easyeda_review_board	readonly	live_only	Run every EasyEDA audit and rank what they found.

easyeda / design (6)

Tool	Interaction	Maturity	Summary
easyeda_emit_connections	readonly	offline	Emit the calls that connect a plan's nets, from real pins.
easyeda_emit_plan	readonly	offline	Turn a validated DesignPlan into an ordered list of calls.
easyeda_review_snapshot	readonly	offline	Fetch the design data a review is JUDGED from, in one call.
easyeda_run_drc	readonly	offline	Run the editor's own design rule check and read the result.
easyeda_run_erc	readonly	offline	Run the editor's own electrical rule check and read it back.
easyeda_run_plan	readonly	offline	Run a sequence produced by the emit tools, in order.

easyeda / library (29)

Tool	Interaction	Maturity	Summary
easyeda_copy_device	silent	live_only	Copy a device into another library.
easyeda_copy_footprint	silent	live_only	Copy a footprint into another library.
easyeda_copy_symbol	silent	live_only	Copy a symbol into another library.
easyeda_create_device	silent	live_only	Bind a symbol and a footprint into a placeable device.
easyeda_create_footprint	silent	live_only	Create an empty footprint in a library, and return its uuid.
easyeda_create_ic_symbol	silent	live_only	Create a COMPLETE IC symbol in one call.
easyeda_create_passive_symbol	silent	live_only	Create a complete 2-pin passive symbol in one call.
easyeda_create_standard_footprint	silent	live_only	Create a COMPLETE standard footprint in one call.
easyeda_create_symbol	silent	live_only	Create an empty symbol in a library, and return its uuid.
easyeda_delete_device	silent	live_only	Remove a device from a library.
easyeda_delete_footprint	silent	live_only	Remove a footprint from a library.
easyeda_delete_symbol	silent	live_only	Remove a symbol from a library.
easyeda_get_device	readonly	live_only	One library device: what it is and what it is bound to.
easyeda_get_devices_by_lcsc	readonly	live_only	Look devices up by LCSC part number.
easyeda_get_footprint_image	readonly	live_only	Render one footprint to an image.
easyeda_get_library_classifications	readonly	live_only	The category tree of one library.
easyeda_get_symbol_image	readonly	live_only	Render one symbol to an image.
easyeda_link_3d_model	silent	live_only	Bind a 3D model, footprint or symbol to a device.
easyeda_list_libraries	readonly	live_only	Libraries available in the editor: system, personal, project.
easyeda_open_footprint	silent	live_only	Open a library footprint for editing.
easyeda_open_symbol	silent	live_only	Open a library symbol for editing, and make it the active
easyeda_rename_device	silent	live_only	Rename a library device or change its description.
easyeda_rename_footprint	silent	live_only	Rename a library footprint or change its description.
easyeda_rename_symbol	silent	live_only	Rename a library symbol or change its description.
easyeda_search_3d_models	readonly	live_only	Search the editor's 3D model library.
easyeda_search_circuit_blocks	readonly	live_only	Find reusable circuit blocks in the libraries.
easyeda_search_devices	readonly	live_only	Search the editor's device libraries.
easyeda_search_footprints	readonly	live_only	Search the editor's footprint libraries.
easyeda_search_symbols	readonly	live_only	Search the editor's symbol libraries.

easyeda / pcb (76)

Tool	Interaction	Maturity	Summary
easyeda_add_arc	silent	live_only	Draw one arc on the current PCB.
easyeda_add_dimension	silent	live_only	Draw a measured dimension on the current PCB.
easyeda_add_fill	silent	live_only	Fill a polygon with solid copper on the current PCB.
easyeda_add_line	silent	live_only	Draw one line on the current PCB.
easyeda_add_nets_to_length_match_group	silent	live_only	Add nets to an existing equal-length group.
easyeda_add_nets_to_net_class	silent	live_only	Add nets to an existing net class.
easyeda_add_pad	silent	live_only	Place a pad on the current PCB or footprint.
easyeda_add_pads	silent	live_only	Place many pads on the current PCB or footprint in one call.
easyeda_add_polyline	silent	live_only	Draw a connected run of segments on the current PCB.
easyeda_add_region	silent	live_only	Mark a keepout or constraint area on the current PCB.
easyeda_add_text	silent	live_only	Place one text string on the current PCB.
easyeda_add_via	silent	live_only	Place one via on the current PCB.
easyeda_add_zone	silent	live_only	Pour a copper zone over a polygon on the current PCB.
easyeda_align_components	silent	live_only	Line placed components up along one edge or centre.
easyeda_auto_route	silent	live_only	Run the editor's autorouter over the current PCB.
easyeda_cleanup_track_slivers	silent	live_only	Delete near-zero track stubs left behind by editing.
easyeda_clear_routing	silent	live_only	Remove existing routing from the current PCB.
easyeda_clear_selection	silent	live_only	Deselect everything in the editor.
easyeda_create_differential_pair	silent	live_only	Declare a differential pair on the current PCB.
easyeda_create_length_match_group	silent	live_only	Create an equal-length net group on the current PCB.
easyeda_create_net_class	silent	live_only	Create a net class on the current PCB.
easyeda_cross_probe	silent	live_only	Reveal parts, pins or nets in the editor by NAME.
easyeda_delete_primitives	silent	live_only	Delete primitives from the current PCB by id.
easyeda_distribute_components	silent	live_only	Space placed components evenly between the outermost two.
easyeda_get_arcs	readonly	live_only	Arc primitives on the current PCB.
easyeda_get_attributes	readonly	live_only	Text attributes on the current PCB.
easyeda_get_board_outline	readonly	live_only	The board outline, as the segments drawn on its layer.
easyeda_get_board_statistics	readonly	live_only	Counts and extents for the whole board, in one call.
easyeda_get_bounding_box	readonly	live_only	Bounding box enclosing the named primitives.
easyeda_get_bounding_boxes	readonly	live_only	One bounding box per primitive, in a single call.
easyeda_get_components	readonly	live_only	Every component placed on the current PCB.
easyeda_get_differential_pairs	readonly	live_only	Differential pairs the editor knows about.
easyeda_get_dimensions	readonly	live_only	Dimension objects on the current PCB.
easyeda_get_embedded_objects	readonly	live_only	Binary embedded objects on the current PCB.
easyeda_get_fills	readonly	live_only	Solid fill primitives on the current PCB.
easyeda_get_images	readonly	live_only	Images placed on the current PCB.
easyeda_get_layers	readonly	live_only	Layers on the current PCB.
easyeda_get_length_match_groups	readonly	live_only	Equal-length net groups defined on the current PCB.
easyeda_get_lines	readonly	live_only	Line primitives (tracks and graphics) on the current PCB.
easyeda_get_net_classes	readonly	live_only	Net classes defined on the current PCB.
easyeda_get_net_length	readonly	live_only	Routed length of one net, as the editor measures it.
easyeda_get_net_lengths	readonly	live_only	Routed copper length of every net, in one call.
easyeda_get_net_rules	readonly	live_only	Per-net rule values in force on the current PCB.
easyeda_get_nets	readonly	live_only	Nets in the design, with the pins on each.
easyeda_get_pads	readonly	live_only	Pads on the current PCB.
easyeda_get_poured	readonly	live_only	Copper actually filled in by pouring.
easyeda_get_pours	readonly	live_only	Copper pour outlines on the current PCB.
easyeda_get_primitives_in_region	readonly	live_only	Everything inside a rectangle on the current PCB.
easyeda_get_regions	readonly	live_only	Filled regions (copper pours) on the current PCB.
easyeda_get_rule_configurations	readonly	live_only	Rule configurations on the current PCB, and which is active.
easyeda_get_selection	readonly	live_only	What the user currently has selected in the editor.
easyeda_get_strings	readonly	live_only	Text primitives on the current PCB.
easyeda_get_vias	readonly	live_only	Vias on the current PCB.
easyeda_highlight_net	silent	live_only	Highlight one net in the editor, to show a human where it is.
easyeda_import_routing	silent	live_only	Import an autorouter or autolayout result back onto the board.
easyeda_import_schematic_changes	silent	live_only	Apply the schematic to the board: EasyEDA's ECO.
easyeda_list_boards	readonly	live_only	Every PCB in the open project, with the current one marked.
easyeda_modify_component	silent	live_only	Change properties of one placed component on the PCB.
easyeda_modify_layer	silent	live_only	Rename or restyle one layer.
easyeda_modify_pcb_components	silent	live_only	Change properties on many PCB components at once.
easyeda_navigate	silent	live_only	Scroll the editor to a coordinate, to show a human where.
easyeda_place_pcb_component	silent	live_only	Place a footprint on the current PCB.
easyeda_place_pcb_components	silent	live_only	Place many footprints on the board in one call.
easyeda_place_stitching_vias	silent	live_only	Stitch a rectangle with vias on one net, usually ground.
easyeda_plan_placement	silent	live_only	Work out a better arrangement of the parts on the board.
easyeda_route_plan	silent	live_only	Route the board offline and return tracks and vias to place.
easyeda_save	silent	live_only	Save the current PCB document.
easyeda_select_layer	silent	live_only	Make one layer the active one in the editor.
easyeda_select_primitives	silent	live_only	Select primitives on the current PCB, by id.
easyeda_set_copper_layer_count	silent	live_only	Set how many copper layers the board has.
easyeda_set_layer_lock	silent	live_only	Lock or unlock layers against editing.
easyeda_set_layer_visibility	silent	live_only	Show or hide layers in the editor.
easyeda_set_netlist	silent	live_only	REPLACE the board's entire connectivity from a netlist.
easyeda_snap_components_to_grid	silent	live_only	Move placed components onto the nearest grid point.
easyeda_tune_length	silent	live_only	Add routed length to a net with a square serpentine.
easyeda_zoom_to_board	silent	live_only	Fit the board outline in the editor view.

easyeda / project (34)

Tool	Interaction	Maturity	Summary
easyeda_create_pcb	silent	live_only	Add a board to the open project.
easyeda_create_project	silent	live_only	Create a project.
easyeda_create_schematic	silent	live_only	Add a schematic to the open project.
easyeda_create_schematic_page	silent	live_only	Add a page to an existing schematic.
easyeda_delete_pcb	silent	live_only	Delete a board, including its routing.
easyeda_delete_project	silent	live_only	NOT POSSIBLE on EasyEDA. Delete the parts, or use the UI.
easyeda_delete_schematic	silent	live_only	Delete a schematic and every page in it.
easyeda_delete_schematic_page	silent	live_only	Delete one page of a schematic.
easyeda_export_3d	silent	live_only	The 3D model of the assembled board.
easyeda_export_altium	silent	live_only	Export the design as an Altium Designer file.
easyeda_export_bom	silent	live_only	The BOM file, as the editor generates it.
easyeda_export_bom_html	silent	live_only	Export the board's BOM as a self-contained interactive page.
easyeda_export_dsn	silent	live_only	The board as a Specctra DSN file.
easyeda_export_dxf	silent	live_only	The board outline and copper as DXF.
easyeda_export_flying_probe	silent	live_only	The flying probe test file.
easyeda_export_gerber	silent	live_only	Gerber fabrication data.
easyeda_export_ipc2581	silent	live_only	IPC-2581 fabrication data, the format that carries intent.
easyeda_export_ipcd356	silent	live_only	IPC-D-356A netlist for bare-board electrical test.
easyeda_export_netlist	silent	live_only	The PCB netlist file.
easyeda_export_pads	silent	live_only	The design in PADS format.
easyeda_export_pcb_info	silent	live_only	The board's fabrication parameters, as a file.
easyeda_export_pdf	silent	live_only	The board as a PDF, as the editor renders it.
easyeda_export_pick_and_place	silent	live_only	Component centroids for assembly.
easyeda_export_schematic_bom	silent	live_only	The BOM as the schematic generates it.
easyeda_export_schematic_document	silent	live_only	The schematic as a document file.
easyeda_export_schematic_netlist	silent	live_only	The netlist as the schematic editor generates it.
easyeda_export_simulation_netlist	silent	live_only	The SPICE netlist for simulation.
easyeda_export_test_points	silent	live_only	The test point list.
easyeda_find_component	readonly	live_only	Find components whose designator or value contains the query.
easyeda_generate_fab_package	silent	live_only	Everything a fab house needs, in one folder, with a manifest.
easyeda_get_project	readonly	live_only	One project's details, by uuid.
easyeda_get_project_info	readonly	live_only	The open project: name, uuid, and what it contains.
easyeda_list_projects	readonly	live_only	Every project uuid the editor lists.
easyeda_open_project	silent	live_only	Open a project in the editor.

easyeda / schematic (34)

Tool	Interaction	Maturity	Summary
easyeda_add_bus	silent	live_only	Draw a bus on the current schematic.
easyeda_add_pin	silent	live_only	Place a pin on the current symbol.
easyeda_add_pins	silent	live_only	Place many pins on the current symbol in one call.
easyeda_add_schematic_arc	silent	live_only	Draw an arc on the current schematic, through three points.
easyeda_add_schematic_circle	silent	live_only	Draw a circle on the current schematic.
easyeda_add_schematic_polygon	silent	live_only	Draw a closed polygon on the current schematic.
easyeda_add_schematic_rectangle	silent	live_only	Draw a rectangle on the current schematic.
easyeda_add_schematic_text	silent	live_only	Place a text note on the current schematic.
easyeda_add_wire	silent	live_only	Draw a wire on the current schematic.
easyeda_add_wires	silent	live_only	Draw many wires on the schematic in one call.
easyeda_clear_schematic_selection	silent	live_only	Deselect everything on the current schematic.
easyeda_create_net_flag	silent	live_only	Place a power or ground rail glyph on the schematic.
easyeda_create_net_label	silent	live_only	Place a net label on the schematic, at a point.
easyeda_create_net_port	silent	live_only	Place a net port on the schematic, at a point.
easyeda_delete_schematic_primitives	silent	live_only	Delete primitives from the current schematic by id.
easyeda_get_assembly_variants	readonly	live_only	Assembly variant configurations.
easyeda_get_netlist	readonly	live_only	The schematic netlist, parsed.
easyeda_get_schematic_attributes	readonly	live_only	Text attributes on the current schematic.
easyeda_get_schematic_buses	readonly	live_only	Buses on the current schematic.
easyeda_get_schematic_components	readonly	live_only	Every component on the current schematic.
easyeda_get_schematic_hierarchy	readonly	live_only	The sheet hierarchy: which blocks the open schematic contains.
easyeda_get_schematic_pins	readonly	live_only	Every schematic pin, with its part and the net it sits on.
easyeda_get_schematic_selection	readonly	live_only	What is selected on the current schematic.
easyeda_get_schematic_wires	readonly	live_only	Wires on the current schematic.
easyeda_increment_designators	silent	live_only	Offset the trailing number of schematic designators.
easyeda_list_schematic_pages	readonly	live_only	Pages of the current schematic.
easyeda_list_schematics	readonly	live_only	Every schematic in the open project.
easyeda_modify_schematic_components	silent	live_only	Change properties on many schematic components at once.
easyeda_place_schematic_component	silent	live_only	Place a library part on the current schematic.
easyeda_place_schematic_components	silent	live_only	Place many library parts on the schematic in one call.
easyeda_save_schematic	silent	live_only	Save the current schematic document.
easyeda_select_schematic_primitives	silent	live_only	Select primitives on the current schematic, by id.
easyeda_set_schematic_component_properties	silent	live_only	Change properties of one placed schematic component.
easyeda_set_title_block	silent	live_only	Fill in the current schematic page's title block.