Skip to content

MCP Tools Reference

This page details all available Model Context Protocol (MCP) tools exposed by easyeda-mcp-pro. These tools are profile-gated. Set the TOOL_PROFILE environment variable to enable them.

Summary of Tools

Tool NameProfileRiskDescription
easyeda_api_callfullhighCall a documented EasyEDA class method by path, for example SCH_PrimitiveWire.getAll. This is not raw JavaScript execution.
easyeda_api_inventorycorelowInspect the live EasyEDA extension runtime and list available documented API classes, runtime paths, and methods.
easyeda_board_dimensionscorelowGet the PCB board outline dimensions, shape, and mounting hole information.
easyeda_board_featurescorelowGet counts of board features including vias, tracks, copper zones, and pads.
easyeda_board_layerscorelowList all layers in the PCB design including signal, power, plane, and mechanical layers.
easyeda_board_stackupcorelowGet the PCB layer stackup including thickness, material, and dielectric constants.
easyeda_bom_exportcorelowExport the bill of materials to a file on disk in the specified format.
easyeda_bom_generatecorelowGenerate a bill of materials for the project with grouping and formatting options.
easyeda_bom_quality_reportcoremediumGenerate a BOM quality report that identifies unavailable, single-source, missing-MPN, missing-footprint, and low-stock items across configured suppliers.
easyeda_bom_sourcingcoremediumRetrieve pricing and availability information for all parts in the project BOM from specified suppliers.
easyeda_bom_validatecoremediumValidate the project BOM against LCSC inventory to identify missing, obsolete, or alternate parts.
easyeda_bridge_probe_methodsdevmediumQuery the EasyEDA Pro bridge for available API methods. Requires bridge connection. (dev/pro only)
easyeda_bridge_statuscorelowCheck EasyEDA Pro bridge connection status, version, and capabilities.
easyeda_component_probedevlowInspect live schematic component objects, including available methods and state getter values, to validate EasyEDA runtime mappings.
easyeda_drc_runcoremediumRun design rule check (DRC) on the project to identify rule violations, clearance issues, and manufacturing constraints.
easyeda_erc_runcoremediumRun electrical rule check (ERC) on the schematic to detect unconnected nets, short circuits, and electrical conflicts.
easyeda_executedevhighExecute arbitrary JavaScript in the EasyEDA Pro extension runtime via the Run API Gateway. The code receives eda as the EDA API root object. Requires BRIDGE_RAW_EXEC_ENABLED=true and confirmWrite=true. Use this when typed API methods are unavailable or to run multi-step sequences atomically.
easyeda_export_gerberscoremediumExport PCB design to Gerber files for PCB fabrication.
easyeda_export_netlistprolowExport the schematic netlist in a specified EDA tool format (PADS, Allegro, or Altium).
easyeda_export_pdfprolowExport the schematic and/or board layout to PDF.
easyeda_export_pick_placeprolowExport pick-and-place (centroid) file for PCB assembly. Contains component reference, position, rotation, and layer.
easyeda_get_capabilitiescorelowReturn server capabilities, including available profiles, enabled feature flags, and supported operations.
easyeda_get_feature_flagscorelowReturn current feature flag values.
easyeda_get_server_configcorelowReturn safe (redacted) server configuration. Secrets are never exposed.
easyeda_get_tool_profilescorelowList available tool profiles and their descriptions.
easyeda_health_checkcorelowReturn server health status, including runtime version, active profile, bridge state, and config validity.
easyeda_pcb_add_trackfullhighDraw a copper track/trace segment on the PCB board.
easyeda_pcb_add_viafullhighPlace a via to connect different copper layers on the PCB board.
easyeda_pcb_add_zonefullhighCreate a copper pour zone on a specific layer with clearance settings.
easyeda_pcb_constraint_checkcorelowRun PCB constraint validation against the board design. Checks board outline, layer stackup, net classes, clearance rules, keepout areas, placement zones, mounting holes, fiducials, and manufacturing constraints.
easyeda_pcb_constraint_reportcorelowGenerate a human-readable report explaining which PCB constraints were applied and which require manual review.
easyeda_pcb_delete_componentfullhighDelete components from the PCB layout by their primitive IDs.
easyeda_pcb_modify_componentfullhighModify component properties in the PCB layout.
easyeda_pcb_place_componentfullhighPlace a component footprint on the active PCB layout.
easyeda_project_savecoremediumExplicitly save the current EasyEDA Pro project. This ensures all netlist changes, net flags, pin connections, and other mutations are persisted to the project file. Save is never implicit — the caller must explicitly request it. Requires confirmWrite.
easyeda_rule_check_summarycorelowGet a summary of all design and electrical rule check results for the project.
easyeda_run_self_testcorelowRun internal self-test to verify server integrity, config, and bridge connectivity.
easyeda_schematic_add_wirecoremediumAdd a wire segment connecting schematic coordinates/pins.
easyeda_schematic_component_pinscorelowGet exact pin numbers, names, and coordinates for a schematic component by its primitive ID.
easyeda_schematic_componentscorelowList all components in the schematic with their properties including reference, value, footprint, LCSC part number, manufacturer, and datasheet.
easyeda_schematic_connect_pin_to_netcoremediumConnect a specific component pin to a named net. This creates an actual SCH_Netlist entry associating the pin with the net. If the net does not exist yet, it is created on the fly. This is the core tool for populating the real EasyEDA netlist with pin-to-net connectivity.
easyeda_schematic_connect_pins_by_netcoremediumConnect multiple component pins to a named net in a single operation. All specified pins will be assigned to the same net, creating SCH_Netlist entries. If the net does not exist, it is created. This is the bulk equivalent of connect_pin_to_net.
easyeda_schematic_create_net_flagcoremediumPlace a net flag (net label) on the schematic canvas at specified coordinates. A net flag declares a named net on a wire segment, creating real SCH_Net connectivity in the EasyEDA Pro netlist. Unlike easyeda_schematic_add_wire (which creates graphical wires that may not appear in SCH_Net/SCH_Netlist), this tool actually populates the netlist.
easyeda_schematic_create_net_portcoremediumPlace a hierarchical net port (off-sheet connector) on the schematic. Net ports create named connections that span multiple schematic sheets, appearing as real SCH_Net entries in the netlist.
easyeda_schematic_delete_primitivecoremediumDelete components, wires, or other drawing objects from the schematic by their primitive UUIDs.
easyeda_schematic_modify_primitivecoremediumModify properties (value, reference, attributes, etc.) of a schematic component/object.
easyeda_schematic_net_detailcorelowGet full details for a specific net in the schematic including all connected pins and components.
easyeda_schematic_netscorelowList all nets in the schematic with their node connections.
easyeda_schematic_place_componentcoremediumPlace a library component/device on the active schematic sheet.
easyeda_schematic_search_devicecorelowSearch for schematic symbols/devices in the EasyEDA library by keywords.
easyeda_schematic_validate_netlistcorelowValidate the EasyEDA Pro schematic netlist for connectivity issues. Reports net names, connected component references and pins, floating pins, graphical wires without netlist connectivity, and mismatches between visual wires and actual SCH_Net/SCH_Netlist entries. This is a read-only diagnostic tool.

