KiCad MCP Server

Instructions

Implementation Reference

• kicad_mcp/tools/pattern_tools.py:152-196 (handler)

  The core handler function for the 'analyze_project_circuit_patterns' tool. It validates the project path, retrieves the schematic file using get_project_files, and delegates pattern analysis to the identify_circuit_patterns function, augmenting the result with project path.
  @mcp.tool() async def analyze_project_circuit_patterns(project_path: str, ctx: Context | None) -> Dict[str, Any]: """Identify circuit patterns in a KiCad project's schematic. Args: project_path: Path to the KiCad project file (.kicad_pro) ctx: MCP context for progress reporting Returns: Dictionary with identified circuit patterns """ if not os.path.exists(project_path): if ctx: ctx.info(f"Project not found: {project_path}") return {"success": False, "error": f"Project not found: {project_path}"} # Report progress if ctx: await ctx.report_progress(10, 100) # Get the schematic file try: files = get_project_files(project_path) if "schematic" not in files: if ctx: ctx.info("Schematic file not found in project") return {"success": False, "error": "Schematic file not found in project"} schematic_path = files["schematic"] if ctx: ctx.info(f"Found schematic file: {os.path.basename(schematic_path)}") # Identify patterns in the schematic result = await identify_circuit_patterns(schematic_path, ctx) # Add project path to result if "success" in result and result["success"]: result["project_path"] = project_path return result except Exception as e: ctx.info(f"Error analyzing project circuit patterns: {str(e)}") return {"success": False, "error": str(e)}
• kicad_mcp/server.py:155-155 (registration)

  Invocation of register_pattern_tools during server initialization, which defines and registers the analyze_project_circuit_patterns tool (along with identify_circuit_patterns) using the @mcp.tool() decorator.
  register_pattern_tools(mcp)
• kicad_mcp/tools/pattern_tools.py:27-151 (helper)

  Supporting helper function identify_circuit_patterns called by the main tool handler. Performs the actual netlist extraction and pattern identification for individual schematics.
  @mcp.tool() async def identify_circuit_patterns(schematic_path: str, ctx: Context | None) -> Dict[str, Any]: """Identify common circuit patterns in a KiCad schematic. This tool analyzes a schematic to recognize common circuit blocks such as: - Power supply circuits (linear regulators, switching converters) - Amplifier circuits (op-amps, transistor amplifiers) - Filter circuits (RC, LC, active filters) - Digital interfaces (I2C, SPI, UART) - Microcontroller circuits - And more Args: schematic_path: Path to the KiCad schematic file (.kicad_sch) ctx: MCP context for progress reporting Returns: Dictionary with identified circuit patterns """ if not os.path.exists(schematic_path): if ctx: ctx.info(f"Schematic file not found: {schematic_path}") return {"success": False, "error": f"Schematic file not found: {schematic_path}"} # Report progress if ctx: await ctx.report_progress(10, 100) ctx.info(f"Loading schematic file: {os.path.basename(schematic_path)}") try: # Extract netlist information if ctx: await ctx.report_progress(20, 100) ctx.info("Parsing schematic structure...") netlist_data = extract_netlist(schematic_path) if "error" in netlist_data: if ctx: ctx.info(f"Error extracting netlist: {netlist_data['error']}") return {"success": False, "error": netlist_data['error']} # Analyze components and nets if ctx: await ctx.report_progress(30, 100) ctx.info("Analyzing components and connections...") components = netlist_data.get("components", {}) nets = netlist_data.get("nets", {}) # Start pattern recognition if ctx: await ctx.report_progress(50, 100) ctx.info("Identifying circuit patterns...") identified_patterns = { "power_supply_circuits": [], "amplifier_circuits": [], "filter_circuits": [], "oscillator_circuits": [], "digital_interface_circuits": [], "microcontroller_circuits": [], "sensor_interface_circuits": [], "other_patterns": [] } # Identify power supply circuits if ctx: await ctx.report_progress(60, 100) identified_patterns["power_supply_circuits"] = identify_power_supplies(components, nets) # Identify amplifier circuits if ctx: await ctx.report_progress(70, 100) identified_patterns["amplifier_circuits"] = identify_amplifiers(components, nets) # Identify filter circuits if ctx: await ctx.report_progress(75, 100) identified_patterns["filter_circuits"] = identify_filters(components, nets) # Identify oscillator circuits if ctx: await ctx.report_progress(80, 100) identified_patterns["oscillator_circuits"] = identify_oscillators(components, nets) # Identify digital interface circuits if ctx: await ctx.report_progress(85, 100) identified_patterns["digital_interface_circuits"] = identify_digital_interfaces(components, nets) # Identify microcontroller circuits if ctx: await ctx.report_progress(90, 100) identified_patterns["microcontroller_circuits"] = identify_microcontrollers(components) # Identify sensor interface circuits if ctx: await ctx.report_progress(95, 100) identified_patterns["sensor_interface_circuits"] = identify_sensor_interfaces(components, nets) # Build result result = { "success": True, "schematic_path": schematic_path, "component_count": netlist_data["component_count"], "identified_patterns": identified_patterns } # Count total patterns total_patterns = sum(len(patterns) for patterns in identified_patterns.values()) result["total_patterns_found"] = total_patterns # Complete progress if ctx: await ctx.report_progress(100, 100) ctx.info(f"Pattern recognition complete. Found {total_patterns} circuit patterns.") return result except Exception as e: if ctx: ctx.info(f"Error identifying circuit patterns: {str(e)}") return {"success": False, "error": str(e)}