easyeda-mcp-pro

<div align="center">

# easyeda-mcp-pro

<p>
  Production-grade MCP server for EasyEDA Pro: safe PCB design inspection, BOM sourcing, manufacturing export, and AI-assisted hardware review.
</p>

<p>
  <a href="https://www.npmjs.com/package/easyeda-mcp-pro">
    <img src="https://img.shields.io/npm/v/easyeda-mcp-pro.svg?logo=npm" alt="npm version" />
  </a>
  <a href="https://www.npmjs.com/package/easyeda-mcp-pro">
    <img src="https://img.shields.io/npm/dt/easyeda-mcp-pro?logo=npm&label=total%20downloads" alt="npm total downloads" />
  </a>
  <a href="https://www.npmjs.com/package/easyeda-mcp-pro">
    <img src="https://img.shields.io/node/v/easyeda-mcp-pro" alt="supported Node.js version" />
  </a>
  <a href="LICENSE">
    <img src="https://img.shields.io/npm/l/easyeda-mcp-pro.svg" alt="license" />
  </a>
  <a href="https://pnpm.io/">
    <img src="https://img.shields.io/badge/pnpm-11.5.1-blue.svg" alt="pnpm" />
  </a>
</p>

<p>
  <a href="https://github.com/oaslananka/easyeda-mcp-pro/actions/workflows/ci.yml">
    <img src="https://github.com/oaslananka/easyeda-mcp-pro/actions/workflows/ci.yml/badge.svg" alt="CI status" />
  </a>
  <a href="https://github.com/oaslananka/easyeda-mcp-pro/actions/workflows/deploy-docs.yml">
    <img src="https://github.com/oaslananka/easyeda-mcp-pro/actions/workflows/deploy-docs.yml/badge.svg" alt="Docs status" />
  </a>
  <a href="https://github.com/oaslananka/easyeda-mcp-pro/security/policy">
    <img src="https://img.shields.io/badge/security-policy-blue" alt="Security policy" />
  </a>
  <a href="https://scorecard.dev/viewer/?uri=github.com/oaslananka/easyeda-mcp-pro">
    <img src="https://api.scorecard.dev/projects/github.com/oaslananka/easyeda-mcp-pro/badge" alt="OpenSSF Scorecard" />
  </a>
    <a href="https://www.bestpractices.dev/projects/13406">
    <img src="https://www.bestpractices.dev/projects/13406/badge" alt="OpenSSF Best Practices" />
  </a>
</p>

<p>
  <a href="https://deepwiki.com/oaslananka/easyeda-mcp-pro">Ask DeepWiki</a> ·
  <a href="docs/ROADMAP.md">Roadmap</a> ·
  <a href="docs/OPENSSF_BEST_PRACTICES.md">OpenSSF evidence</a> ·
  <a href="docs/SECURITY_ASSURANCE_CASE.md">Security assurance case</a>
</p>

<p>
  <strong>Compliance docs:</strong>
  <a href="THIRD_PARTY_NOTICES.md">Third-Party Notices</a>
  ·
  <a href="docs/vendor-terms.md">Vendor Terms and Unsupported Workflows</a>
  ·
  <a href="docs/REMOTE_MCP_MODES.md">Remote MCP Modes</a>
</p>

<p>
  <a href="https://www.buymeacoffee.com/oaslananka">
    <img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=%E2%98%95&slug=oaslananka&button_colour=FFDD00&font_colour=000000&font_family=Inter&outline_colour=000000&coffee_colour=ffffff" height="28" alt="Buy me a coffee" />
  </a>
  &nbsp;&nbsp;
  <a href="https://github.com/oaslananka/easyeda-mcp-pro">
    <img src="https://img.shields.io/github/stars/oaslananka/easyeda-mcp-pro?style=for-the-badge&logo=github&label=Star%20on%20GitHub&color=FFA500&labelColor=181717" alt="Star on GitHub" />
  </a>
</p>

</div>

---

## Trust and Supply Chain

easyeda-mcp-pro keeps its public OpenSSF Best Practices evidence in [`docs/OPENSSF_BEST_PRACTICES.md`](docs/OPENSSF_BEST_PRACTICES.md) and its security assurance case in [`docs/SECURITY_ASSURANCE_CASE.md`](docs/SECURITY_ASSURANCE_CASE.md). The header badges link to workflow-backed signals only: CI, generated docs deployment, the project security policy, OpenSSF Best Practices self-certification, and the OpenSSF Scorecard. Release integrity evidence (npm provenance, signed-release status) is tracked in [`docs/RELEASE_VERIFICATION.md`](docs/RELEASE_VERIFICATION.md). Coverage, Test Analytics, and extension bundle monitoring are documented in [`docs/CODECOV_ANALYTICS.md`](docs/CODECOV_ANALYTICS.md).