easyeda_api_call

Profile: full | Risk Level: high

Call a documented EasyEDA class method by path, for example SCH_PrimitiveWire.getAll. This is not raw JavaScript execution.

Input Parameters

ParameterTypeRequiredDescription
pathanyYes
argsanyYes
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  ok: any;
  path: any;
  resolvedPath: any;
  result: any;
  error: any;
  requires_confirmation: any;
}

easyeda_api_inventory

Profile: core | Risk Level: low

Inspect the live EasyEDA extension runtime and list available documented API classes, runtime paths, and methods.

Input Parameters

ParameterTypeRequiredDescription
filteranyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  classes: any;
  total: any;
  not_available: any;
  error: any;
}

easyeda_board_dimensions

Profile: core | Risk Level: low

Get the PCB board outline dimensions, shape, and mounting hole information.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  width_mm: any;
  height_mm: any;
  shape: any;
  mounting_hole_count: any;
  area_mm2: any;
  not_available: any;
}

easyeda_board_features

Profile: core | Risk Level: low

Get counts of board features including vias, tracks, copper zones, and pads.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  vias: any;
  tracks: any;
  zones: any;
  pads: any;
  components: any;
  not_available: any;
}

easyeda_board_layers

Profile: core | Risk Level: low

List all layers in the PCB design including signal, power, plane, and mechanical layers.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  layers: any;
  total: any;
  not_available: any;
}

