From f491df4eeac9e7d577185a71f23f2847c42f75c6 Mon Sep 17 00:00:00 2001 From: Gavin Colonese Date: Fri, 12 Jun 2026 10:56:17 -0400 Subject: [PATCH] feat: add export_pcb_pdf tool (kicad-cli, full layer-plot PDF) New MCP tool `export_pcb_pdf` wrapping `kicad-cli pcb export pdf`: exposes the full layer-plot surface (layer/common-layer lists, mirror, refdes/value exclusion, border+title, soldermask subtraction, the four DNP fab-layer modes, negative, B&W, theme, drill-shape, and the single/separate/multipage output modes). Rich CLI sibling of the existing SWIG export_pdf (left untouched). Reads the saved .kicad_pcb. Co-Authored-By: Claude Opus 4.8 (1M context) --- python/kicad_interface.py | 106 ++++++++++++++++++++++++++++++++++++++ src/tools/export.ts | 71 +++++++++++++++++++++++++ src/tools/registry.ts | 1 + 3 files changed, 178 insertions(+) diff --git a/python/kicad_interface.py b/python/kicad_interface.py index 6f36c5a..dc00d69 100644 --- a/python/kicad_interface.py +++ b/python/kicad_interface.py @@ -594,6 +594,7 @@ class KiCADInterface: "export_ipcd356": self._handle_export_ipcd356, "export_gencad": self._handle_export_gencad, "export_pos": self._handle_export_pos, + "export_pcb_pdf": self._handle_export_pcb_pdf, "generate_netlist": self._handle_generate_netlist, "sync_schematic_to_board": self._handle_sync_schematic_to_board, "list_schematic_libraries": self._handle_list_schematic_libraries, @@ -5039,6 +5040,111 @@ class KiCADInterface: logger.error(f"Error exporting position file: {e}") return {"success": False, "message": str(e)} + def _handle_export_pcb_pdf(self, params: Dict[str, Any]) -> Dict[str, Any]: + """Plot the PCB to PDF via kicad-cli (`pcb export pdf`). + + Exposes the full layer-plot option set: layer lists, mirror, refdes/value + exclusion, border+title, soldermask subtraction, DNP fab-layer modes, + negative/B&W, theme, drill-shape, and the single/separate/multipage + output modes. Reads the saved .kicad_pcb. + """ + import subprocess + + logger.info("Exporting PCB PDF via kicad-cli") + try: + board_path = params.get("boardPath") or self._current_board_path() + output_path = params.get("outputPath") + + if not board_path: + return { + "success": False, + "message": "boardPath is required (no current board could be resolved)", + } + if not os.path.exists(board_path): + return {"success": False, "message": f"Board not found: {board_path}"} + if not output_path: + return {"success": False, "message": "outputPath is required"} + + kicad_cli = self._find_kicad_cli_static() + if not kicad_cli: + return {"success": False, "message": "kicad-cli not found in PATH"} + + output_path = os.path.abspath(os.path.expanduser(output_path)) + parent = os.path.dirname(output_path) + if parent: + os.makedirs(parent, exist_ok=True) + + cmd = [kicad_cli, "pcb", "export", "pdf", "--output", output_path] + + layers = params.get("layers") + if layers: + cmd += ["--layers", ",".join(layers) if isinstance(layers, list) else str(layers)] + common_layers = params.get("commonLayers") + if common_layers: + cmd += [ + "--common-layers", + ( + ",".join(common_layers) + if isinstance(common_layers, list) + else str(common_layers) + ), + ] + + if params.get("drawingSheet"): + cmd += ["--drawing-sheet", params["drawingSheet"]] + for kv in params.get("defineVar", []) or []: + cmd += ["--define-var", kv] + + value_map = { + "theme": "--theme", + "drillShapeOpt": "--drill-shape-opt", + } + for key, flag in value_map.items(): + val = params.get(key) + if val is not None and val != "": + cmd += [flag, str(val)] + + flag_map = { + "mirror": "--mirror", + "excludeRefdes": "--exclude-refdes", + "excludeValue": "--exclude-value", + "includeBorderTitle": "--include-border-title", + "subtractSoldermask": "--subtract-soldermask", + "sketchPadsOnFabLayers": "--sketch-pads-on-fab-layers", + "hideDnpFootprintsOnFabLayers": "--hide-DNP-footprints-on-fab-layers", + "sketchDnpFootprintsOnFabLayers": "--sketch-DNP-footprints-on-fab-layers", + "crossoutDnpFootprintsOnFabLayers": "--crossout-DNP-footprints-on-fab-layers", + "negative": "--negative", + "blackAndWhite": "--black-and-white", + "modeSingle": "--mode-single", + "modeSeparate": "--mode-separate", + "modeMultipage": "--mode-multipage", + } + for key, flag in flag_map.items(): + if params.get(key): + cmd.append(flag) + + cmd.append(board_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()}", + } + return {"success": True, "outputPath": output_path} + + 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 PCB PDF: {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 8dae799..db44ab7 100644 --- a/src/tools/export.ts +++ b/src/tools/export.ts @@ -648,5 +648,76 @@ export function registerExportTools(server: McpServer, callKicadScript: CommandF }, ); + // ------------------------------------------------------ + // Export PCB PDF Tool (kicad-cli, full layer-plot option set) + // ------------------------------------------------------ + server.tool( + "export_pcb_pdf", + "Plot the PCB layout to PDF via kicad-cli, exposing the full layer-plot option set (layer + common-layer lists, mirror, refdes/value exclusion, border+title, soldermask subtraction, DNP fab-layer modes, negative, black-and-white, theme, drill shape, and single/separate/multipage output modes). Rich CLI sibling of export_pdf. Reads the last SAVED state of the .kicad_pcb.", + { + outputPath: z.string().describe("Output PDF file path (or directory in separate mode)"), + boardPath: z.string().optional().describe("Path to the .kicad_pcb (default: current board)"), + layers: z + .array(z.string()) + .optional() + .describe("Layers to plot, untranslated names e.g. ['F.Cu','B.Cu','Edge.Cuts']"), + commonLayers: z + .array(z.string()) + .optional() + .describe("Layers to include on every plot (e.g. ['Edge.Cuts'])"), + 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"), + mirror: z.boolean().optional().describe("Mirror the board (to show bottom layers)"), + excludeRefdes: z.boolean().optional().describe("Exclude reference designator text"), + excludeValue: z.boolean().optional().describe("Exclude value text"), + includeBorderTitle: z.boolean().optional().describe("Include the border and title block"), + subtractSoldermask: z.boolean().optional().describe("Subtract soldermask from silkscreen"), + sketchPadsOnFabLayers: z + .boolean() + .optional() + .describe("Draw pad outlines and numbers on fab layers"), + hideDnpFootprintsOnFabLayers: z + .boolean() + .optional() + .describe("Don't plot DNP footprint text/graphics on fab layers"), + sketchDnpFootprintsOnFabLayers: z + .boolean() + .optional() + .describe("Plot DNP footprints in sketch mode on fab layers"), + crossoutDnpFootprintsOnFabLayers: z + .boolean() + .optional() + .describe("Plot an 'X' over DNP footprint courtyards and strike out their refdes"), + negative: z.boolean().optional().describe("Plot as negative"), + blackAndWhite: z.boolean().optional().describe("Black and white only"), + theme: z.string().optional().describe("Color theme to use (default: PCB editor settings)"), + drillShapeOpt: z + .number() + .optional() + .describe("Pad/via drill shape option (0 none, 1 small, 2 actual; default 2)"), + modeSingle: z + .boolean() + .optional() + .describe("Single file; output path is full path; LAYER_LIST controls all layers"), + modeSeparate: z.boolean().optional().describe("Plot the layers to individual PDF files"), + modeMultipage: z.boolean().optional().describe("Plot the layers to a single multi-page PDF"), + }, + async (args) => { + logger.debug(`Exporting PCB PDF to: ${args.outputPath}`); + const result = await callKicadScript("export_pcb_pdf", 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 e38a605..a53d71f 100644 --- a/src/tools/registry.ts +++ b/src/tools/registry.ts @@ -65,6 +65,7 @@ export const toolCategories: ToolCategory[] = [ "export_ipcd356", "export_gencad", "export_pos", + "export_pcb_pdf", "export_pdf", "export_svg", "export_3d",