easyeda-mcp-fix
Provides tools to interact with EasyEDA Pro, including schematic and PCB design operations, component management, netlist generation, DRC checks, and document I/O via the internal eda.* API.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@easyeda-mcp-fix get netlist for my current design"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
easyeda-mcp-fix
Bug-fix fork of the EasyEDA Pro MCP bridge. Resolves silent BOM wipes, dead copper to SMD pads and five-minute netlist hangs, hardened on a real board taken to fab.
Base: javawizard/easyeda-agent-mcp-server
(itself a fork of QuincySx/easyeda-agent-mcp-server).
Quick start (students start here)
Connect Claude Code to EasyEDA Pro so Claude can read, check and edit your schematics and PCBs, then lint a board before you order it.
Follow the step-by-step student guide. In short:
Download
easyeda-mcp.zipfrom the latest release and unzip it into your home folder. No build step needed.In EasyEDA Pro: Advanced → Extension Manager → Import the
.eext, then turn on External Interactions and Show in top menu.Register the server with Claude Code (Windows: same command in PowerShell with
\in the path):claude mcp add --scope user easyeda node "$HOME/easyeda-mcp/dist/mcp-server/index.js" -e EDA_REQUEST_TIMEOUT_MS=180000Install the board checker: copy
skills/pcb-lintinto~/.claude/skills/.In EasyEDA, open a schematic or PCB and click Claude → Connect Claude. Then ask Claude to "check the EasyEDA connection", or run
/pcb-lint.
New to Claude Code? After step 1, open Claude Code in the easyeda-mcp
folder and say "help me set this up". CLAUDE.md tells Claude
how to walk you through the rest, and the do's and don'ts it follows when
editing your designs.
Platform | Status |
macOS | Tested end to end (EasyEDA Pro desktop 3.2.149) |
Windows 10/11 | Supported from v1.6.5 (native, PowerShell). Server and bridge tested in CI; a full EasyEDA session on Windows still to be confirmed |
Linux | Server and bridge tested in CI; EasyEDA side untested |
pcb-lint: a board checker skill
skills/pcb-lint/ is a Claude Code skill that runs 26
design-hygiene checks (12 schematic, 14 PCB) through this bridge and writes
a scored report: regulator output against downstream abs-max, USB-C CC
pull-downs, ESP32 strapping pins, first-flash power path, decoupling
distance, annular ring, mask dams, copper-to-edge clearance, antenna
keep-outs and more. Type /pcb-lint in Claude Code with a board open. See
its README and SKILL.md.
The rest of this page is for developers: what the fork fixes, how it is secured, and how to build it.
Related MCP server: a2n-easyeda-mcp
Why this fork exists
The upstream easyeda-agent-mcp-server extension bridges Claude Code (and
other MCP clients) to EasyEDA Pro, exposing the internal eda.* API as ~98
MCP tools. Excellent design in the small, but during Splitflap Controller
Board 3 bring-up (June 2026) six upstream bugs surfaced that turned
day-to-day workflows into data-loss risks:
A single
sch_modify_componentcall on any parameter (justx, say) silently wipedsupplierIdand blanked every field ofotherProperty. Twenty-four components lost their BOM lines in one batch before the pattern was noticed. The schematic looked correct in the canvas.The Board 3 PCB layout passed clearance DRC, and the canvas rendered cleanly, but every API-drawn track was electrically dead to its SMD pads. Only a No-Connection check surfaced it.
Every read that needed pin-to-net data hung about five minutes, then rejected with nothing. Neither cache nor higher timeouts helped.
Each turned out to have a specific root cause, not just a slow API, so the fixes below are deterministic rather than workarounds. All six were live-verified against Splitflap Board 3 taken to fab.
What's fixed
# | Symptom on upstream | Root cause | Fix in this fork |
1 |
| Modify re-serialises the component from the symbol, losing metadata. | Snapshot the component via |
2 |
| The flag is forwarded to | Fan out per-page via |
3 |
| Calls | Route through |
4 | API-drawn tracks and arcs are electrically dead to their SMD pads. Clearance DRC passes; only a No-Connection check surfaces it. | EasyEDA stores the | Central |
5 |
| Handler passes a raw array where | Handler wraps input via |
6 | Schematic-editing library computes pin world coordinates wrongly for mirrored components ( |
| Mirror about local Y before rotate (matching the verified |
All six live-verified on Splitflap Controller Board 3: DRC returns zero,
connectivity queries return real nets in under a second, and the numeric
layer id is round-tripped through pcb_get_primitives_by_id.
Not fixed (yet)
Deliberate limits, kept honest:
Sheet-locked modify.
sch_modify_component'sdocumentparam does not reassign a primitive across schematic pages; empirically confirmed by trying it and catching the underlyingundefined.getState_ComponentType. Cross-page moves still require manual UI Cut, switch page, Paste.
Security audit
AUDIT.md documents the whole codebase across the three layers
(MCP server, bridge daemon, EDA Pro extension) with severity ratings.
Seven criticals were identified; all seven are resolved on this branch.
C4 (WebSocket authentication) is a mutual HMAC challenge-response (hmac-v1, since v1.6.0): the daemon writes a per-run random token (mode 0600, inside its 0700 state dir) and challenges every connection with a fresh nonce; the extension reads the token itself (path shape validated) and answers with an HMAC over the nonces, and the daemon proves its own token knowledge back with a domain-separated HMAC the extension verifies. The raw token never crosses the wire, and a rogue process that binds the port cannot impersonate either side. A wrong answer always closes the socket.
Since v1.6.1 the extension also enforces its side: when it could read the
token, it refuses every request from a daemon that has not proven itself,
whether the daemon's auth.ok failed, never arrived (15 s window from the
challenge, since v1.6.2; 5 s in v1.6.1), or the peer did not offer hmac-v1
at all. The refusal is a clear error on each call plus a one-time toast. A
valid auth.ok that arrives after the window (a slow handshake, not a
rogue: a rogue cannot forge the MAC) upgrades the verdict, a second toast
says so, and requests resume without a reconnect. A connection that cannot read the token (the
browser web app, or a desktop install without the extension's external
interaction permission) has nothing to check and is still accepted on
Origin trust, matching pre-C4 behaviour. Set EDA_WS_AUTH=require in the
daemon's environment to refuse those too (hardened mode; desktop client
only, and the extension's external interaction permission must be
enabled).
Upgrade notes: a v1.6.x .eext never sends the raw token. A v1.6.1+
.eext against a pre-1.6.0 daemon refuses all requests until the daemon
is restarted on the new build (bridge_restart still works: the daemon
answers it without touching the extension). The daemon stays resident
across rebuilds while any MCP client is attached, so after a rebuild check
server_info: it reports daemonVersion, each instance's
extensionVersion, and versionMismatch. EasyEDA ignores a same-version
.eext reinstall, so bump the version before rebuilding.
Two QA passes on 2026-07-24
(QA-REPORT-2026-07-24.md,
QA-DEEP-REPORT-2026-07-24.md) drove a
further hardening round: document-switch verification before every routed
operation, pre-write backups on bulk supplier swaps, MCP risk annotations
on all ~100 tools, the mutual auth above, and assorted transport and
correctness fixes. See HANDOVER-2026-07-24.md
for the work-order trail. A third pass on 2026-08-23
(QA-REPORT-2026-08-23.md) verified that round
live and produced v1.6.1: request gating on daemon verification, version
reporting in server_info, in-place log rotation, and smaller fixes. A
fourth pass on 2026-09-06
(QA-REPORT-2026-09-06.md), after two weeks of
field use, produced v1.6.2: late-auth.ok recovery and a headless harness
for the extension's request pipeline. v1.6.3 fixed new-project imports,
v1.6.4 added the library footprint tools, and v1.6.5 made the bridge run on
native Windows (a named pipe in place of the Unix socket file). v1.6.9 moved
to the 0.4.26 API types (EasyEDA Pro 3.2.206) and fixed the extension's
handshake there: 3.2.206 sandboxes have no crypto.subtle, so the HMAC now
falls back to a built-in SHA-256. It also fixed the default Gerber and
ODB++ layer set, which had left out silk, mask, paste, outline and plane
layers, and pad, region, via and fill parameters that never reached EasyEDA
in the form it needs, and it guards rule-config saves. Fill and region
results are now read back from the board, because EasyEDA's reply echoes
values it did not keep, and validation understands the {header}||{body}
lines EasyEDA Pro 3 uses for live documents. New tool: pour rebuild, though
on 3.2.206 EasyEDA cannot rebuild pours created through the API.
Environment variables
All knobs are daemon/server side; the extension has no environment access.
Variable | Default | Purpose |
|
| State dir (UDS socket, pid file, ws-token, bridge.log). On Windows the socket is a named pipe, |
|
| Daemon WS port. The extension always dials 16168 (it cannot see env vars), so changing this strands it: test use only |
| unset |
|
| unset |
|
|
| Daemon exits this many seconds after the last MCP client disconnects ( |
|
| Daemon entry override (tests point it at the .ts source) |
|
| Per-RPC extension timeout; the MCP proxy's call timeout derives from it (3x + 30 s). |
|
| Git-tracked backup repo for destructive operations |
|
| Where unknown schema tags are logged for schema growth |
Install from source
Students: use the release download instead. This is for changing the code.
git clone https://github.com/sheares/easyeda-mcp-fix.git
cd easyeda-mcp-fix
npm install
npm test # 208 tests
npm run smoke # after a build: starts the bundled server and a real bridge
npm run build # produces dist/ and build/dist/easyeda-agent-mcp-server_vN.N.N.eextThen in EasyEDA Pro (v3):
Advanced → Extension Manager → Import the built
.eextfrombuild/dist/. (EasyEDA Pro v2: Settings → Extensions → Extension Manager → Import Extension.)Select the extension and turn on External Interactions and Show in top menu.
Open a schematic or PCB and click Claude → Connect Claude.
Register the server with your MCP client. For Claude Code:
claude mcp add --scope user easyeda node "$(pwd)/dist/mcp-server/index.js"The bridge daemon is spawned automatically on the first tool call and
listens on 127.0.0.1:16168. dist/ is fully bundled (no
node_modules needed at run time), which is what the release zip ships.
Same-version reinstalls are a no-op in EasyEDA Pro. Bump the version in
extension.json before rebuilding if you want your changes to take
effect.
Provenance
Base:
javawizard/easyeda-agent-mcp-serverat commit3b8f2e5(the extended fork with per-requestdocumentparam dispatch already threaded throughws-client.ts).Original:
QuincySx/easyeda-agent-mcp-server.MIT licence, inherited. See
LICENSE.
What's inside
src/
mcp-server/ the MCP server (TypeScript, stdio transport)
bridge-daemon/ the WebSocket bridge between MCP server and extension
extension/ the EasyEDA Pro extension (.eext), incl. bug-fix handlers
lib/ schematic editing library (start at src/lib/README.md)
skills/
pcb-lint/ Claude Code skill: board design-hygiene checks
docs/ student guide, .esch / .epcb / .epro file format reference
dev-notes/ audit, QA reports and handover work orders
examples/ working examples using the editing library
tests/ 208 tests (node --test, ts-node) + smoke-bundle.jsTwo distinct pieces
1. The MCP server + extension
A pair of programs connected over WebSocket:
The MCP server runs as a stdio process spawned by an MCP client. It exposes EasyEDA operations as MCP tools.
The
.eextextension runs inside EasyEDA Pro (browser or desktop). It connects to the MCP server's WebSocket and dispatches API calls to EasyEDA Pro's internaleda.*namespace.
The server exposes ~100 tools covering schematic primitives, PCB
primitives, libraries, manufacture exports, DRC and document I/O.
Multiple EasyEDA Pro instances can share one daemon; every tool takes an
optional instance_id and document param for cross-tab routing.
Two tool families are worth calling out for high-throughput workflows:
document_get_source/document_set_sourceread and write the entire document as a string in EasyEDA's internal NDJSON format.document_save_to_file/document_load_from_filedo the same via local files (avoids MCP payload size limits).project_export_file/project_import_fileread and write entire.eproprojects as ZIP archives. A new-project import is saved to the team/workspace of the project open in the target window (fixed in v1.6.3: before that, EasyEDA silently rejected every new-project import).sch_export_bomreturns the schematic-side BOM as parsed rows (the source of truth for supplier metadata), handy for verifying BOM integrity after batch edits.sch_swap_supplier_partdoes a filter-and-replace on supplier metadata across matched components in one call, reusing the bug-1 metadata guard so nothing else is wiped; supportsdryRunfor a preview before the real swap.
2. The schematic editing library
src/lib/ is an in-tree TypeScript library for editing EasyEDA Pro
schematics by manipulating the raw NDJSON format directly. It exists
because EasyEDA's per-operation API is too slow for bulk edits; the
library lets you pull the document source, modify it locally, and push it
back in a single round trip.
Its Zod schemas ARE wired into the MCP tools: document_set_source and
document_load_from_file uploads are validated against them (strict by
default), and document_validate exposes the check directly (see
src/bridge-daemon/tools/schema-tools.ts). The writer API itself is not
exposed as MCP tools (intentional); the intended workflow:
1. project_export_file → /tmp/myproject.epro
2. unzip /tmp/myproject.epro -d /tmp/myproject/
3. ts-node a script that uses loadSchematic + SchematicWriter
4. document_load_from_file → push the result back into EasyEDARead src/lib/README.md for the API tour and gotchas.
Run examples/add-fpga-config-resistors.ts to see it in action.
Building
npm install
npm run typecheck # type-check both server and extension
npm run compile # build to dist/
npm run build # build + package extension into .eext file
npm test # run the full test suite
npm start # run the MCP server (usually launched by an MCP client)File format reference
docs/schematic-format.md documents the
.esch schematic format: coordinate system (math coordinates: +X
right, +Y up, CCW rotation), element line formats (COMPONENT,
ATTR, WIRE, PIN, FONTSTYLE, HEAD), the netport recipe, and
the gotchas discovered the hard way (junction wires required at
component-to-component connections, every component needs a non-empty
Unique ID, some components resolve their symbol via project.json
rather than a Symbol ATTR).
Available Tools
104 toolsbridge_restartADestructive
Restart the EasyEDA bridge daemon. Use this only after the bridge-daemon code itself has changed (new tools, fixed handler logic, etc.) and you want the new code loaded without manually killing the process.
DO NOT use this just because the EasyEDA browser extension was reloaded — the extension reconnects to the existing daemon over WebSocket on its own. The daemon doesn't need restarting for that.
SIDE EFFECTS — please be aware before invoking:
Every other Claude Code session sharing this daemon also loses its connection mid-flight. Any tool call in progress (in any session) will fail with a connection-dropped error.
The EasyEDA extension's WebSocket drops and reconnects (typically within a second, capped at 15s). Tool calls landing during that window will fail.
Your own MCP proxy reconnects transparently and re-lists tools, so the next call after this one will Just Work — but the call itself returns before the new daemon is necessarily up.
Returns { ok, pidWas, message } before the daemon exits (~100ms grace for response to flush).
Inputs: reason.
document_get_sourceARead-onlyIdempotent
Get the raw source code of the currently active document (schematic page, PCB, or panel). Returns the document as a string in EasyEDA's internal format (on EasyEDA Pro 3, one {header}||{body} line per record). Use editor_open_document to switch to the desired document first, then call this tool. The source can be modified and written back with document_set_source.
For schematic and PCB documents, the source is also run through the schema validator as a side effect — any unknown tags get logged to ~/.easyeda-schema-discovery.jsonl so we can grow the schema. The response itself is unchanged. Use document_validate for a structured validation report.
FAST-BATCH WORKFLOW: for making many changes at once, it is much faster to export the document or project (document_save_to_file / project_export_file), edit the raw source on disk, then re-upload (document_load_from_file / project_import_file) than to issue many small per-primitive MCP calls. Formats differ: on EasyEDA Pro 3, document_save_to_file returns {header}||{body} lines, while the .epro from project_export_file holds newline-delimited JSON arrays, which is what the src/lib editing library reads. Every destructive upload is auto-backed-up to a local git repo first — the response includes a backup SHA you can use to find the prior state if the edit goes wrong. Upload tools accept validate='off'|'warn'|'strict' (default 'strict') which runs the Zod schema on the new source — see document_validate for standalone validation.
Inputs: document (required), instance_id.
document_load_from_fileADestructive
Load document source from a local file and push it into the currently active document. Reads the file from disk and calls setDocumentSource to replace the document contents. The file must contain valid EasyEDA document source (same format as document_get_source / document_save_to_file). WARNING: This replaces the entire document. A backup of the prior state is taken automatically (after validation passes) and committed to a local git-tracked repo — the returned backup.sha references the pre-edit state. Validation runs for schematic and PCB documents (documentType 1 and 3); other types skip with a status.
FAST-BATCH WORKFLOW: for making many changes at once, it is much faster to export the document or project (document_save_to_file / project_export_file), edit the raw source on disk, then re-upload (document_load_from_file / project_import_file) than to issue many small per-primitive MCP calls. Formats differ: on EasyEDA Pro 3, document_save_to_file returns {header}||{body} lines, while the .epro from project_export_file holds newline-delimited JSON arrays, which is what the src/lib editing library reads. Every destructive upload is auto-backed-up to a local git repo first — the response includes a backup SHA you can use to find the prior state if the edit goes wrong. Upload tools accept validate='off'|'warn'|'strict' (default 'strict') which runs the Zod schema on the new source — see document_validate for standalone validation.
Inputs: document (required), filePath (required), validate, instance_id.
document_save_to_fileA
Save the source code of the currently active document to a local file. Fetches the document source from EasyEDA and writes it directly to disk. The file will contain the document in EasyEDA's internal format (on EasyEDA Pro 3, one {header}||{body} line per record; the src/lib editing library cannot read this, so use project_export_file for library edits). Use document_load_from_file to push a modified file back.
For schematic and PCB documents, the source is also run through the schema validator in warn mode — the returned JSON includes a validation report, and any unknown tags are logged to ~/.easyeda-schema-discovery.jsonl. Since this is a download (EasyEDA's output), a schema mismatch means our schema is missing coverage, not that the data is bad.
FAST-BATCH WORKFLOW: for making many changes at once, it is much faster to export the document or project (document_save_to_file / project_export_file), edit the raw source on disk, then re-upload (document_load_from_file / project_import_file) than to issue many small per-primitive MCP calls. Formats differ: on EasyEDA Pro 3, document_save_to_file returns {header}||{body} lines, while the .epro from project_export_file holds newline-delimited JSON arrays, which is what the src/lib editing library reads. Every destructive upload is auto-backed-up to a local git repo first — the response includes a backup SHA you can use to find the prior state if the edit goes wrong. Upload tools accept validate='off'|'warn'|'strict' (default 'strict') which runs the Zod schema on the new source — see document_validate for standalone validation.
Inputs: document (required), filePath (required), instance_id.
document_set_sourceADestructive
Replace the source code of the currently active document. Accepts the full document source as a string (same format returned by document_get_source). Returns { success, backup: { sha, path }, validation: {...} } on success, or throws if validation aborts the upload or the pre-edit backup could not be written. WARNING: This replaces the entire document. Always get the current source first, modify it, then set it back. A backup of the prior state is taken automatically before the replacement (after validation passes) and committed to a local git-tracked repo — the returned backup.sha references the pre-edit state. Validation runs for schematic and PCB documents (documentType 1 and 3); other types skip with a status.
FAST-BATCH WORKFLOW: for making many changes at once, it is much faster to export the document or project (document_save_to_file / project_export_file), edit the raw source on disk, then re-upload (document_load_from_file / project_import_file) than to issue many small per-primitive MCP calls. Formats differ: on EasyEDA Pro 3, document_save_to_file returns {header}||{body} lines, while the .epro from project_export_file holds newline-delimited JSON arrays, which is what the src/lib editing library reads. Every destructive upload is auto-backed-up to a local git repo first — the response includes a backup SHA you can use to find the prior state if the edit goes wrong. Upload tools accept validate='off'|'warn'|'strict' (default 'strict') which runs the Zod schema on the new source — see document_validate for standalone validation.
Inputs: source (required), document (required), validate, instance_id.
document_validateARead-onlyIdempotent
Validate a document's source against the Zod-backed EasyEDA schema. Runs on the currently active document by default, or on a local file if filePath is provided. Schematic (.esch, documentType=1) and PCB (.epcb, documentType=3) documents are validated; other types return a "skipped" report with a reason. Unknown tags (shapes the schema doesn't cover yet) are appended to the discovery log at ~/.easyeda-schema-discovery.jsonl (override via EDA_DISCOVERY_LOG).
Returns a JSON-serializable report: { docType, lineCount, knownCount, unknownTagCount, invalidCount, samples: { unknownTags, invalid } }. Known issues are samples of known tags whose shape failed validation (typically writer bugs); unknowns are tags not yet in the schema vocabulary.
Inputs: document (required), filePath, instance_id.
editor_get_current_documentARead-onlyIdempotent
Get detailed info about the currently focused document. For schematic pages, includes parent schematic info. For PCBs, includes associated board info.
Inputs: instance_id.
editor_get_open_tabsARead-onlyIdempotent
Get all currently open tabs in the editor, with the active tab marked. Also returns the split screen structure.
Inputs: instance_id.
editor_open_documentAIdempotent
Open/navigate to a specific document by UUID. Works for schematic page UUIDs, PCB UUIDs, and panel UUIDs.
Inputs: documentUuid (required), instance_id.
lib_device_copyA
Copy a library device from one library to another. Returns the new device UUID. Whether the device's symbol/footprint are deep-copied or referenced cross-library is yet to be confirmed empirically.
Inputs: deviceUuid (required), libraryUuid (required), targetLibraryUuid (required), instance_id, +1 more.
lib_device_deleteADestructive
Delete a library device. Does NOT delete its referenced symbol/footprint. IRREVERSIBLE: no undo, and no backup snapshot is taken (library assets are not documents). Record the device data with lib_get_device first if you may need to restore it. Returns boolean success.
Inputs: deviceUuid (required), libraryUuid (required), instance_id.
lib_device_modifyAIdempotent
Modify a library device — re-bind its symbol/footprint, or change name/classification/description/properties. Pass only the fields you want to change. Pass null to clear an optional field. Use the association arg to swap to a different symbol or footprint UUID.
Inputs: deviceUuid (required), libraryUuid (required), property, deviceName, +3 more.
lib_footprint_getARead-onlyIdempotent
Get a library footprint's metadata (uuid, library, name, classification, description) by UUID. Read the source itself by opening the footprint with lib_footprint_open_in_editor and calling document_get_source on the returned tabId.
Inputs: footprintUuid (required), instance_id, libraryUuid.
lib_footprint_open_in_editorAIdempotent
Open a library footprint in the EasyEDA editor as a tab. Returns the new tabId: use it as the document UUID for document_get_source / document_save_to_file. Only footprints in a personal, team or project library can be opened (system-library ones are refused).
Inputs: libraryUuid (required), footprintUuid (required), instance_id, splitScreenId.
lib_footprint_update_document_sourceADestructive
Replace a library footprint's entire source. IRREVERSIBLE: no undo, and no backup snapshot is taken (library assets are not documents). Read and save the current source first (lib_footprint_open_in_editor + document_save_to_file). The footprint must live in a library you can write to (personal/team/project). Returns boolean success.
Inputs: libraryUuid (required), footprintUuid (required), documentSource (required), instance_id.
lib_get_all_librariesBRead-onlyIdempotent
Get a list of all available component libraries with their UUIDs and names
Inputs: instance_id.
lib_get_deviceARead-onlyIdempotent
Get detailed information about a specific device by its UUID, including symbol, footprint, and all properties
Inputs: deviceUuid (required), instance_id, libraryUuid.
lib_get_device_by_lcscBRead-onlyIdempotent
Get device(s) by LCSC C-number(s). Useful for finding specific components like "C17414" for a 2.2k resistor.
Inputs: lcscIds (required), instance_id, libraryUuid.
lib_get_personal_library_uuidARead-onlyIdempotent
Get the UUID of the user's personal library (returns undefined on private deployments)
Inputs: instance_id.
lib_get_project_library_uuidARead-onlyIdempotent
Get the UUID of the current project's library (returns undefined if no project is open)
Inputs: instance_id.
lib_get_system_library_uuidARead-onlyIdempotent
Get the UUID of the system (built-in) component library
Inputs: instance_id.
lib_search_deviceARead-onlyIdempotent
Search the component library for devices by keyword. Returns a list of matching components with their UUIDs, names, descriptions, and package info.
Inputs: key (required), page, instance_id, itemsOfPage, +1 more.
lib_symbol_copyA
Copy a library symbol from one library to another (e.g. system → personal). Returns the new symbol UUID. Fails if newSymbolName collides in the target library.
Inputs: symbolUuid (required), libraryUuid (required), targetLibraryUuid (required), instance_id, +1 more.
lib_symbol_deleteADestructive
Delete a library symbol. IRREVERSIBLE: no undo, and no backup snapshot is taken (library assets are not documents). Fetch and save the symbol source with lib_symbol_get first if you may need to restore it. Returns boolean success.
Inputs: symbolUuid (required), libraryUuid (required), instance_id.
lib_symbol_getARead-onlyIdempotent
Get a library symbol's metadata (name, classification, description) by UUID. Does NOT return the .esym source — use lib_symbol_open_in_editor + document_get_source for that.
Inputs: symbolUuid (required), instance_id, libraryUuid.
lib_symbol_open_in_editorAIdempotent
Open a library symbol in the EasyEDA editor as a tab. Returns the new tabId — use that as the document UUID for document_get_source. Only symbols in a personal, team or project library can be opened; EDA Pro refuses system-library symbols (the call errors rather than returning a tabId), so lib_symbol_copy one into your own library first.
Inputs: symbolUuid (required), libraryUuid (required), instance_id, splitScreenId.
lib_symbol_update_document_sourceADestructive
Replace a library symbol's entire .esym source. IRREVERSIBLE: no undo, and no backup snapshot is taken (library assets are not documents). Fetch and save the current source with lib_symbol_get first if you may need to restore it. The symbol must live in a library you can write to (personal/team/project). Returns boolean success.
Inputs: symbolUuid (required), libraryUuid (required), documentSource (required), instance_id.
list_instancesARead-onlyIdempotent
List all connected EasyEDA Pro instances with their current state (project, active document, open tabs). Use this to find the instance_id you need for other tools when multiple instances are connected.
Inputs: no named parameters.
pcb_canvas_originAIdempotent
Get or set the canvas origin offset relative to data origin. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: action (required), document (required), offsetX, offsetY, +1 more.
pcb_clear_selectionBIdempotent
Clear all selection in the PCB editor
Inputs: document (required), instance_id.
pcb_convert_coordinatesARead-onlyIdempotent
Convert between canvas coordinates and data coordinates. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: x (required), y (required), document (required), direction (required), +1 more.
pcb_create_arcA
Create an arc track segment on the PCB. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: net (required), endX (required), endY (required), layer (required), +6 more.
pcb_create_fillA
Create a fill region on the PCB. The result is read back from the board, and notApplied lists any requested value EasyEDA did not keep (EasyEDA Pro 3.2.206 stores every fill as solid with a 0.2 outline width, whatever fillMode and lineWidth say). Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: layer (required), polygon (required), document (required), net, +3 more.
pcb_create_padA
Create a standalone pad on the PCB. pad (the shape) is required; sizes and hole dimensions are in mil. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Shapes: ['ELLIPSE'|'OVAL'|'NGON', width, height], ['RECT', width, height, cornerRadius], or ['POLYGON', source] where source is [{x, y}, ...] or a raw L-mode source array. Holes: ['ROUND', diameter] or ['SLOT', width, height]; null or omitted for an SMD pad.
Examples:
SMD pad: layer 1, padNumber "1", pad ['ELLIPSE', 60, 60], hole null.
Through-hole pad: layer 12 (Multi), padNumber "1", pad ['ELLIPSE', 80, 80], hole ['ROUND', 35], metallization true.
Inputs: x (required), y (required), pad (required), layer (required), +10 more.
pcb_create_polyline_trackA
Create a multi-segment polyline track defined by a series of points. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: net (required), layer (required), polygon (required), document (required), +2 more.
pcb_create_pourA
Create a copper pour region on the PCB. Two upstream EDA bugs to note: (1) pours reflow using the design-rule snapshot taken when the document was opened, so rules written via the API do not affect reflow until the PCB document is closed and reopened (pro-api-sdk issue #34); reopen before rebuilding pours after rule changes. (2) Rebuilding a pour does not cut internal-plane anti-pads for different-net vias created after plane generation (issue #32); regenerate the plane instead. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: net (required), layer (required), polygon (required), document (required), +6 more.
pcb_create_regionA
Create a design rule region (keepout/constraint area) on the PCB. The result is read back from the board, and notApplied lists any requested value EasyEDA did not keep (EasyEDA Pro 3.2.206 keeps the rule types but not regionName or lineWidth). Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: layer (required), polygon (required), document (required), ruleType, +3 more.
pcb_create_trackA
Create a single track segment (line) between two points on a specified layer and net. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: net (required), endX (required), endY (required), layer (required), +5 more.
pcb_create_viaA
Create a via at the specified position. Warning (upstream EDA bug, pro-api-sdk issue #32): if an internal plane (PLANE layer) has already been generated, a via on a different net created afterwards does NOT get its anti-pad cut. Rebuilding pours does not fix it; DRC reports "Plane Zone to Via". Regenerate the internal plane after placing vias. This is a fabrication risk, so do not ship until that DRC error is clear. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: x (required), y (required), net (required), diameter (required), +4 more.
pcb_delete_primitivesADestructive
Delete one or more PCB primitives by type and IDs. Irreversible via this API: there is no undo call. The whole document is snapshotted to the local backup repo first; the response includes the backup SHA for recovery.
Inputs: ids (required), type (required), document (required), instance_id.
pcb_exportARead-onlyIdempotent
Export the PCB design in various formats. Returns { fileName, data (Base64), size }.
BEFORE generating any fabrication output (gerber, odbplus, drill, pick_and_place): run pcb_run_drc (and sch_run_drc) and resolve all violations. Clearance DRC alone is not sufficient — this fork exists partly because API-drawn tracks passed clearance DRC while being electrically dead to their SMD pads; only a No-Connection/connectivity check surfaced it. Include connectivity checks in the DRC run before shipping.
Formats: dsn (for FreeRouting), gerber (manufacturing), bom (bill of materials), pick_and_place (assembly), 3d (STEP/OBJ), pdf, netlist, dxf, altium, pads, odbplus (ODB++ archive with stackup+nets), ipc_d_356 (netlist test format), flying_probe, test_point, autoroute_json, autolayout_json. Use fileType for sub-formats: "xlsx"/"csv" (bom, pick_and_place, test_point), "step"/"obj" (3d).
WARNING: response is Base64 in the MCP reply — for large outputs (gerber zips, 3d STEP) prefer pcb_export_to_file which writes straight to disk.
Most formats accept extra options forwarded as-is to the underlying EasyEDA getXxxFile call. Common ones (unit values are the literal strings "mm" / "inch" / "mil"):
gerber: { unit: "mm" | "inch", colorSilkscreen, digitalFormat: {integerNumber, decimalNumber}, other: {metallicDrillingInformation, nonMetallicDrillingInformation, drillTable, flyingProbeTestingFile}, layers: [{layerId, isMirror}], objects: [...] }
odbplus: { unit: "inch", otherData: {metallizedDrilledHoles, nonMetallizedDrilledHoles, drillTable, flyingProbeTestFile}, layers: [{layerId, mirror}], objects: [{objectName}] }
pick_and_place:{ unit: "mm" | "mil" }
3d: { element: [...], modelMode: "Outfit" | "Parts", autoGenerateModels }
bom: { template, filterOptions, statistics, property, columns }
dxf: { layers: [{layerId, mirror}], objects: [...] }
Omit options to get sensible defaults. For gerber and odbplus, omitting layers exports
every layer in use that is a copper (signal or plane), silkscreen, solder-mask or paste-mask
layer, plus the board outline. Layers that are in use but hidden in the editor are still
included; unused layers and assembly/document layers are not — unlike EasyEDA's raw default which silently drops inner
copper even on 4L+ boards.
CAUTION: options keys cannot override the top-level document/instance_id routing fields — those always take precedence to prevent accidental cross-document export.
Inputs: format (required), document (required), options, fileName, +2 more.
pcb_export_to_fileA
Export the PCB design in various formats directly to a local file path — preferred over pcb_export when the output is large (gerber/odbplus zips, 3d STEP, pdf), since it avoids shipping the bytes back through the MCP response as Base64.
BEFORE generating any fabrication output: run pcb_run_drc (and sch_run_drc) and resolve all violations. Clearance DRC alone is not sufficient — include connectivity/No-Connection checks; see pcb_export for why.
Returns { saved: path, size, originalName, format }.
Formats: same as pcb_export. See pcb_export for option shapes.
Most formats accept extra options forwarded as-is to the underlying EasyEDA getXxxFile call. Common ones (unit values are the literal strings "mm" / "inch" / "mil"):
gerber: { unit: "mm" | "inch", colorSilkscreen, digitalFormat: {integerNumber, decimalNumber}, other: {metallicDrillingInformation, nonMetallicDrillingInformation, drillTable, flyingProbeTestingFile}, layers: [{layerId, isMirror}], objects: [...] }
odbplus: { unit: "inch", otherData: {metallizedDrilledHoles, nonMetallizedDrilledHoles, drillTable, flyingProbeTestFile}, layers: [{layerId, mirror}], objects: [{objectName}] }
pick_and_place:{ unit: "mm" | "mil" }
3d: { element: [...], modelMode: "Outfit" | "Parts", autoGenerateModels }
bom: { template, filterOptions, statistics, property, columns }
dxf: { layers: [{layerId, mirror}], objects: [...] }
Omit options to get sensible defaults. For gerber and odbplus, omitting layers exports
every layer in use that is a copper (signal or plane), silkscreen, solder-mask or paste-mask
layer, plus the board outline. Layers that are in use but hidden in the editor are still
included; unused layers and assembly/document layers are not — unlike EasyEDA's raw default which silently drops inner
copper even on 4L+ boards.
CAUTION: options keys cannot override the top-level document/instance_id routing fields — those always take precedence to prevent accidental cross-document export.
Inputs: format (required), document (required), filePath (required), options, +2 more.
pcb_get_all_netsCRead-onlyIdempotent
Get all net names in the PCB design
Inputs: document (required), instance_id.
pcb_get_all_primitivesARead-onlyIdempotent
Get all primitives of a specific type on the PCB, with optional filters. Filters by type: component(layer), track/polyline/arc(net,layer), via(net), pad(layer,net), pour/fill(layer,net), region(layer). Component fields: primitiveId, designator, name, layer, x, y, rotation, primitiveLock, addIntoBom. Track fields: primitiveId, net, layer, startX, startY, endX, endY, lineWidth. Via fields: primitiveId, net, x, y, holeDiameter, diameter, viaType. Pad fields: primitiveId, net, layer, padNumber, x, y.
Inputs: type (required), document (required), net, layer, +5 more.
pcb_get_component_pinsARead-onlyIdempotent
Get all pins/pads of a specific component by its primitive ID. Pin fields: primitiveId, padNumber, net, layer, x, y. Note (upstream EDA bug, pro-api-sdk issue #33): for components placed via the API in the current editing session, padNumber can read back null until the PCB document is closed and reopened.
Inputs: document (required), primitiveId (required), limit, fields, +2 more.
pcb_get_design_rulesBRead-onlyIdempotent
Get the current PCB design rule configuration (clearance, width, etc.)
Inputs: document (required), instance_id.
pcb_get_net_lengthBRead-onlyIdempotent
Get the total routed length of a specific net
Inputs: net (required), document (required), instance_id.
pcb_get_net_primitivesBRead-onlyIdempotent
Get all primitives (tracks, pads, vias, etc.) belonging to a specific net
Inputs: net (required), document (required), limit, types, +3 more.
pcb_get_net_rulesCRead-onlyIdempotent
Get net-specific design rules
Inputs: document (required), instance_id.
pcb_get_primitive_at_pointARead-onlyIdempotent
Get the primitive at a specific point on the PCB. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: x (required), y (required), document (required), instance_id.
pcb_get_primitives_by_idBRead-onlyIdempotent
Get one or more PCB primitives by their type and primitive ID(s)
Inputs: type (required), document (required), primitiveIds (required), limit, +3 more.
pcb_get_primitives_in_regionARead-onlyIdempotent
Get all primitives within a rectangular region on the PCB. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: top (required), left (required), right (required), bottom (required), +6 more.
pcb_get_selectedARead-onlyIdempotent
Get currently selected primitives in the PCB editor
Inputs: document (required), limit, fields, filter, +1 more.
pcb_highlight_netBIdempotent
Highlight a specific net in the PCB editor for visual inspection
Inputs: net (required), document (required), instance_id.
pcb_importBDestructive
Import routing or layout result files into the PCB (Base64-encoded). Formats: autoroute_json (JSON autoroute), autolayout_json (JSON autolayout), autoroute_ses (FreeRouting SES).
Inputs: data (required), format (required), document (required), fileName, +1 more.
pcb_import_changesADestructive
Import changes from schematic into the PCB (sync schematic to PCB). Warning (upstream EDA bug, pro-api-sdk issue #33): pads of components newly placed by this call can read back with a null pad number until the PCB document is reloaded, and DRC may report an unstructured "Netlist Error". Close and reopen the PCB document (or reload via editor_open_document) before reading pads of freshly placed components.
Inputs: document (required), uuid, instance_id.
pcb_manage_diff_pairsADestructive
Manage differential pair definitions. Actions:
get_all: get all differential pairs
create: create diff pair (name, positiveNet, negativeNet)
delete: delete diff pair (name)
rename: rename diff pair (originalName, newName)
modify_nets: modify positive/negative net (name, positiveNet and/or negativeNet)
Inputs: action (required), document (required), name, newName, +4 more.
pcb_manage_equal_length_groupsBDestructive
Manage equal-length net groups. Actions:
get_all: get all equal-length groups
create: create group (name, nets: string[]; color optional)
delete: delete group (name)
rename: rename group (originalName, newName)
add_net: add net(s) to group (name, net: string|string[])
remove_net: remove net(s) from group (name, net: string|string[])
Inputs: action (required), document (required), net, name, +5 more.
pcb_manage_layersADestructive
Manage PCB layers. Actions:
get_all: get all layers with properties
select: set active layer (layer: string)
set_visible: show layer(s) (layer optional; setOtherLayerInvisible optional for solo mode)
set_invisible: hide layer(s) (layer optional; setOtherLayerVisible optional)
lock: lock layer(s) (layer optional)
unlock: unlock layer(s) (layer optional)
set_copper_count: set copper layers (count: 2,4,6,...,32). WARNING: REDUCING the count permanently discards all copper (tracks, pours, vias' inner connections) on the removed inner layers. No undo, and no backup snapshot is taken. Export the board first (pcb_export_to_file or document_save_to_file) if the layers being removed hold routing.
modify: modify layer properties (layer: string, property: {name?, type?, color?, transparency?})
add_custom: add a new custom layer
remove: remove a custom layer (layer: string). WARNING: deletes the layer AND everything drawn on it. No undo, no backup snapshot. Export first if in doubt.
Inputs: action (required), document (required), count, layer, +4 more.
pcb_manage_net_classesADestructive
Manage net classes. Actions:
get_all: get all net class definitions
create: create net class (netClassName, nets: string[]; color optional)
delete: delete net class (netClassName)
rename: rename net class (originalName, newName)
add_net: add net(s) to class (netClassName, net: string|string[])
remove_net: remove net(s) from class (netClassName, net: string|string[])
Inputs: action (required), document (required), net, nets, +5 more.
pcb_manage_net_rulesADestructive
Manage net-specific design rules. Actions:
overwrite_net: overwrite net rules (netRules: array of net rule objects)
get_net_by_net: get net-by-net clearance rules
overwrite_net_by_net: overwrite net-by-net rules (netByNetRules: object)
get_region: get region-specific rules
overwrite_region: overwrite region rules (regionRules: array of region rule objects) Warning (upstream EDA bug, pro-api-sdk issue #34): overwritten rules read back correctly but do NOT affect pour reflow until the PCB document is closed and reopened. Reopen the document before rebuilding pours.
Inputs: action (required), document (required), netRules, instance_id, +2 more.
pcb_manage_pad_pair_groupsADestructive
Manage pad pair groups for length-matching. Actions:
create: create group (name, padPairs: [[padId1, padId2], ...])
delete: delete group (name)
rename: rename group (originalName, newName)
Inputs: action (required), document (required), name, newName, +3 more.
pcb_manage_rule_configADestructive
Manage DRC rule configurations. Actions:
get_current_name: get current active config name
get_by_name: get config by name (configurationName)
get_all: get all configs (includeSystem optional)
save: save config under a name (ruleConfiguration, configurationName; allowOverwrite optional)
overwrite_current: apply a config to the open board (ruleConfiguration); the document is backed up first
rename: rename config (originalName, newName)
delete: delete config (configurationName)
get_default_name: get default config name
set_default: set as default (configurationName) Only pass a configuration EasyEDA returned: take pcb_get_design_rules().config (the {config, name} result is also accepted) and edit it in place. A hand-built or malformed configuration is rejected before it reaches EasyEDA, because a failed save can corrupt EasyEDA's rule-config preference and hang Design Rules in every project; if that happens the error says so and gives the repair steps. Warning (upstream EDA bug, pro-api-sdk issue #34): saved rule changes read back correctly but do NOT affect pour reflow until the PCB document is closed and reopened. Reopen the document before rebuilding pours.
Inputs: action (required), document (required), newName, instance_id, +5 more.
pcb_modify_primitiveAIdempotent
Modify properties of a PCB primitive. Property keys vary by type:
via: net, x, y, holeDiameter, diameter, viaType ("through"/"blind"/"suture" or 0/1/2)
polyline: net, layer, lineWidth
arc: net, layer, startX, startY, endX, endY, arcAngle, lineWidth
pad: x, y, rotation, net, padNumber, layer
pour: net, layer, pourFillMethod, preserveSilos, pourName, pourPriority, lineWidth
fill: layer, net, fillMode ("solid"/"mesh"/"inner_electrical_layer" or 0/1/2), lineWidth
region: layer, ruleType (array of "no_components"/"no_wires"/"no_fills"/"no_pours"/"no_inner_layers"/"follow_region_rule" or 2/5/6/7/8/9), regionName, lineWidth Enum names are converted to the numeric values EasyEDA requires. Fill and region results are read back from the board, with notApplied listing any requested value EasyEDA did not keep. All types support: primitiveLock Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: type (required), document (required), property (required), primitiveId (required), +1 more.
pcb_modify_trackAIdempotent
Modify properties of an existing track segment (line). Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: document (required), primitiveId (required), net, endX, +6 more.
pcb_move_componentAIdempotent
Move and/or rotate a component. Can also change its layer (flip), lock status, designator, etc. Coordinates are PCB canvas coordinates in mil (1 mil = 0.001 inch), relative to the canvas origin: +X = rightward, +Y = upward. Lengths (widths, diameters) are also in mil. Use pcb_canvas_origin to read/set the origin offset and pcb_convert_coordinates to convert between canvas and data coordinates.
Inputs: document (required), primitiveId (required), x, y, +5 more.
pcb_rebuild_poursAIdempotent
Rebuild (re-fill) copper pours so they reflect the current tracks, pads, vias and rules. This replaces the manual "rebuild all copper" step in the EasyEDA app. Pass primitiveIds to rebuild specific pours, or omit it to rebuild every pour. Returns which pours were rebuilt and which failed with a reason, never the poured geometry. Note: on EasyEDA Pro 3.2.206, EasyEDA cannot rebuild a pour that was created through the API; the failure is reported per pour, with a note telling you to ask the user to rebuild all copper in the PCB editor (Shift+B). Warning (upstream EDA bug, pro-api-sdk issue #34): pours reflow using the design-rule snapshot taken when the document was opened, so rule changes written via the API do not take effect until the PCB document is closed and reopened; reopen it before rebuilding after rule changes. Rebuilding does not cut internal-plane anti-pads for different-net vias created after plane generation (issue #32).
Inputs: document (required), instance_id, primitiveIds.
pcb_run_drcARead-onlyIdempotent
Run Design Rule Check (DRC) on the PCB. Returns { passed, errors? }. Some EDA Pro builds report only a pass/fail boolean at runtime (upstream pro-api-sdk issue #27); in that case "errors" is absent and a note says per-violation detail is unavailable. Run this (with connectivity checks) before any fabrication export.
Inputs: document (required), ui, limit, fields, +4 more.
pcb_saveAIdempotent
Save the PCB document selected by the "document" parameter (the editor switches to it first, then saves the active document).
Inputs: document (required), instance_id.
pcb_select_netBIdempotent
Select all primitives of a specific net in the PCB editor
Inputs: net (required), document (required), instance_id.
pcb_zoom_to_boardBIdempotent
Zoom the viewport to fit the entire board outline
Inputs: document (required), instance_id.
project_export_fileA
Export the entire current project as a .epro file (ZIP archive) saved directly to a local path. The .epro file contains: project.json (manifest with board/schematic/PCB associations), SHEET/ (schematics), PCB/ (layouts), SYMBOL/ (component symbols), FOOTPRINT/ (footprints), INSTANCE/ (per-instance attribute overrides), and more. All internal files are human-readable newline-delimited JSON arrays.
FAST-BATCH WORKFLOW: for making many changes at once, it is much faster to export the document or project (document_save_to_file / project_export_file), edit the raw source on disk, then re-upload (document_load_from_file / project_import_file) than to issue many small per-primitive MCP calls. Formats differ: on EasyEDA Pro 3, document_save_to_file returns {header}||{body} lines, while the .epro from project_export_file holds newline-delimited JSON arrays, which is what the src/lib editing library reads. Every destructive upload is auto-backed-up to a local git repo first — the response includes a backup SHA you can use to find the prior state if the edit goes wrong. Upload tools accept validate='off'|'warn'|'strict' (default 'strict') which runs the Zod schema on the new source — see document_validate for standalone validation.
Inputs: filePath (required), fileType, instance_id.
project_get_structureARead-onlyIdempotent
Get the current project structure: boards (with their schematics/PCBs), standalone schematics with pages, standalone PCBs, and panels. Also shows which document is currently focused.
Inputs: instance_id.
project_import_fileADestructive
Import a project file (.epro) from a local path into EasyEDA Pro. Can import into an existing project (replacing its contents) or create a new project. A new project is saved to the same team/workspace as the project open in the target window (on the desktop client, the local projects folder); open any project there first. Supports EasyEDA Pro, Altium, KiCad, EAGLE, PADS, and LTspice formats. When importing into an existing project (existingProjectUuid set), a backup of the prior project state is taken automatically and committed to a local git-tracked repo — the returned backup.sha references the pre-import state.
FAST-BATCH WORKFLOW: for making many changes at once, it is much faster to export the document or project (document_save_to_file / project_export_file), edit the raw source on disk, then re-upload (document_load_from_file / project_import_file) than to issue many small per-primitive MCP calls. Formats differ: on EasyEDA Pro 3, document_save_to_file returns {header}||{body} lines, while the .epro from project_export_file holds newline-delimited JSON arrays, which is what the src/lib editing library reads. Every destructive upload is auto-backed-up to a local git repo first — the response includes a backup SHA you can use to find the prior state if the edit goes wrong. Upload tools accept validate='off'|'warn'|'strict' (default 'strict') which runs the Zod schema on the new source — see document_validate for standalone validation.
Inputs: filePath (required), fileType, instance_id, newProjectName, +2 more.
sch_create_componentA
Create a schematic component from a library device reference. Use lib_search_device or lib_get_device_by_lcsc first to get the component object. IMPORTANT: The component object must include uuid, symbolUuid, footprintUuid, AND libraryUuid — passing only {deviceUuid, libraryUuid} will fail with a validation error. Pass the full object returned by lib_get_device_by_lcsc with libraryUuid added (from lib_get_system_library_uuid).
Inputs: x (required), y (required), document (required), component (required), +6 more.
sch_create_net_flagA
Create one or more Power/Ground/AnalogGround/ProtectGround net flags in the schematic. Pass individual parameters for a single flag, or use "batch" array for multiple flags in one call.
Inputs: document (required), x, y, net, +6 more.
sch_create_net_portA
Create one or more IN/OUT/BI directional net ports in the schematic. Pass individual parameters for a single port, or use "batch" array for multiple ports in one call.
Inputs: document (required), x, y, net, +6 more.
sch_create_wireC
Create a wire in the schematic defined by a series of coordinate points
Inputs: line (required), document (required), net, color, +3 more.
sch_delete_componentADestructive
Delete one or more schematic components by their primitive IDs. Irreversible via this API: there is no undo call. The whole document is snapshotted to the local backup repo first; the response includes the backup SHA for recovery.
Inputs: ids (required), document (required), instance_id.
sch_delete_wireADestructive
Delete one or more wires by their primitive IDs. Irreversible via this API: there is no undo call. The whole document is snapshotted to the local backup repo first; the response includes the backup SHA for recovery.
Inputs: ids (required), document (required), instance_id.
sch_export_bomARead-onlyIdempotent
Export the schematic-side BOM as parsed rows (one object per BOM line, keyed by column header). The schematic BOM is the source of truth for supplier metadata — recommended for verifying BOM integrity after batch edits (e.g. confirm Supplier Part / LCSC numbers survived a sch_modify_component run). Columns follow the EasyEDA BOM template, e.g. "Designator", "Quantity", "Manufacturer Part", "Supplier Part". Supports filter/fields/limit on the rows (e.g. filter: {"Designator": "R*"}). For a PCB-side BOM file (xlsx/csv, base64), use pcb_export with format:"bom" instead.
Inputs: document (required), limit, fields, filter, +2 more.
sch_get_all_componentsARead-onlyIdempotent
Get all components in the schematic with their properties, positions, rotations, designators, etc. To identify what a component is, check: designator (e.g. "R1", "U3"), name (part name/number), manufacturer, manufacturerId (manufacturer part number), supplier, supplierId (supplier part number, e.g. JLCPCB/LCSC number), and footprint. All fields: primitiveId, componentType, designator, name, x, y, rotation, mirror, addIntoBom, addIntoPcb, footprint, manufacturer, manufacturerId, supplier, supplierId, net, otherProperty. otherProperty contains user-defined custom attributes — contents vary per component. Template expressions like ={Manufacturer Part} are automatically resolved to their actual values.
Inputs: document (required), limit, fields, filter, +5 more.
sch_get_all_wiresARead-onlyIdempotent
Get all wires in the schematic, optionally filtered by net name
Inputs: document (required), net, limit, fields, +2 more.
sch_get_componentCRead-onlyIdempotent
Get one or more schematic components by primitive ID(s)
Inputs: document (required), primitiveIds (required), refresh, instance_id, +1 more.
sch_get_component_pinsARead-onlyIdempotent
Get all pins of a schematic component by its primitive ID. Pin fields: primitiveId, pinNumber, name, net, x, y, rotation. Each pin includes a net field with the net name it is connected to (empty string if unconnected). Pins connected to $-prefixed nets (like $R11_1) are on unnamed nets that still carry real signals — use sch_get_connectivity with that net name to see what else is connected.
Inputs: document (required), primitiveId (required), limit, fields, +3 more.
sch_get_connectivityARead-onlyIdempotent
Get compact connectivity data: which nets connect which component pins, with resolved part names. Much smaller than sch_get_netlist — use this for connectivity questions. Returns nets (net → pin connections like "U3.2(GND)") and components (designator → part + pin assignments). Auto-generated net names (starting with $) are hidden from the nets section but still appear in component pin assignments. IMPORTANT: $-prefixed nets (like $R11_1, $U3_7) represent real electrical connections — they are unnamed nets where the designer didn't assign a net label. When investigating a component's full circuit context, you MUST look at $-prefixed nets in its pin assignments and trace them to see what else is connected. These often carry critical signals (reset lines, boot pins, enable pins) that would otherwise be invisible. Use the depth parameter (default 2) to automatically trace through $-prefixed nets and discover indirect connections — so by default, you already see one hop through unnamed nets (pull-ups, series resistors, boot/reset circuitry). Pass depth=1 to see only direct connections, or 3–5 to chase longer chains. The response includes a note field reminding you of the depth used.
Inputs: document (required), nets, depth, refresh, +2 more.
sch_get_netlistARead-onlyIdempotent
Get the raw schematic netlist in the specified format. WARNING: The JLCEDA format response is very large (100KB+). Prefer sch_get_connectivity for connectivity questions — it returns the same net/pin data in a much more compact format with resolved part names. Only use this tool when you need a specific netlist export format (Allegro, PADS, etc.) or the full raw netlist data.
Inputs: document (required), type, limit, fields, +2 more.
sch_get_primitiveBRead-onlyIdempotent
Get a schematic primitive by its ID with all properties
Inputs: id (required), document (required), instance_id.
sch_get_primitive_bboxBRead-onlyIdempotent
Get the bounding box of one or more schematic primitives
Inputs: document (required), primitiveIds (required), instance_id.
sch_get_primitive_typeBRead-onlyIdempotent
Get the type of a schematic primitive by its ID
Inputs: id (required), document (required), instance_id.
sch_get_selectedCRead-onlyIdempotent
Get all currently selected primitives in the schematic editor
Inputs: document (required), limit, fields, filter, +1 more.
sch_get_selected_idsARead-onlyIdempotent
Get primitive IDs of all currently selected primitives in the schematic editor
Inputs: document (required), instance_id.
sch_get_wireCRead-onlyIdempotent
Get one or more wires by primitive ID(s)
Inputs: document (required), primitiveIds (required), instance_id.
sch_import_changesCDestructive
Import changes from PCB back into the schematic
Inputs: document (required), instance_id.
sch_modify_componentAIdempotent
Modify properties of a schematic component (position, rotation, designator, etc.). Metadata is preserved automatically (bug-1 fix, this fork only): fields you do not pass (supplierId, otherProperty, manufacturer, manufacturerId, supplier, uniqueId) are snapshotted before the write and merged back, so a position-only edit no longer wipes the BOM row. Passing an explicit value (including null) still applies it. Stock EasyEDA does NOT do this — its modify() re-serialises from the property argument alone. LIMITATION: the "document" parameter cannot move a component between schematic pages. Passing a different page's UUID switches the editor but the underlying call fails (undefined.getState_ComponentType); cross-page moves still require a manual UI Cut, switch page, Paste.
Inputs: document (required), primitiveId (required), x, y, +12 more.
sch_modify_wireCIdempotent
Modify properties of an existing wire
Inputs: document (required), primitiveId (required), net, line, +4 more.
sch_run_drcARead-onlyIdempotent
Run Design Rule Check (DRC) on the schematic. Returns { passed, errors? }. Some EDA Pro builds report only a pass/fail boolean at runtime (upstream pro-api-sdk issue #27); in that case "errors" is absent and a note says per-violation detail is unavailable.
Inputs: document (required), limit, fields, filter, +3 more.
sch_saveCIdempotent
Save the current schematic document
Inputs: document (required), instance_id.
sch_select_primitivesAIdempotent
Select and highlight primitives in the schematic editor by designators, pins, or nets. Selection is additive — each call adds to the current selection. There is currently no programmatic way to clear the selection; the user must click on empty space in the editor to deselect. Pin format: "U1_1" (designator_pinNumber). Components selects the whole component, pins highlights just the pin, nets highlights the entire wire/net.
Inputs: document (required), nets, pins, components, +1 more.
sch_set_netlistCDestructive
Update the schematic netlist
Inputs: netlist (required), document (required), type, instance_id.
sch_swap_supplier_partADestructive
Bulk-swap supplier metadata on schematic components matching a filter. WARNING (field-confirmed): this swaps supplier METADATA only. The canvas symbol and its label stay those of the OLD part. Use this ONLY when the replacement is a true drop-in with identical schematic symbol and PCB footprint (e.g. same 100nF 0603 cap in a different reel). For any part with a different symbol, footprint, or pin count, delete the component and re-add it instead — otherwise the schematic and BOM will disagree with the canvas symbol/label. Uses the same bug-1 metadata guard as sch_modify_component: unspecified fields (otherProperty, uniqueId, position, symbol, etc.) are preserved via a snapshot-and-merge round trip, so a swap that only touches supplierId doesn't wipe the rest of the BOM row. Non-dry-run swaps snapshot first: the active document (or, with allSchematicPages, the whole project) is committed to the local backup repo before any write, and the response includes the backup SHA. Note the multi-page walk is not atomic — if a page fails to open mid-walk the swap aborts with earlier pages already written; use the backup SHA to recover. Typical uses: rotate to a cheaper LCSC alt (match: {supplierId: "C25804"}, replace: {supplierId: "C17414", manufacturerId: "..."}), or bulk-tag a designator prefix (match: {designator: "R*"}, replace: {manufacturer: "YAGEO"}). match: filter fields with the same semantics as read-tool filter — exact string, ["a","b"] OR-array, or "prefix*" glob. Any component field is accepted (designator, supplierId, manufacturerId, manufacturer, ...). Matching runs against RESOLVED values: fields stored as ={...} template expressions are resolved from the netlist before the filter applies, matching what sch_get_all_components shows. If the netlist cannot be fetched, matching falls back to raw stored values. replace: at least one of supplierId, manufacturerId, manufacturer, supplier. dryRun: if true, returns the matches with before/after but does NOT modify (and takes no backup). Recommended for the first pass. allSchematicPages: walk every schematic page instead of only the active one; original page is restored. Returns { dryRun, swappedCount, swapped:[{primitiveId, designator, page, before, after}], backup? }. Always re-run sch_export_bom afterward to confirm BOM integrity.
Inputs: match (required), replace (required), document (required), dryRun, +3 more.
server_infoARead-onlyIdempotent
Get MCP server status: daemon version, WebSocket port, connection state, connected instances (each with the version of the .eext it runs and the EasyEDA editor version), and allowed origins. versionMismatch is true when any connected extension runs a different version from the daemon; fix with a .eext reinstall (bump the version first, EasyEDA ignores same-version reinstalls) and/or bridge_restart.
Inputs: no named parameters.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 104 tools
Most tools target distinct resource+action pairs and the descriptions carefully carve out boundaries (e.g. pcb_export vs pcb_export_to_file, pcb_create_track vs pcb_create_polyline_track). A few overlaps remain, notably sch_get_selected vs sch_get_selected_ids, and the cluster of read tools (pcb_get_all_primitives, pcb_get_primitives_by_id, pcb_get_primitives_in_region, pcb_get_net_primitives, pcb_get_primitive_at_point) that require the agent to reason about which query shape fits. These are resolvable from descriptions but not trivially distinct.
A predictable prefix + verb_noun convention dominates: pcb_*, sch_*, lib_*, document_*, project_*, editor_*, with action-style managers like pcb_manage_*. A handful of outliers (server_info, list_instances, bridge_restart, pcb_canvas_origin) deviate from the prefix_action pattern, but the overall convention is readable and stable.
104 tools is far beyond a comfortable agent-selectable surface, even accounting for the genuinely large EDA domain (PCB fabrication, schematic capture, library management, projects, DRC/rules). While several tools already bundle actions (pcb_manage_*), the sheer volume forces the agent to wade through a very long list to find the right call, increasing misselection risk.
The surface covers the full lifecycle: read/create/modify/delete for PCB primitives, schematic components/wires/nets, library symbols/footprints/devices, plus DRC, design rules, net classes, diff pairs, equal-length groups, import/export across many formats, project structure, and git-backed backup/restore. No obvious dead ends for the stated EDA-automation purpose.
Maintenance
Related MCP Connectors
Design, route, check, review and export manufacturable PCBs from plain language; KiCad import.
8 Embedded & EDA MCP tools: UF2 merge, crash decoder, Intel HEX, CAN, Verilog/VCD, CMake.
20 engineering MCP tools: 3D STL/G-code, ELF/WASM, Verilog/VCD, systemd/seccomp, PDF repair.
EasyGerber brings AI printed circuit board (PCB) design, layout, and routing to MCP-compatible assistants. Describe a circuit or start from firmware pin assignments, search published electronic components, and build schematics using catalog parts with their footprints and available 3D models. Create and revise boards, generate layouts with automatic component placement and routing, inspect previews, and check saved layouts for blocking design issues. Export manufacturing ZIPs containing Gerber and drill files, a bill of materials, and component placement data, or download an editable EasyGerber (.egb) file. Start without signing up. Your agent uses one private board reference to create and continue a board, including catalog access, edits, layout, checks, previews, and exports, without a separate guest setup step or token to manage. To keep the board in your account or work with permitted saved personal or organization boards, complete EasyGerber sign-in and OAuth consent, then resume the same task. Account permissions, plan limits, and generation billing apply; support depends on your MCP client and installed integration.
Related MCP Servers
- AlicenseBqualityBmaintenanceProduction-grade MCP server for EasyEDA Pro that enables AI-assisted hardware design review, PCB inspection, BOM sourcing, and manufacturing export through 41 profile-gated tools.824,573 npm73AGPL 3.0
- AlicenseBqualityCmaintenanceEnables MCP clients to control EasyEDA Pro for schematic and PCB design through natural language, bridging the EasyEDA API without external AI or API keys.49MIT
- AlicenseNot gradedqualityCmaintenanceBridges JLCPCB/Lichuang EDA Pro with MCP clients to export and analyze schematic/PCB DRC, netlists, and BOMs, enabling automated diagnostics and data queries.4MIT
- AlicenseCqualityBmaintenanceEnables interaction with EasyEDA Pro by exposing 760 official API methods as MCP tools, along with plugin import and browser console debugging capabilities.500Apache 2.0