easyeda_board_stackup

Profile: core | Risk Level: low

Get the PCB layer stackup including thickness, material, and dielectric constants.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  total_layers: any;
  board_thickness_mm: any;
  layers: any;
  not_available: any;
}

easyeda_bom_export

Profile: core | Risk Level: low

Export the bill of materials to a file on disk in the specified format.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
formatanyYes
filePathanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  format: any;
  file_path: any;
  exported: any;
  entry_count: any;
  not_available: any;
}

easyeda_bom_generate

Profile: core | Risk Level: low

Generate a bill of materials for the project with grouping and formatting options.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
formatanyYes
groupByanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  format: any;
  group_by: any;
  entries: any;
  total_entries: any;
  not_available: any;
}

easyeda_bom_quality_report

Profile: core | Risk Level: medium

Generate a BOM quality report that identifies unavailable, single-source, missing-MPN, missing-footprint, and low-stock items across configured suppliers.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
low_stock_thresholdanyNo
require_mpnanyNo
require_footprintanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  bom_id: any;
  generated_at: any;
  total_entries: any;
  summary: any;
  entries: any;
  has_supplier_errors: any;
  not_available: any;
}

easyeda_bom_sourcing

Profile: core | Risk Level: medium

Retrieve pricing and availability information for all parts in the project BOM from specified suppliers.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
suppliersanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  parts: any;
  total_parts: any;
  not_available: any;
}

easyeda_bom_validate

Profile: core | Risk Level: medium

Validate the project BOM against LCSC inventory to identify missing, obsolete, or alternate parts.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  total_parts: any;
  missing_lcsc: any;
  invalid_lcsc: any;
  obsolete: any;
  valid_count: any;
  validated: any;
  not_available: any;
}

easyeda_bridge_probe_methods

Profile: dev | Risk Level: medium

Query the EasyEDA Pro bridge for available API methods. Requires bridge connection. (dev/pro only)

Input Parameters

ParameterTypeRequiredDescription
filteranyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  methods: any;
  total: any;
}

easyeda_bridge_status

Profile: core | Risk Level: low

Check EasyEDA Pro bridge connection status, version, and capabilities.

Input Parameters

No parameters required.

Output Format

Returns a JSON object matching the schema:

ts
{
  connected: any;
  bridge_version: any;
  easyeda_version: any;
  capabilities: any;
  dev_mode: any;
  last_heartbeat_ms: any;
  uptime_ms: any;
  status_error: any;
}

easyeda_component_probe

Profile: dev | Risk Level: low

Inspect live schematic component objects, including available methods and state getter values, to validate EasyEDA runtime mappings.

Input Parameters

ParameterTypeRequiredDescription
limitanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  total: any;
  samples: any;
  not_available: any;
  error: any;
}

easyeda_drc_run

Profile: core | Risk Level: medium

Run design rule check (DRC) on the project to identify rule violations, clearance issues, and manufacturing constraints.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
rulesanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  violations: any;
  total_violations: any;
  error_count: any;
  warning_count: any;
  passed: any;
  not_available: any;
}

easyeda_erc_run

Profile: core | Risk Level: medium

Run electrical rule check (ERC) on the schematic to detect unconnected nets, short circuits, and electrical conflicts.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
checksanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  violations: any;
  total_violations: any;
  error_count: any;
  warning_count: any;
  passed: any;
  not_available: any;
}

easyeda_execute

Profile: dev | Risk Level: high

Execute arbitrary JavaScript in the EasyEDA Pro extension runtime via the Run API Gateway. The code receives eda as the EDA API root object. Requires BRIDGE_RAW_EXEC_ENABLED=true and confirmWrite=true. Use this when typed API methods are unavailable or to run multi-step sequences atomically.

