easyeda-copilot

English | [简体中文](README.zh-CN.md) | [Русский](README.ru.md)

# <img src="extension/images/logo.png" alt="" width="42"> EasyEDA Copilot

Extension sources, UI, resources and build configuration live in `extension/`; `mcp/` and `shared/` are sibling workspaces. Root build/dev commands remain the entry point. The `.eext` output remains in `build/dist/`. See [extension development](extension/README.md).

MCP-based engineering automation for native EasyEDA Pro and JLCEDA documents.

EasyEDA Copilot connects MCP-capable AI agents to real schematic and PCB data. It supports schematic generation and reorganization, component resolution, constraint-driven PCB placement, checkpoint-backed routing transactions, structured design inspection, recovery, and native EasyEDA DRC.

<p align="center">
  <a href="https://github.com/biosshot/easyeda-copilot/actions/workflows/build.yml">
    <img src="https://github.com/biosshot/easyeda-copilot/actions/workflows/build.yml/badge.svg" alt="Build status">
  </a>
  <a href="https://github.com/biosshot/easyeda-copilot/releases/latest">
    <img src="https://img.shields.io/github/v/release/biosshot/easyeda-copilot?label=release" alt="Latest release">
  </a>
  <a href="https://github.com/biosshot/easyeda-copilot/blob/main/LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-blue" alt="License">
  </a>
  <a href="https://discord.gg/AXCGjTDYkq">
    <img src="https://img.shields.io/badge/Discord-7289DA?logo=discord&logoColor=white" alt="Discord">
  </a>
  <a href="https://web.tribute.tg/d/PTf">
    <img src="https://img.shields.io/badge/Support%20development-Tribute-24A1DE" alt="Support EasyEDA Copilot development">
  </a>
</p>

<p align="center">
  <img src="docs/media/banner.gif" alt="EasyEDA Copilot creating and assembling an LDO schematic from a text specification">
</p>
<p align="center">
  <sub>Creating and assembling an LDO schematic from a text specification.</sub>
</p>

## Featured demonstration: BGA2869 2 GHz RF amplifier

A complete RF design workflow inside EasyEDA Pro: schematic organization, pin-level signal-path constraints, compact component placement, PCB routing, ground planes, and via stitching.

The RF ports are positioned on opposite board edges, the amplifier chain is kept ordered, and the bias network is placed close to the MMIC. The resulting components, tracks, vias, and copper zones remain editable as native EasyEDA objects.

https://github.com/user-attachments/assets/b3b3b25a-bc27-4654-8802-23775ff71735

## More demonstrations

These examples cover larger controller boards and existing-document workflows. Every result remains editable as a normal EasyEDA project rather than being exported as a rendered mockup.

### ESP32-C3 controller

A complete ESP32-C3 controller with power conversion, USB, CAN, RS-485, protected field I/O, external connectors, and antenna placement constraints.

The workflow demonstrates multi-page schematic generation, functional placement, board-edge and antenna constraints, power and signal routing, copper planes, via stitching, inspection, and DRC-driven repair.

<details open>
<summary><strong>Watch the ESP32-C3 workflow (69 seconds)</strong></summary>

https://github.com/user-attachments/assets/df1dd4e2-ee48-492c-badb-de2dc220ae41

</details>

### MIMXRT1011 controller

A dense four-layer microcontroller design demonstrating placement and routing around a high-pin-count MCU, multiple interfaces, decoupling groups, board-edge connectors, mounting holes, and mechanical access constraints.

<details open>
<summary><strong>Watch the MIMXRT1011 workflow (128 seconds)</strong></summary>

https://github.com/user-attachments/assets/757690b8-83cd-42c7-b88f-4db9ba2df010

</details>

### Schematic beautification

EasyEDA Copilot reads an existing schematic, identifies functional groups, saves a document checkpoint, and reassembles the page into named blocks while retaining its electrical connectivity and component identities.

<details open>
<summary><strong>Watch schematic beautification (13 seconds)</strong></summary>

https://github.com/user-attachments/assets/d77218e5-4f6f-42b8-bea4-7f7240f8f7f3