**Current OpenSSF Best Practices status:** Passing (100%) — see [live badge](https://www.bestpractices.dev/projects/13406) and [Silver evidence map](docs/OPENSSF_BEST_PRACTICES.md#silver-evidence) for in-progress Silver criteria.

---

## Quick Start

The fastest way to install and configure `easyeda-mcp-pro` for your favorite AI assistant or IDE:

1. **Auto-configure your MCP client:**

   ```bash
   npx easyeda-mcp-pro setup all
   ```

   _This detects and configures Claude Desktop, Cursor, VS Code, Windsurf, Cline, Gemini, Zed, etc. to run the MCP server automatically._
   _(Or run for a specific client, e.g., `npx easyeda-mcp-pro setup claude`)_

2. **Locate and install the EasyEDA Pro bridge extension:**

   ```bash
   npx easyeda-mcp-pro extension --open
   ```

   _This opens the folder containing the extension package `easyeda-bridge-extension.eext`. Import it via **EasyEDA Pro → Settings → Extensions → Extension Manager**._

3. **Connect the bridge:**
   In EasyEDA Pro, click **MCP Bridge → Connect** in the menu bar.

For advanced configurations, manual instructions, and specific clients, see [Installation & Client Configuration](#installation--client-configuration).

---

## Overview

easyeda-mcp-pro is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that bridges AI assistants with hardware design workflows in EasyEDA Pro. It exposes up to 60 profile-gated MCP tools for schematic inspection and editing, controlled EasyEDA Pro API calls, BOM management, design rule checks, PCB board analysis, fabrication exports, diagnostics, and supplier integration.

The server connects to EasyEDA Pro via a WebSocket bridge extension, enabling real-time access to open project data. It integrates with JLCPCB, LCSC, Mouser, and DigiKey for BOM sourcing and pricing.

### Key Capabilities

| Area            | What you can do                                                       |
| --------------- | --------------------------------------------------------------------- |
| **Schematic**   | List nets/components, search and place devices, edit wires/primitives |
| **BOM**         | Generate, validate, export, and source bill of materials              |
| **DRC/ERC**     | Run design rule and electrical rule checks                            |
| **Board**       | Inspect layers, stackup, dimensions, features                         |
| **Export**      | Export Gerbers, pick-and-place, PDF, netlist                          |
| **Diagnostics** | Health check, bridge status, API inventory, capabilities, self-test   |

---

## Prerequisites

- **Node.js**: Node.js 24.x is required; repository automation is pinned to **24.18.0**.
- **pnpm**: local development and automation require exactly **11.5.1**.

Prepare the supported runtime before installing dependencies:

```bash
nvm install 24.18.0
nvm use 24.18.0
corepack enable
corepack prepare pnpm@11.5.1 --activate
node scripts/check-runtime.mjs --require-pnpm
```

- **EasyEDA Pro** with the bundled bridge extension installed and running
- For supplier integration: API credentials from JLCPCB, LCSC, Mouser, or DigiKey

---

## Installation & Client Configuration

You can configure `easyeda-mcp-pro` automatically or manually.

### 1. Automatic Configuration (CLI)

The CLI setup automates editing the configuration files for your client:

```bash
# Configure all detected clients automatically
npx easyeda-mcp-pro setup all

# Or configure a specific client
npx easyeda-mcp-pro setup <client>
```

#### Supported Client Keys:

- `claude` (Claude Desktop)
- `cursor` (Cursor IDE)
- `vscode` (VS Code Copilot)
- `windsurf` (Windsurf)
- `cline` (Cline)
- `gemini` (Gemini CLI / Antigravity)
- `zed` (Zed Editor)
- `amazonq` (Amazon Q Developer)
- `continue` (Continue.dev)

#### Options:

- `--profile <name>`: Specify the tool profile. Options: `core` (default), `pro`, `full`, `dev`.
  Example: `npx easyeda-mcp-pro setup cursor --profile full`

### 2. Extension Installation

To bridge the MCP server with EasyEDA Pro:

```bash
# Open the directory containing the .eext extension package in your file manager
npx easyeda-mcp-pro extension --open

# Or copy it to a specific directory
npx easyeda-mcp-pro extension --copy /path/to/destination
```

**Installation steps in EasyEDA Pro:**

1. Open **EasyEDA Pro**.
2. Go to **Settings** → **Extensions** → **Extension Manager**.
3. Click **Import Extension** and select the `easyeda-bridge-extension.eext` file.
4. Ensure **Allow External Interaction** is enabled for the extension.
5. Click **MCP Bridge** → **Connect** in the menu bar.

---

### 3. Manual Client Configurations

If you prefer to configure your clients manually, add the following configuration to the respective settings files:

<details>
<summary>🟣 Claude Desktop</summary>

**Config Path:**

- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Linux: `~/.config/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "easyeda-mcp-pro": {
      "command": "npx",
      "args": ["-y", "easyeda-mcp-pro@latest"],
      "env": {
        "TOOL_PROFILE": "core"
      }
    }
  }
}
```

</details>

<details>
<summary>🔵 Cursor IDE</summary>

**Config Path:** Project-specific `.cursor/mcp.json` or global `~/.cursor/mcp.json`

```json
{
  "mcpServers": {
    "easyeda-mcp-pro": {
      "command": "npx",
      "args": ["-y", "easyeda-mcp-pro@latest"],
      "env": {
        "TOOL_PROFILE": "pro"
      }
    }
  }
}
```

</details>

<details>
<summary>🟢 VS Code (GitHub Copilot)</summary>

**Config Path:** `%APPDATA%\Code\User\mcp.json` (Windows), `~/Library/Application Support/Code/User/mcp.json` (macOS), or `~/.config/Code/User/mcp.json` (Linux)

```json
{
  "servers": {
    "easyeda-mcp-pro": {
      "command": "npx",
      "args": ["-y", "easyeda-mcp-pro@latest"],
      "env": {
        "TOOL_PROFILE": "pro"
      }
    }
  }
}
```

</details>

<details>
<summary>🏄 Windsurf (Codeium)</summary>

**Config Path:** `~/.codeium/windsurf/mcp_config.json`

```json
{
  "mcpServers": {
    "easyeda-mcp-pro": {
      "command": "npx",
      "args": ["-y", "easyeda-mcp-pro@latest"]