Input Parameters

ParameterTypeRequiredDescription
codeanyYes
confirmWriteanyYes
timeoutMsanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  ok: any;
  result: any;
  error: any;
  disabled: any;
}

easyeda_export_gerbers

Profile: core | Risk Level: medium

Export PCB design to Gerber files for PCB fabrication.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
drillFormatanyNo
excludeLayeranyNo
ledPanelanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  artifact_path: any;
  file_count: any;
  exported: any;
  not_available: any;
}

easyeda_export_netlist

Profile: pro | Risk Level: low

Export the schematic netlist in a specified EDA tool format (PADS, Allegro, or Altium).

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
formatanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  format: any;
  file_path: any;
  net_count: any;
  exported: any;
  not_available: any;
}

easyeda_export_pdf

Profile: pro | Risk Level: low

Export the schematic and/or board layout to PDF.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
scopeanyYes
orientationanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  scope: any;
  orientation: any;
  file_path: any;
  pages: any;
  exported: any;
  not_available: any;
}

easyeda_export_pick_place

Profile: pro | Risk Level: low

Export pick-and-place (centroid) file for PCB assembly. Contains component reference, position, rotation, and layer.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
formatanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  format: any;
  file_path: any;
  component_count: any;
  exported: any;
  not_available: any;
}

easyeda_get_capabilities

Profile: core | Risk Level: low

Return server capabilities, including available profiles, enabled feature flags, and supported operations.

Input Parameters

No parameters required.

Output Format

Returns a JSON object matching the schema:

ts
{
  server_name: any;
  server_version: any;
  protocol_version: any;
  profiles: any;
  current_profile: any;
  feature_flags: any;
  transports: any;
}

easyeda_get_feature_flags

Profile: core | Risk Level: low

Return current feature flag values.

Input Parameters

No parameters required.

Output Format

Returns a JSON object matching the schema:

ts
{
  flags: any;
}

easyeda_get_server_config

Profile: core | Risk Level: low

Return safe (redacted) server configuration. Secrets are never exposed.

Input Parameters

ParameterTypeRequiredDescription
include_flagsanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  node_env: any;
  log_level: any;
  profile: any;
  transport: any;
  bridge_host: any;
  bridge_port: any;
  mcp_protocol_version: any;
  flags: any;
}

easyeda_get_tool_profiles

Profile: core | Risk Level: low

List available tool profiles and their descriptions.

Input Parameters

No parameters required.

Output Format

Returns a JSON object matching the schema:

ts
{
  current: any;
  profiles: any;
}

easyeda_health_check

Profile: core | Risk Level: low

Return server health status, including runtime version, active profile, bridge state, and config validity.

Input Parameters

No parameters required.

Output Format

Returns a JSON object matching the schema:

ts
{
  status: any;
  version: any;
  node_version: any;
  profile: any;
  transport: any;
  bridge_connected: any;
  ups: any;
}

easyeda_pcb_add_track

Profile: full | Risk Level: high

Draw a copper track/trace segment on the PCB board.

Input Parameters

ParameterTypeRequiredDescription
pointsanyYes
layeranyYes
widthanyYes
netNameanyNo
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  primitiveId: any;
  error: any;
}

easyeda_pcb_add_via

Profile: full | Risk Level: high

Place a via to connect different copper layers on the PCB board.

Input Parameters

ParameterTypeRequiredDescription
xanyYes
yanyYes
outerDiameteranyYes
holeSizeanyYes
netNameanyNo
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  primitiveId: any;
  error: any;
}

easyeda_pcb_add_zone

Profile: full | Risk Level: high

Create a copper pour zone on a specific layer with clearance settings.

Input Parameters

ParameterTypeRequiredDescription
pointsanyYes
layeranyYes
netNameanyNo
clearanceanyNo
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  primitiveId: any;
  error: any;
}

easyeda_pcb_constraint_check

Profile: core | Risk Level: low

