nearxos/kicad-mcp-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add add_schematic_text and list_schematic_texts tools

Browse Source 
Adds two new MCP tools for working with free-form text annotations
(SCH_TEXT elements) in KiCad schematics:

- add_schematic_text: place a text note with optional angle, font size,
  bold/italic, and justification
- list_schematic_texts: list all text annotations with optional
  case-insensitive substring filter

Includes WireManager.add_text / list_texts using _text_insert + sexpdata,
handler dispatch in KiCADInterface, TypeScript tool definitions, registry
entry, reference doc updates, and 30 unit tests.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Eugene Mikhantyev
2026-04-19 21:26:39 +01:00
parent c4bcc34894
commit e5916005a0
7 changed files with 778 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/SCHEMATIC_TOOLS_REFERENCE.md
View File

@@ -268,6 +268,45 @@ Checks net label / power symbol positions first (exact IU match), then wire endp
| position | `{"x": float, "y": float}` — echoes the query coordinates |
| source | `"net_label"` \| `"wire_endpoint"` \| `null` — how the net was resolved |
## Text Annotations (2 tools)
### add_schematic_text
Add a free-form text annotation (note, heading, documentation string) directly on the schematic canvas. Text annotations have no electrical significance — they are purely visual. For electrically meaningful labels, use `add_schematic_net_label` instead.
| Parameter | Type | Required | Description |
| ------------- | ------------ | -------- | ------------------------------------------------ |
| schematicPath | string | Yes | Path to the .kicad_sch file |
| text | string | Yes | Text content to display |
| position | array [x, y] | Yes | Position in schematic mm coordinates |
| angle | number | No | Rotation angle in degrees (default: 0) |
| fontSize | number | No | Font size in mm (default: 1.27 — KiCad standard) |
| bold | boolean | No | Bold text (default: false) |
| italic | boolean | No | Italic text (default: false) |
| justify | string | No | `left` \| `center` \| `right` (default: `left`) |
### list_schematic_texts
List all free-form text annotations in the schematic. Optionally filter by a substring of the text content.
| Parameter | Type | Required | Description |
| ------------- | ------ | -------- | -------------------------------------------------------------- |
| schematicPath | string | Yes | Path to the .kicad_sch file |
| text | string | No | Case-insensitive substring filter — only return matching texts |
**Response fields (per text entry):**
| Field | Description |
| --------- | ----------------------------------- |
| text | Text string content |
| position | `{"x": float, "y": float}` in mm |
| angle | Rotation angle in degrees |
| font_size | Font size in mm |
| bold | `true` / `false` |
| italic | `true` / `false` |
| justify | `"left"` \| `"center"` \| `"right"` |
| uuid | KiCad UUID of the element |
## Schematic Creation and Export (6 tools)
### create_schematic

7
docs/TOOL_INVENTORY.md
View File

@@ -169,6 +169,13 @@ _Source: `src/tools/schematic.ts`_
| `list_schematic_wires` | List all wires in schematic | Routed (schematic) |
| `list_schematic_labels` | List all net labels | Routed (schematic) |
### Text Annotations
| Tool | Description | Access |
| ---------------------- | ------------------------------------------------ | ------------------ |
| `add_schematic_text` | Add free-form text annotation to schematic | Routed (schematic) |
| `list_schematic_texts` | List all text annotations (with optional filter) | Routed (schematic) |
### Schematic Creation and Export
| Tool | Description | Access |