From c8935099939457fdbc76972606f984235ffd3e84 Mon Sep 17 00:00:00 2001 From: Gavin Colonese Date: Fri, 12 Jun 2026 11:00:05 -0400 Subject: [PATCH] feat: add export_sch_hpgl tool (kicad-cli, schematic HPGL) New MCP tool `export_sch_hpgl` wrapping `kicad-cli sch export hpgl`: outputs one plot per page into a directory. Exposes drawing-sheet override, exclude-drawing-sheet, default-font, page selection, pen size, and the origin/scale mode. schematicPath required; directory output uses outputDir. Co-Authored-By: Claude Opus 4.8 (1M context) --- python/kicad_interface.py | 75 +++++++++++++++++++++++++++++++++++++++ src/tools/export.ts | 40 +++++++++++++++++++++ src/tools/registry.ts | 1 + 3 files changed, 116 insertions(+) diff --git a/python/kicad_interface.py b/python/kicad_interface.py index 45fb782..2d0614f 100644 --- a/python/kicad_interface.py +++ b/python/kicad_interface.py @@ -603,6 +603,7 @@ class KiCADInterface: "export_sch_pdf": self._handle_export_sch_pdf, "export_sch_svg": self._handle_export_sch_svg, "export_sch_dxf": self._handle_export_sch_dxf, + "export_sch_hpgl": self._handle_export_sch_hpgl, "generate_netlist": self._handle_generate_netlist, "sync_schematic_to_board": self._handle_sync_schematic_to_board, "list_schematic_libraries": self._handle_list_schematic_libraries, @@ -5908,6 +5909,80 @@ class KiCADInterface: logger.error(f"Error exporting schematic DXF: {e}") return {"success": False, "message": str(e)} + def _handle_export_sch_hpgl(self, params: Dict[str, Any]) -> Dict[str, Any]: + """Export a schematic to HPGL via kicad-cli (`sch export hpgl`). + + Output is a directory (one plot per page). Exposes drawing-sheet + override, exclude-drawing-sheet, default-font, page selection, pen size, + and the origin/scale mode. schematicPath is required. + """ + import subprocess + + logger.info("Exporting schematic HPGL via kicad-cli") + try: + schematic_path = params.get("schematicPath") + output_dir = params.get("outputDir") + + if not schematic_path: + return {"success": False, "message": "schematicPath is required"} + if not os.path.exists(schematic_path): + return {"success": False, "message": f"Schematic not found: {schematic_path}"} + if not output_dir: + return {"success": False, "message": "outputDir is required"} + + kicad_cli = self._find_kicad_cli_static() + if not kicad_cli: + return {"success": False, "message": "kicad-cli not found in PATH"} + + output_dir = os.path.abspath(os.path.expanduser(output_dir)) + os.makedirs(output_dir, exist_ok=True) + + cmd = [kicad_cli, "sch", "export", "hpgl", "--output", output_dir] + + if params.get("drawingSheet"): + cmd += ["--drawing-sheet", params["drawingSheet"]] + for kv in params.get("defineVar", []) or []: + cmd += ["--define-var", kv] + + value_map = { + "defaultFont": "--default-font", + "pages": "--pages", + "penSize": "--pen-size", + "origin": "--origin", + } + for key, flag in value_map.items(): + val = params.get(key) + if val is not None and val != "": + cmd += [flag, str(val)] + + if params.get("excludeDrawingSheet"): + cmd.append("--exclude-drawing-sheet") + + cmd.append(schematic_path) + + logger.info(f"Running: {' '.join(cmd)}") + result = subprocess.run(cmd, capture_output=True, text=True, timeout=180) + + if result.returncode != 0: + return { + "success": False, + "message": f"kicad-cli failed (exit {result.returncode}): " + f"{result.stderr.strip()}", + } + + files = sorted( + f for f in os.listdir(output_dir) if os.path.isfile(os.path.join(output_dir, f)) + ) + return {"success": True, "outputDir": output_dir, "files": files} + + except FileNotFoundError: + return {"success": False, "message": "kicad-cli not found in PATH"} + except subprocess.TimeoutExpired: + return {"success": False, "message": "kicad-cli timed out after 180 seconds"} + except Exception as e: + logger.error(f"Error exporting schematic HPGL: {e}") + return {"success": False, "message": str(e)} + def _handle_generate_netlist(self, params: Dict[str, Any]) -> Dict[str, Any]: """Generate netlist from schematic and return structured JSON. diff --git a/src/tools/export.ts b/src/tools/export.ts index afd8e6d..856b6aa 100644 --- a/src/tools/export.ts +++ b/src/tools/export.ts @@ -1237,5 +1237,45 @@ export function registerExportTools(server: McpServer, callKicadScript: CommandF }, ); + // ------------------------------------------------------ + // Export Schematic HPGL Tool (kicad-cli, full option set) + // ------------------------------------------------------ + server.tool( + "export_sch_hpgl", + "Export a schematic to HPGL via kicad-cli (`sch export hpgl`), one plot per page into a directory. Exposes drawing-sheet override, exclude-drawing-sheet, default-font, page selection, pen size, and the origin/scale mode. schematicPath is REQUIRED.", + { + schematicPath: z.string().describe("Path to the .kicad_sch (required)"), + outputDir: z.string().describe("Output directory for the HPGL files"), + drawingSheet: z.string().optional().describe("Path to a drawing sheet override"), + defineVar: z + .array(z.string()) + .optional() + .describe("Project variable overrides as 'KEY=VALUE' strings"), + excludeDrawingSheet: z.boolean().optional().describe("No drawing sheet"), + defaultFont: z.string().optional().describe("Default font name"), + pages: z + .string() + .optional() + .describe("Comma list of page numbers to print (blank = all pages)"), + penSize: z.number().optional().describe("Pen size in mm (default 0.5)"), + origin: z + .number() + .optional() + .describe("Origin and scale: 0 bottom left, 1 centered, 2 page fit, 3 content fit"), + }, + async (args) => { + logger.debug(`Exporting schematic HPGL to: ${args.outputDir}`); + const result = await callKicadScript("export_sch_hpgl", args); + return { + content: [ + { + type: "text", + text: JSON.stringify(result), + }, + ], + }; + }, + ); + logger.info("Export tools registered"); } diff --git a/src/tools/registry.ts b/src/tools/registry.ts index ea70989..982412c 100644 --- a/src/tools/registry.ts +++ b/src/tools/registry.ts @@ -74,6 +74,7 @@ export const toolCategories: ToolCategory[] = [ "export_sch_pdf", "export_sch_svg", "export_sch_dxf", + "export_sch_hpgl", "export_pdf", "export_svg", "export_3d",