Run PCB constraint validation against the board design. Checks board outline, layer stackup, net classes, clearance rules, keepout areas, placement zones, mounting holes, fiducials, and manufacturing constraints.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
boardDataanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  valid: any;
  errors: any;
  warnings: any;
  summary: any;
  not_available: any;
}

easyeda_pcb_constraint_report

Profile: core | Risk Level: low

Generate a human-readable report explaining which PCB constraints were applied and which require manual review.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
boardDataanyNo

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  verdict: any;
  checked: any;
  manualReviewRequired: any;
  not_available: any;
}

easyeda_pcb_delete_component

Profile: full | Risk Level: high

Delete components from the PCB layout by their primitive IDs.

Input Parameters

ParameterTypeRequiredDescription
primitiveIdsanyYes
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  deletedCount: any;
  error: any;
}

easyeda_pcb_modify_component

Profile: full | Risk Level: high

Modify component properties in the PCB layout.

Input Parameters

ParameterTypeRequiredDescription
primitiveIdanyYes
propertyanyYes
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  error: any;
}

easyeda_pcb_place_component

Profile: full | Risk Level: high

Place a component footprint on the active PCB layout.

Input Parameters

ParameterTypeRequiredDescription
footprintanyYes
xanyYes
yanyYes
rotationanyYes
layeranyYes
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  primitiveId: any;
  error: any;
}

easyeda_project_save

Profile: core | Risk Level: medium

Explicitly save the current EasyEDA Pro project. This ensures all netlist changes, net flags, pin connections, and other mutations are persisted to the project file. Save is never implicit — the caller must explicitly request it. Requires confirmWrite.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYesThe project/schematic ID to save
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  project_id: any;
  saved_at: any;
  error: any;
}

easyeda_rule_check_summary

Profile: core | Risk Level: low

Get a summary of all design and electrical rule check results for the project.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  drc: any;
  erc: any;
  overall_passed: any;
  not_available: any;
}

easyeda_run_self_test

Profile: core | Risk Level: low

Run internal self-test to verify server integrity, config, and bridge connectivity.

Input Parameters

No parameters required.

Output Format

Returns a JSON object matching the schema:

ts
{
  passed: any;
  checks: any;
}

easyeda_schematic_add_wire

Profile: core | Risk Level: medium

Add a wire segment connecting schematic coordinates/pins.

Input Parameters

ParameterTypeRequiredDescription
pointsanyYes
netNameanyNo
coloranyNo
lineWidthanyNo
lineTypeanyNo
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  wire: any;
  error: any;
}

easyeda_schematic_component_pins

Profile: core | Risk Level: low

Get exact pin numbers, names, and coordinates for a schematic component by its primitive ID.

Input Parameters

ParameterTypeRequiredDescription
primitiveIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  primitiveId: any;
  pins: any;
  success: any;
  error: any;
}

easyeda_schematic_components

Profile: core | Risk Level: low

List all components in the schematic with their properties including reference, value, footprint, LCSC part number, manufacturer, and datasheet.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
limitanyYes
offsetanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  components: any;
  total: any;
  not_available: any;
  error: any;
}

easyeda_schematic_connect_pin_to_net

Profile: core | Risk Level: medium

Connect a specific component pin to a named net. This creates an actual SCH_Netlist entry associating the pin with the net. If the net does not exist yet, it is created on the fly. This is the core tool for populating the real EasyEDA netlist with pin-to-net connectivity.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYesThe project/schematic ID
primitiveIdanyYesThe primitive ID of the component
pinNumberanyYesThe pin number or pin name on the component (e.g. "1", "VCC", "GND")
netNameanyYesThe net name to connect the pin to (e.g. VCC, GND, DATA0)
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  connection: any;
  error: any;
}

easyeda_schematic_connect_pins_by_net

Profile: core | Risk Level: medium

Connect multiple component pins to a named net in a single operation. All specified pins will be assigned to the same net, creating SCH_Netlist entries. If the net does not exist, it is created. This is the bulk equivalent of connect_pin_to_net.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYesThe project/schematic ID
netNameanyYesThe net name to assign pins to
pinsanyYesList of component pins to connect to the net
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  connections: any;
  count: any;
  error: any;
}

