English | 简体中文

EasyEDA API Skill

供 AI 编程工具（Claude Code、OpenCode、QwenCode 等所有支持 Agent Skills 标准的工具）使用的 EasyEDA Pro API 技能包（Skill）。

这个 SKILL 不仅支持 AI 在线调试嘉立创EDA，也支持辅助开发嘉立创EDA扩展。 在开发嘉立创EDA扩展时，AI 可以使用本 SKILL 提供的扩展开发相关文档、API 参考、类型信息、调用示例以及桥接调试能力，帮助完成接口查询、代码编写与联调验证。 如果用户准备自行分析或修改嘉立创EDA文档源码，而不是通过 API 操作，也可以使用本项目提供的文档源码格式说明。

• 📚 结构化 API 文档 — 自动从参考文档生成分层索引，便于 AI 快速查阅
• 🧾 文档源码格式规范 — 说明工程、原理图、PCB 文档源码格式，适合直接分析和修改源码的场景
• 🔌 WebSocket Bridge — Node.js 服务端，桥接 AI 和 EasyEDA 客户端
• 🤖 SKILL.md — 完整的技能指导文件

快速开始

1. 安装依赖

npm install

2. 构建 API 文档

npm run build:docs

这会从 reference/ 目录读取原始 API 文档，生成结构化文档到 docs/ 目录。

3. 启动 WebSocket Bridge 服务器

npm run server

服务器自动在端口范围 49620-49629 中选择可用端口启动，等待 EasyEDA 客户端连接。

4. EasyEDA 端连接

在嘉立创EDA中安装 run-api-gateway.eext 扩展，下载地址：

• https://jlc-ext.com/item/oshwhub/run-api-gateway

扩展加载后会自动连接到 Bridge 服务器（自动扫描端口范围，验证握手后连接）。

5. 使用 AI 编程工具

AI 编程工具（Claude Code、OpenCode、QwenCode 等）会自动读取 SKILL.md 获取技能指导，通过 HTTP API 向 EDA 发送代码：

# 检查 EDA 连接状态（端口自动发现，此处假设服务在 49620）
curl http://localhost:49620/health

# 执行 EDA 代码
curl -X POST http://localhost:49620/execute \
  -H "Content-Type: application/json" \
  -d '{"code": "return await eda.dmt_Project.getCurrentProjectInfo();"}'

一键打包

npm run pack

这会执行以下步骤：

1. 构建 API 文档（docs/）
2. 将 SKILL.md、文档、服务器打包到 dist/easyeda-api/
3. 生成 dist/easyeda-api.zip 用于上传

如果文档已构建好，可跳过构建步骤：

npm run pack:fast

发布到 ClawHub

npx clawhub@latest publish dist/easyeda-api/

或上传 zip 文件到 https://clawhub.ai/upload

架构

┌──────────────┐   HTTP/WS     ┌────────────────┐   WebSocket   ┌──────────┐
│   AI Agent   │ ◄───────────► │ Bridge Server  │ ◄───────────► │  EasyEDA │
│ (Skill Tool) │  Port Range   │   (Node.js)    │  Port Range   │ (Client) │
└──────────────┘  49620-49629  └────────────────┘  49620-49629  └──────────┘

通信协议

消息类型	方向	说明
execute	AI → EDA	执行 JS 代码
result	EDA → AI	返回执行结果
error	EDA → AI	返回执行错误
handshake	Server → Client	连接验证（含 service: "easyeda-bridge"）
ping/pong	双向	心跳检测

目录结构

easyeda-api-skill/
  SKILL.md              # AgentSkills 标准技能定义
  AGENTS.md              # Agent 提示指南
  package.json          # 项目配置
  reference/            # 原始 API 参考文档（gitignore）
  docs/                 # 构建后的结构化文档（gitignore）
  format/               # 嘉立创EDA文档源码格式规范（project/schematic/pcb）
  guide/                # API 开发指南（人工撰写）
  user-guide/           # 用户指南（人工撰写）
  server/index.mjs      # WebSocket Bridge 服务器
  scripts/
    build-docs.mjs      # 文档构建脚本
    pack.mjs            # 打包脚本
  dist/                 # 打包输出（gitignore）
    easyeda-api/        # 可发布的 skill 目录
    easyeda-api.zip     # 用于 ClawHub 上传的 zip 文件