Files
kicad-mcp-server/docs/ROUTER_QUICK_START.md
KiCAD MCP Bot f047a4e4d1 docs: comprehensive documentation overhaul for v2.2.3
Major documentation update bringing all docs current with the 122-tool,
16-category state of the project (previously frozen at v2.1.0-alpha/59 tools).

New documentation (9 files):
- FREEROUTING_GUIDE.md - autorouter setup, Docker/Podman, all 4 tools
- SCHEMATIC_TOOLS_REFERENCE.md - all 27 schematic tools with parameters
- ROUTING_TOOLS_REFERENCE.md - all 13 routing tools with examples
- FOOTPRINT_SYMBOL_CREATOR_GUIDE.md - 8 creator tools with examples
- SVG_IMPORT_GUIDE.md - SVG logo import tool
- DATASHEET_TOOLS_GUIDE.md - datasheet enrichment tools
- PCB_DESIGN_WORKFLOW.md - end-to-end design guide
- ARCHITECTURE.md - system architecture for contributors
- INDEX.md - documentation table of contents

Updated documentation (12 files):
- README.md - tool count 64->122, feature list, contributor credits
- TOOL_INVENTORY.md - complete rebuild with all 122 tools
- STATUS_SUMMARY.md - updated to v2.2.3 feature matrix
- ROADMAP.md - marked completed milestones, added v2.3+ vision
- KNOWN_ISSUES.md - removed resolved issues, added v2.2.x fixes
- CLIENT_CONFIGURATION.md - added KICAD_MCP_DEV, FREEROUTING_JAR env vars
- LIBRARY_INTEGRATION.md - added symbol and project-local library support
- ROUTER_ARCHITECTURE.md, ROUTER_QUICK_START.md - updated tool counts
- IPC_BACKEND_STATUS.md - updated dates
- JLCPCB_USAGE_GUIDE.md - added cross-reference note
- CONTRIBUTING.md - added ARCHITECTURE.md reference, updated tool count

Archived 10 completed planning docs to docs/archive/.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-21 01:31:44 -04:00

5.0 KiB
Raw Blame History

Router Quick Start Guide

What is the Router?

The KiCAD MCP Server includes an intelligent tool router that organizes 122+ tools into 8 discoverable categories. This reduces AI context usage by up to 70% while maintaining full access to all functionality.

How It Works

Instead of loading all 59 tool schemas into every conversation, Claude now sees:

  • 12 direct tools for high-frequency operations (always visible)
  • 4 router tools for discovering and executing the other 47 tools

When you ask Claude to do something (like "export gerber files"), it will:

  1. Search for relevant tools using search_tools
  2. Find the export_gerber tool in the "export" category
  3. Execute it via execute_tool with your parameters
  4. Return the results

You don't need to change how you interact with Claude - the discovery happens automatically!

Tool Categories

The 110+ routed tools are organized into these categories:

1. board (9 tools)

Board configuration: layers, mounting holes, zones, visualization

  • add_layer, set_active_layer, get_layer_list
  • add_mounting_hole, add_board_text
  • add_zone, get_board_extents, get_board_2d_view
  • launch_kicad_ui

2. component (8 tools)

Advanced component operations: edit, delete, search, group, annotate

  • rotate_component, delete_component, edit_component
  • find_component, get_component_properties
  • add_component_annotation, group_components, replace_component

3. export (8 tools)

File export for fabrication and documentation

  • export_gerber, export_pdf, export_svg, export_3d
  • export_bom, export_netlist, export_position_file, export_vrml

4. drc (8 tools)

Design rule checking and electrical validation

  • set_design_rules, get_design_rules, run_drc
  • add_net_class, assign_net_to_class, set_layer_constraints
  • check_clearance, get_drc_violations

5. schematic (8 tools)

Schematic operations: create, add components, wire connections

  • create_schematic, add_schematic_component, add_wire
  • add_schematic_connection, add_schematic_net_label
  • connect_to_net, get_net_connections, generate_netlist

6. library (4 tools)

Footprint library access and search

  • list_libraries, search_footprints
  • list_library_footprints, get_footprint_info

7. routing (2 tools)

Advanced routing operations

  • add_via, add_copper_pour

Direct Tools (Always Available)

These 12 tools are always visible for common operations:

Project Lifecycle:

  • create_project, open_project, save_project, get_project_info

Core PCB Operations:

  • place_component, move_component
  • add_net, route_trace
  • get_board_info, set_board_size
  • add_board_outline

UI Management:

  • check_kicad_ui

Router Tools

list_tool_categories

Browse all available tool categories.

Example:

Claude, what tool categories are available?

get_category_tools

View all tools in a specific category.

Example:

Show me all export tools available.

search_tools

Find tools by keyword.

Example:

Search for tools related to "gerber" or "mounting holes"

execute_tool

Execute any routed tool with parameters.

Example:

Execute the export_gerber tool with outputDir set to ./fabrication

Usage Examples

Just ask Claude what you want - it handles discovery automatically:

"Export gerber files to ./output"
"Add a mounting hole at x=10, y=10"
"Run a design rule check"
"Create a copper pour on the ground layer"

Manual Discovery (Optional)

You can also browse tools explicitly:

"List all tool categories"
"What export tools are available?"
"Search for DRC tools"

Benefits

  1. Reduced Context Usage: 70% less AI context consumed per conversation
  2. Organized Tools: Logical categorization makes tools easy to find
  3. Seamless Experience: Works transparently - no changes to how you interact
  4. Extensible: Easy to add new tools and categories
  5. Backwards Compatible: All existing tools still work

Technical Details

  • Registry: src/tools/registry.ts - Tool categorization and lookup
  • Router: src/tools/router.ts - Discovery and execution implementation
  • Server Integration: src/server.ts - Router tools registered at startup

For implementation details, see:

Token Savings

Before Router:

  • 122 tools × ~700 tokens each = ~85K tokens per conversation

After Router (Current):

  • 12 direct tools + 4 router tools = 16 tools visible
  • Routed tools discovered on-demand
  • ~12-15K tokens per conversation
  • ~80% reduction in context usage

The router pattern is complete and functional, providing efficient tool discovery while maintaining full access to all 122+ tools.