easyeda_schematic_create_net_flag

Profile: core | Risk Level: medium

Place a net flag (net label) on the schematic canvas at specified coordinates. A net flag declares a named net on a wire segment, creating real SCH_Net connectivity in the EasyEDA Pro netlist. Unlike easyeda_schematic_add_wire (which creates graphical wires that may not appear in SCH_Net/SCH_Netlist), this tool actually populates the netlist.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYesThe project/schematic ID
netNameanyYesThe net name to assign (e.g. VCC, GND, TEST_NET)
xanyYesX coordinate on the schematic canvas
yanyYesY coordinate on the schematic canvas
rotationanyNoRotation in degrees (0, 90, 180, 270)
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  netFlag: any;
  error: any;
}

easyeda_schematic_create_net_port

Profile: core | Risk Level: medium

Place a hierarchical net port (off-sheet connector) on the schematic. Net ports create named connections that span multiple schematic sheets, appearing as real SCH_Net entries in the netlist.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYesThe project/schematic ID
netNameanyYesThe net name for the port (e.g. VCC, GND, DATA_BUS)
xanyYesX coordinate on the schematic canvas
yanyYesY coordinate on the schematic canvas
portTypeanyNoElectrical type of the port
rotationanyNoRotation in degrees (0, 90, 180, 270)
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  netPort: any;
  error: any;
}

easyeda_schematic_delete_primitive

Profile: core | Risk Level: medium

Delete components, wires, or other drawing objects from the schematic by their primitive UUIDs.

Input Parameters

ParameterTypeRequiredDescription
primitiveIdsanyYes
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  error: any;
}

easyeda_schematic_modify_primitive

Profile: core | Risk Level: medium

Modify properties (value, reference, attributes, etc.) of a schematic component/object.

Input Parameters

ParameterTypeRequiredDescription
primitiveIdanyYes
propertyanyYes
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  result: any;
  error: any;
}

easyeda_schematic_net_detail

Profile: core | Risk Level: low

Get full details for a specific net in the schematic including all connected pins and components.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes
netNameanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  net_name: any;
  node_count: any;
  nodes: any;
  not_available: any;
}

easyeda_schematic_nets

Profile: core | Risk Level: low

List all nets in the schematic with their node connections.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  nets: any;
  total: any;
  not_available: any;
}

easyeda_schematic_place_component

Profile: core | Risk Level: medium

Place a library component/device on the active schematic sheet.

Input Parameters

ParameterTypeRequiredDescription
deviceItemanyYes
xanyYes
yanyYes
subPartNameanyNo
rotationanyNo
mirroranyNo
addIntoBomanyNo
addIntoPcbanyNo
confirmWriteanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  success: any;
  component: any;
  error: any;
}

easyeda_schematic_search_device

Profile: core | Risk Level: low

Search for schematic symbols/devices in the EasyEDA library by keywords.

Input Parameters

ParameterTypeRequiredDescription
keyanyYes
libraryUuidanyNo
classificationanyNo
symbolTypeanyNo
itemsOfPageanyYes
pageanyYes

Output Format

Returns a JSON object matching the schema:

ts
{
  devices: any;
  total: any;
  not_available: any;
  error: any;
}

easyeda_schematic_validate_netlist

Profile: core | Risk Level: low

Validate the EasyEDA Pro schematic netlist for connectivity issues. Reports net names, connected component references and pins, floating pins, graphical wires without netlist connectivity, and mismatches between visual wires and actual SCH_Net/SCH_Netlist entries. This is a read-only diagnostic tool.

Input Parameters

ParameterTypeRequiredDescription
projectIdanyYesThe project/schematic ID
includeWireCheckanyYesWhen true, also check for graphical wires without netlist connectivity

Output Format

Returns a JSON object matching the schema:

ts
{
  project_id: any;
  netlist: any;
  total_nets: any;
  floating_pins: any;
  wires_without_netlist: any;
  valid: any;
  warnings: any;
  not_available: any;
  error: any;
}

Released under the MIT License.