@huaqiu/hqeda 0.1.1

package/SKILL.md

@@ -0,0 +1,279 @@
+---
+name: hqeda
+description: Official Huaqiu EDA Skill Package providing executable SDK capabilities, ERC diagnostics, BOM analysis, and human-authored review playbooks.
+version: 0.1.0
+vendor: Huaqiu Electronics
+author: Huaqiu AI Platform Team
+tags:
+  - eda
+  - kicad
+  - electronics
+  - erc
+  - bom
+  - pcb
+entry: ./dist/index.js
+manifest: ./skill.json
+---
+
+# Huaqiu EDA Skill (`@huaqiu/hqeda`)
+
+Welcome to the official **Huaqiu EDA Skill Package**. This package equips LLM
+agents with deterministic capabilities to interact with Huaqiu EDA engines,
+parse schematics, execute ERC checks, query BOMs, and apply hardware
+engineering review playbooks.
+
+## Operational Capabilities
+
+<!-- BEGIN GENERATED CAPABILITIES -->
+<!-- This section is regenerated by `pnpm capability:generate`. -->
+<!-- Hand-edits here will be lost on the next run. -->
+
+Total capabilities: **110** across **18** domains.
+
+### ai (`ai`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `ai-execute-prompt` | `AIService.ExecutePrompt` | Execute Prompt via AIService.ExecutePrompt | no |
+
+### bom (`bom`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `bom-get-bom` | `EdaBomService.GetBom` | Get full BOM snapshot from current schematic state | no |
+
+### canvas (`canvas`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `canvas-align-objects` | `CanvasOpsService.AlignObjects` | transform | no |
+| `canvas-can-paste` | `CanvasOpsService.CanPaste` | Can Paste via CanvasOpsService.CanPaste | no |
+| `canvas-clear-all-sel` | `CanvasOpsService.ClearAllSel` | selection | no |
+| `canvas-copy-selected` | `CanvasOpsService.CopySelected` | Copy Selected via CanvasOpsService.CopySelected | no |
+| `canvas-delete-selected` | `CanvasOpsService.DeleteSelected` | edit | no |
+| `canvas-distribute-objects` | `CanvasOpsService.DistributeObjects` | Distribute Objects via CanvasOpsService.DistributeObjects | no |
+| `canvas-get-align-type` | `CanvasOpsService.GetAlignType` | Get Align Type via CanvasOpsService.GetAlignType | no |
+| `canvas-get-selected-object-json` | `CanvasOpsService.GetSelectedObjectJson` | Get Selected Object Json via CanvasOpsService.GetSelectedObjectJson | no |
+| `canvas-get-selected-objects-json` | `CanvasOpsService.GetSelectedObjectsJson` | Get Selected Objects Json via CanvasOpsService.GetSelectedObjectsJson | no |
+| `canvas-mirror-objects` | `CanvasOpsService.MirrorObjects` | Mirror Objects via CanvasOpsService.MirrorObjects | no |
+| `canvas-move-selected-objs` | `CanvasOpsService.MoveSelectedObjs` | Move Selected Objs via CanvasOpsService.MoveSelectedObjs | no |
+| `canvas-on-canvas-escape` | `CanvasOpsService.OnCanvasEscape` | state | no |
+| `canvas-pan-canvas` | `CanvasOpsService.PanCanvas` | viewport | no |
+| `canvas-paste-selected` | `CanvasOpsService.PasteSelected` | Paste Selected via CanvasOpsService.PasteSelected | no |
+| `canvas-rotate-objects` | `CanvasOpsService.RotateObjects` | Rotate Objects via CanvasOpsService.RotateObjects | no |
+| `canvas-screen-to-canvas-local` | `CanvasOpsService.ScreenToCanvasLocal` | coordinate | no |
+| `canvas-select-all` | `CanvasOpsService.SelectAll` | Select All via CanvasOpsService.SelectAll | no |
+| `canvas-select-object-at` | `CanvasOpsService.SelectObjectAt` | Select Object At via CanvasOpsService.SelectObjectAt | no |
+| `canvas-set-align-type` | `CanvasOpsService.SetAlignType` | grid align | no |
+| `canvas-set-page-size` | `CanvasOpsService.SetPageSize` | page | no |
+| `canvas-set-page-size-rect` | `CanvasOpsService.SetPageSizeRect` | Set Page Size Rect via CanvasOpsService.SetPageSizeRect | no |
+| `canvas-zoom-all` | `CanvasOpsService.ZoomAll` | Zoom All via CanvasOpsService.ZoomAll | no |
+| `canvas-zoom-area-by-double-box` | `CanvasOpsService.ZoomAreaByDoubleBox` | Zoom Area By Double Box via CanvasOpsService.ZoomAreaByDoubleBox | no |
+| `canvas-zoom-area-by-int-box` | `CanvasOpsService.ZoomAreaByIntBox` | Zoom Area By Int Box via CanvasOpsService.ZoomAreaByIntBox | no |
+| `canvas-zoom-area-by-points` | `CanvasOpsService.ZoomAreaByPoints` | Zoom Area By Points via CanvasOpsService.ZoomAreaByPoints | no |
+| `canvas-zoom-in` | `CanvasOpsService.ZoomIn` | zoom | no |
+| `canvas-zoom-out` | `CanvasOpsService.ZoomOut` | Zoom Out via CanvasOpsService.ZoomOut | no |
+| `canvas-zoom-selected` | `CanvasOpsService.ZoomSelected` | Zoom Selected via CanvasOpsService.ZoomSelected | no |
+
+### capability (`capability`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `capability-get-capabilities` | `CapabilityService.GetCapabilities` | Get Capabilities via CapabilityService.GetCapabilities | no |
+
+### context (`context`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `context-get-context` | `ContextService.GetContext` | Get Context via ContextService.GetContext | no |
+
+### discovery (`discovery`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `discovery-get-server-info` | `DiscoveryService.GetServerInfo` | Get Server Info via DiscoveryService.GetServerInfo | no |
+
+### erc (`erc`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `erc-clear-all-findings` | `ERCService.ClearAllFindings` | Clear All Findings via ERCService.ClearAllFindings | no |
+| `erc-clear-findings` | `ERCService.ClearFindings` | Clear Findings via ERCService.ClearFindings | no |
+| `erc-run-checks` | `ERCService.RunChecks` | Run erc check with the eda's built-in engine | no |
+| `erc-set-erc-report-webview-visibility` | `ERCService.SetErcReportWebviewVisibility` | ONLY controls report webview visibility | no |
+| `erc-set-report-webview-state` | `ERCService.SetReportWebviewState` | Set Report Webview State via ERCService.SetReportWebviewState | no |
+| `erc-show-findings` | `ERCService.ShowFindings` | Canvas interaction (row click → highlight in EDA view) | no |
+
+### event (`event`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `event-subscribe` | `EventService.Subscribe` | Subscribe via EventService.Subscribe | yes |
+
+### export (`export`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `export-export-bom` | `ExportService.ExportBOM` | Export Bom via ExportService.ExportBOM | no |
+| `export-export-target` | `ExportService.ExportTarget` | Export Target via ExportService.ExportTarget | no |
+
+### graph (`graph`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `graph-get-connectivity` | `GraphService.GetConnectivity` | Get Connectivity via GraphService.GetConnectivity | no |
+| `graph-query-graph` | `GraphService.QueryGraph` | Query Graph via GraphService.QueryGraph | no |
+
+### import (`import`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `import-import-design` | `ImportService.ImportDesign` | Import a design from an external EDA system | no |
+
+### kernel (`kernel`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `kernel-get-entity` | `KernelService.GetEntity` | Get Entity via KernelService.GetEntity | no |
+| `kernel-get-snapshot` | `KernelService.GetSnapshot` | Get Snapshot via KernelService.GetSnapshot | no |
+
+### obj-place (`obj-place`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `obj-place-add-bus-segment` | `ObjPlaceService.AddBusSegment` | Add Bus Segment via ObjPlaceService.AddBusSegment | no |
+| `obj-place-add-ellipse` | `ObjPlaceService.AddEllipse` | Add Ellipse via ObjPlaceService.AddEllipse | no |
+| `obj-place-add-free-line-segment` | `ObjPlaceService.AddFreeLineSegment` | Add Free Line Segment via ObjPlaceService.AddFreeLineSegment | no |
+| `obj-place-add-line` | `ObjPlaceService.AddLine` | Add Line via ObjPlaceService.AddLine | no |
+| `obj-place-add-rect` | `ObjPlaceService.AddRect` | Add Rect via ObjPlaceService.AddRect | no |
+| `obj-place-add-wire-segment` | `ObjPlaceService.AddWireSegment` | Add Wire Segment via ObjPlaceService.AddWireSegment | no |
+| `obj-place-cancel-bus-draw` | `ObjPlaceService.CancelBusDraw` | Cancel Bus Draw via ObjPlaceService.CancelBusDraw | no |
+| `obj-place-cancel-ellipse-arc-draw` | `ObjPlaceService.CancelEllipseArcDraw` | Cancel Ellipse Arc Draw via ObjPlaceService.CancelEllipseArcDraw | no |
+| `obj-place-cancel-ellipse-draw` | `ObjPlaceService.CancelEllipseDraw` | Cancel Ellipse Draw via ObjPlaceService.CancelEllipseDraw | no |
+| `obj-place-cancel-free-line-draw` | `ObjPlaceService.CancelFreeLineDraw` | Cancel Free Line Draw via ObjPlaceService.CancelFreeLineDraw | no |
+| `obj-place-cancel-line-draw` | `ObjPlaceService.CancelLineDraw` | Cancel Line Draw via ObjPlaceService.CancelLineDraw | no |
+| `obj-place-cancel-rect-draw` | `ObjPlaceService.CancelRectDraw` | Cancel Rect Draw via ObjPlaceService.CancelRectDraw | no |
+| `obj-place-cancel-wire-draw` | `ObjPlaceService.CancelWireDraw` | Cancel Wire Draw via ObjPlaceService.CancelWireDraw | no |
+| `obj-place-handle-bus-draw-click` | `ObjPlaceService.HandleBusDrawClick` | bus | no |
+| `obj-place-handle-ellipse-arc-draw-click` | `ObjPlaceService.HandleEllipseArcDrawClick` | Handle Ellipse Arc Draw Click via ObjPlaceService.HandleEllipseArcDrawClick | no |
+| `obj-place-handle-ellipse-draw-click` | `ObjPlaceService.HandleEllipseDrawClick` | Handle Ellipse Draw Click via ObjPlaceService.HandleEllipseDrawClick | no |
+| `obj-place-handle-free-line-draw-click` | `ObjPlaceService.HandleFreeLineDrawClick` | Handle Free Line Draw Click via ObjPlaceService.HandleFreeLineDrawClick | no |
+| `obj-place-handle-image-draw-click` | `ObjPlaceService.HandleImageDrawClick` | Handle Image Draw Click via ObjPlaceService.HandleImageDrawClick | no |
+| `obj-place-handle-line-draw-click` | `ObjPlaceService.HandleLineDrawClick` | Handle Line Draw Click via ObjPlaceService.HandleLineDrawClick | no |
+| `obj-place-handle-net-alias-draw-click` | `ObjPlaceService.HandleNetAliasDrawClick` | Handle Net Alias Draw Click via ObjPlaceService.HandleNetAliasDrawClick | no |
+| `obj-place-handle-rect-draw-click` | `ObjPlaceService.HandleRectDrawClick` | Handle Rect Draw Click via ObjPlaceService.HandleRectDrawClick | no |
+| `obj-place-handle-table-draw-click` | `ObjPlaceService.HandleTableDrawClick` | Handle Table Draw Click via ObjPlaceService.HandleTableDrawClick | no |
+| `obj-place-handle-text-draw-click` | `ObjPlaceService.HandleTextDrawClick` | Handle Text Draw Click via ObjPlaceService.HandleTextDrawClick | no |
+| `obj-place-handle-wire-draw-click` | `ObjPlaceService.HandleWireDrawClick` | wire | no |
+| `obj-place-place-bus` | `ObjPlaceService.PlaceBus` | Place Bus via ObjPlaceService.PlaceBus | no |
+| `obj-place-place-ellipse` | `ObjPlaceService.PlaceEllipse` | ellipse | no |
+| `obj-place-place-ellipse-arc` | `ObjPlaceService.PlaceEllipseArc` | ellipse arc | no |
+| `obj-place-place-ellipse-arc-from-virtual` | `ObjPlaceService.PlaceEllipseArcFromVirtual` | Place Ellipse Arc From Virtual via ObjPlaceService.PlaceEllipseArcFromVirtual | no |
+| `obj-place-place-free-line` | `ObjPlaceService.PlaceFreeLine` | free line | no |
+| `obj-place-place-image` | `ObjPlaceService.PlaceImage` | image | no |
+| `obj-place-place-line` | `ObjPlaceService.PlaceLine` | line | no |
+| `obj-place-place-net-alias` | `ObjPlaceService.PlaceNetAlias` | net alias | no |
+| `obj-place-place-rect` | `ObjPlaceService.PlaceRect` | rect | no |
+| `obj-place-place-table` | `ObjPlaceService.PlaceTable` | table | no |
+| `obj-place-place-table-from-virtual` | `ObjPlaceService.PlaceTableFromVirtual` | Place Table From Virtual via ObjPlaceService.PlaceTableFromVirtual | no |
+| `obj-place-place-text` | `ObjPlaceService.PlaceText` | text | no |
+| `obj-place-place-text-from-virtual` | `ObjPlaceService.PlaceTextFromVirtual` | Place Text From Virtual via ObjPlaceService.PlaceTextFromVirtual | no |
+| `obj-place-place-wire` | `ObjPlaceService.PlaceWire` | Place Wire via ObjPlaceService.PlaceWire | no |
+
+### placement (`placement`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `placement-cancel-block-draw` | `ComponentPlaceService.CancelBlockDraw` | Cancel Block Draw via ComponentPlaceService.CancelBlockDraw | no |
+| `placement-clear-net-alias-attach-obj` | `ComponentPlaceService.ClearNetAliasAttachObj` | Clear Net Alias Attach Obj via ComponentPlaceService.ClearNetAliasAttachObj | no |
+| `placement-handle-block-draw-click` | `ComponentPlaceService.HandleBlockDrawClick` | Handle Block Draw Click via ComponentPlaceService.HandleBlockDrawClick | no |
+| `placement-handle-part-draw-click` | `ComponentPlaceService.HandlePartDrawClick` | Handle Part Draw Click via ComponentPlaceService.HandlePartDrawClick | no |
+| `placement-handle-symbol-draw-click` | `ComponentPlaceService.HandleSymbolDrawClick` | Handle Symbol Draw Click via ComponentPlaceService.HandleSymbolDrawClick | no |
+| `placement-place-block` | `ComponentPlaceService.PlaceBlock` | block | no |
+| `placement-place-part` | `ComponentPlaceService.PlacePart` | part | no |
+| `placement-place-symbol` | `ComponentPlaceService.PlaceSymbol` | symbol | no |
+| `placement-set-net-alias-attach-obj` | `ComponentPlaceService.SetNetAliasAttachObj` | net alias attach | no |
+
+### project (`project`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `project-close-project` | `ProjectService.CloseProject` | Closes an opened project. | no |
+| `project-get-active-project` | `ProjectService.GetActiveProject` | Returns the project currently active in the editor UI. | no |
+| `project-get-project` | `ProjectService.GetProject` | Returns one opened project. | no |
+| `project-list-open-projects` | `ProjectService.ListOpenProjects` | Returns all projects currently opened in this HQ EDA process. | no |
+| `project-open-project` | `ProjectService.OpenProject` | Opens a project into the current HQ EDA editor process. | no |
+| `project-save-project` | `ProjectService.SaveProject` | Persists an opened project. | no |
+
+### runtime (`runtime`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `runtime-execute-commands` | `RuntimeService.ExecuteCommands` | Execute Commands via RuntimeService.ExecuteCommands | no |
+| `runtime-validate-commands` | `RuntimeService.ValidateCommands` | Validate Commands via RuntimeService.ValidateCommands | no |
+
+### selection (`selection`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `selection-clear-selection` | `SelectionService.ClearSelection` | Clear Selection via SelectionService.ClearSelection | no |
+| `selection-get-selection` | `SelectionService.GetSelection` | Get Selection via SelectionService.GetSelection | no |
+| `selection-set-selection` | `SelectionService.SetSelection` | Set Selection via SelectionService.SetSelection | no |
+
+### transaction (`transaction`)
+
+| Skill ID | Method | Description | Streaming |
+| --- | --- | --- | --- |
+| `transaction-commit` | `TransactionService.Commit` | Commit via TransactionService.Commit | no |
+| `transaction-open` | `TransactionService.Open` | Open via TransactionService.Open | no |
+| `transaction-redo` | `TransactionService.Redo` | Redo via TransactionService.Redo | no |
+| `transaction-rollback` | `TransactionService.Rollback` | Rollback via TransactionService.Rollback | no |
+| `transaction-undo` | `TransactionService.Undo` | Undo via TransactionService.Undo | no |
+
+<!-- END GENERATED CAPABILITIES -->
+
+The following capabilities are machine-generated from the Connect-ES SDK
+surface and backed by verified integration tests. The full catalog is
+rendered automatically by `pnpm capability:generate` — do not hand-edit the
+table below; it is regenerated on every build.
+
+## Engineering Playbooks
+
+Human-authored engineering review playbooks guide agent reasoning during
+complex multi-step tasks. Each playbook declares the capabilities it needs
+and points to a guidance document plus a structured checklist.
+
+1. **BOM Review Playbook:** `playbooks/bom-review.json` — verifies component
+   availability, footprint consistency, lifecycle risks, and assembly variants.
+2. **Schematic Review Playbook:** `playbooks/schematic-review.json` — checks
+   net connectivity, power-rail integrity, and ERC compliance.
+3. **ERC Review Playbook:** `playbooks/erc-review.json` — orchestrates ERC
+   runs, classifies findings by severity, and drives resolution workflows.
+4. **Manufacturing Readiness Playbook:** `playbooks/manufacturing-review.json`
+   — gates production release on DFM, DRC, and BOM freeze criteria.
+
+## Execution Guidelines for Agents
+
+When handling hardware design queries:
+
+1. First, query the relevant **Playbook** (e.g. `guides/bom-review.md`) to
+   understand domain heuristics and required data.
+2. Invoke operational capabilities strictly adhering to their generated JSON
+   schemas — every capability id in `generated/capability-registry.json` maps
+   to a typed `defineSkill(...)` wrapper.
+3. Group findings by severity (`CRITICAL`, `WARNING`, `INFO`) and reference
+   component designators explicitly (e.g. `R1`, `C15`) in every report.
+4. Never fabricate capability ids — only use ids present in
+   `generated/capability-registry.json`. The playbook validator
+   (`pnpm capability:validate`) enforces this contract at build time.
+
+## Layout
+
+| Path | Owner | Notes |
+| --- | --- | --- |
+| `generated/` | Capability Generator | Full overwrite on `pnpm capability:generate`. |
+| `SKILL.md` | Human + Generator | YAML frontmatter preserved; capabilities section regenerated. |
+| `skill.json` | Human + Generator | Selective merge — `capabilities[]` updated, metadata preserved. |
+| `playbooks/` | Domain Engineers | Strictly preserved. |
+| `guides/` | Domain Engineers | Strictly preserved. |
+| `prompts/` | AI Systems Team | Strictly preserved. |

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { EditorClient } from '@huaqiu/huaqiu-client';
+import { DescMessage } from '@bufbuild/protobuf';
+
+/**
+ * Execution context handed to every skill. The runtime is responsible for
+ * constructing the EditorClient and injecting it here.
+ */
+interface SkillContext {
+    /** Underlying Connect-ES client used to invoke RPCs. */
+    client: EditorClient;
+}
+/** A single generated skill (one per Connect RPC method). */
+interface SkillDefinition<I = unknown, O = unknown> {
+    /** Stable skill id (e.g. `bom-get-bom`). */
+    id: string;
+    /** Human-readable title (e.g. `Get BOM`). */
+    title: string;
+    /** Short description, extracted from the proto JSDoc when available. */
+    description: string;
+    /** Domain grouping (e.g. `bom`, `erc`, `project`). */
+    domain: string;
+    /** Connect service name (e.g. `ERCService`). */
+    service: string;
+    /** RPC method name (proto-style, e.g. `RunChecks`). */
+    method: string;
+    /** Whether the RPC uses streaming transport. */
+    isStreaming: boolean;
+    /** Request message descriptor (the generated `*Schema` const). */
+    inputSchema: DescMessage;
+    /** Execute the underlying RPC. */
+    execute: (ctx: SkillContext, input: I) => Promise<O>;
+}
+
+/**
+ * Registry of all generated skills, keyed by skill id.
+ * Use this for programmatic discovery (e.g. agents listing capabilities).
+ */
+declare const SKILLS: Record<string, SkillDefinition>;
+/** List every generated skill in stable id order. */
+declare function listSkills(): SkillDefinition[];
+/** Look up a skill by id. */
+declare function getSkill(id: string): SkillDefinition | undefined;
+
+export { SKILLS, type SkillContext, type SkillDefinition, getSkill, listSkills };