</details>

More editable examples are available on [OSHWLab](https://oshwlab.com/biosshot/edacopilotexamples).

## Quick start

### Requirements

- EasyEDA Pro Desktop;
- Node.js >=20.19;
- an MCP-capable client such as Codex or Claude Code.

### 1. Install the EasyEDA extension

Download the latest `.eext` package from [GitHub Releases](https://github.com/biosshot/easyeda-copilot/releases/latest).

In EasyEDA Pro:

1. Open `Settings -> Extensions -> Extensions Manager`.
2. Select `Import Extensions`.
3. Choose the downloaded `.eext` file.
4. Enable `External Interactions`.

<p align="center">
  <a href="docs/media/params.png">
    <img src="docs/media/params.png" alt="Enable External Interactions for EasyEDA Copilot" width="560">
  </a>
</p>

### 2. Add the MCP server

Codex:

```bash
codex mcp add easyeda-copilot -- npx -y easyeda-copilot-mcp
```

Claude Code:

```bash
claude mcp add easyeda-copilot -- npx -y easyeda-copilot-mcp
```

For generic MCP configuration and local builds, see the [MCP package documentation](mcp/README.md).

### 3. Open a project

1. Start the MCP client with EasyEDA Copilot enabled.
2. Open EasyEDA Pro and the target schematic or PCB document.
3. Ask the agent to inspect the currently opened EasyEDA project and begin the design workflow.

The extension discovers the local MCP bridge automatically. `Copilot -> MCP` pauses or resumes the connection.

## Capabilities

| Area            | Capabilities                                                                                                                                                                                                 |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Schematics      | Inspect the current page, create and complete circuits, reorganize existing schematics into functional blocks, and annotate designators across multiple pages                                                |
| Components      | Resolve EasyEDA components by manufacturer MPN or part UUID                                                                                                      |
| PCB placement   | Generate board geometry and constraint-driven placement using functional blocks, modules, pin proximity, ordered signal paths, edge placement, keepouts, mounting holes, thermal pads, and preserved objects |
| PCB routing     | Define net classes, signal and power nets, copper planes, differential pairs, matched groups, fanout, impedance intent, selective rerouting, and via stitching                                               |
| Inspection      | Render layer-aware PCB previews, highlight nets and components, and inspect routed length, track widths, layers, vias, pads, polygons, nearby components, and unrouted connections                           |
| Verification    | Read current DRC rules, run native EasyEDA DRC, inspect violations, and choose whether to keep, repair, or restore an applied result                                                                         |
| Project control | Inspect project trees, create and open projects or documents, synchronize editors, and select between multiple connected EasyEDA instances                                                                   |
| Long operations | Monitor, continue, reapply prepared results, or cancel long PCB placement and routing operations                                                                                                             |

## Checkpoints, transactions, and recovery

EasyEDA Copilot uses full-document checkpoints and explicit application boundaries to protect existing engineering work. Changes are previewed, applied to native EasyEDA documents, inspected, and then kept, repaired, or restored.

| Workflow                        | Protection and recovery behavior                                                                                                                  |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Source-based schematic assembly | Saves a full document checkpoint before modification and restores it automatically if assembly fails                                              |
| Schematic beautification        | Saves a checkpoint before page replacement and restores it automatically if replacement fails                                                     |
| Multi-page annotation           | Saves a checkpoint for every affected page and rolls modified pages back if the annotation transaction fails                                      |
| PCB placement                   | Produces mechanical and final previews, preserves existing board work, and saves a checkpoint before assembly                                     |
| PCB routing                     | Applies DRC rules, selected copper replacement, new tracks, vias, zones, synchronization, and native DRC inside one checkpoint-backed transaction |
| Routing application failure     | Restores the pre-routing checkpoint automatically                                                                                                 |
| Manual recovery                 | Lists, saves, and restores checkpoints explicitly for the current EasyEDA document                                                                |

Checkpoints contain the complete EasyEDA document source, not only a list of agent actions. Existing tracks, vias, and copper zones are preserved by default and treated as fixed routing obstacles. Copper is replaced only when a routing program explicitly selects the affect