Koppar is an MCP server published by ai.koppar, hosted at app.koppar.ai. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 67 tools, including get_workflow_guide, create_design, leave_feedback, list_designs, delete_design.
Design a KiCad PCB from a prompt: parts, schematic checks, routing, KiCad DRC and Gerbers.
Nothing else in the archive shares these values.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
How to drive Koppar end to end, and the instructions for each stage you do yourself: "research" (part research and the dossier), "synthesis" (writing the SKiDL schematic), "review" (design review), "board" (the board plan). Read the stage guide before doing that stage.
| Parameter | Type | Description |
|---|---|---|
| stage * | string | overview | research | synthesis | review | board |
{
"name": "get_workflow_guide",
"title": "Workflow guide",
"description": "How to drive Koppar end to end, and the instructions for each stage you do yourself: \"research\" (part research and the dossier), \"synthesis\" (writing the SKiDL schematic), \"review\" (design review), \"board\" (the board plan). Read the stage guide before doing that stage.",
"inputSchema": {
"type": "object",
"required": [
"stage"
],
"properties": {
"stage": {
"enum": [
"overview",
"research",
"synthesis",
"review",
"board"
],
"type": "string",
"description": "overview | research | synthesis | review | board"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Start a new design from the user's brief (what the board must do, its interfaces, power, size and constraints). Returns the design_id every other tool takes and the web_url where the user follows the design. Uses no generation quota: the work is done by you.
| Parameter | Type | Description |
|---|---|---|
| brief * | string | The design brief, in the user's terms plus anything you clarified with them. |
| title | string | A short name for the design. |
| session_id | string | The project (web session) to put this design in: the session_id an earlier design of this board returned. Without it, a design whose title matches a project you opened before joins that project. |
| new_project | boolean | Start a new project even when one with this title exists. |
{
"name": "create_design",
"title": "Create a design",
"description": "Start a new design from the user's brief (what the board must do, its interfaces, power, size and constraints). Returns the design_id every other tool takes and the web_url where the user follows the design. Uses no generation quota: the work is done by you.",
"inputSchema": {
"type": "object",
"required": [
"brief"
],
"properties": {
"brief": {
"type": "string",
"description": "The design brief, in the user's terms plus anything you clarified with them."
},
"title": {
"type": "string",
"description": "A short name for the design."
},
"session_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,80}$",
"description": "The project (web session) to put this design in: the session_id an earlier design of this board returned. Without it, a design whose title matches a project you opened before joins that project."
},
"new_project": {
"type": "boolean",
"description": "Start a new project even when one with this title exists."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Send the Koppar team feedback from the user: about Koppar in general, or about one design (design_id). A rating from 1 to 5, a message, or both. Use it when the user asks you to pass something on, or tells you what worked or did not; say in the message what happened, in their words where you can. The team reads every one.
| Parameter | Type | Description |
|---|---|---|
| rating | integer | 1 (poor) to 5 (great), when the user gave one. |
| message | string | What the user wants us to know, in their words where you can. |
| design_id | string | The design it is about, when it is about one. |
{
"name": "leave_feedback",
"title": "Leave feedback",
"description": "Send the Koppar team feedback from the user: about Koppar in general, or about one design (design_id). A rating from 1 to 5, a message, or both. Use it when the user asks you to pass something on, or tells you what worked or did not; say in the message what happened, in their words where you can. The team reads every one.",
"inputSchema": {
"type": "object",
"properties": {
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"description": "1 (poor) to 5 (great), when the user gave one."
},
"message": {
"type": "string",
"description": "What the user wants us to know, in their words where you can."
},
"design_id": {
"type": "string",
"description": "The design it is about, when it is about one."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}The user's designs, newest first, including ones made in the web app (an agent can continue those too) and board workspaces (kind "board workspace"). With trashed, the designs in the trash instead.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many (default 20). |
| trashed | boolean | List the trash instead of the live designs. |
{
"name": "list_designs",
"title": "List designs",
"description": "The user's designs, newest first, including ones made in the web app (an agent can continue those too) and board workspaces (kind \"board workspace\"). With trashed, the designs in the trash instead.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many (default 20)."
},
"trashed": {
"type": "boolean",
"description": "List the trash instead of the live designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Move a design (or a board workspace) to the trash: it leaves list_designs and the web app, and restore_design brings it back. permanent deletes it with no trash to restore from. Refused while a run on it is in progress. The CLI: `koppar delete <design>`.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
| permanent | boolean | Remove it now, with no trash to restore from (default false). |
{
"name": "delete_design",
"title": "Delete a design",
"description": "Move a design (or a board workspace) to the trash: it leaves list_designs and the web app, and restore_design brings it back. permanent deletes it with no trash to restore from. Refused while a run on it is in progress. The CLI: `koppar delete <design>`.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"permanent": {
"type": "boolean",
"description": "Remove it now, with no trash to restore from (default false)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Put a deleted design back from the trash.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "restore_design",
"title": "Restore a design from the trash",
"description": "Put a deleted design back from the trash.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Where a design stands: the brief, the schematic (accepted or the last blocking error, ERC, part and net counts, submissions), the board run, the readable files, and the next step.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_design",
"title": "Design status",
"description": "Where a design stands: the brief, the schematic (accepted or the last blocking error, ERC, part and net counts, submissions), the board run, the readable files, and the next step.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Search KiCad's standard symbol libraries for parts whose name contains a substring. Use this whenever you are not 100% sure the (library, name) pair you're about to pass to Part(...) exists. Always prefer the package-suffixed variant the search returns over a generic name. If a part returns nothing here, get_kicad_symbol(library='custom', name='<part number>') may find it in the component database (a datasheet link and a pinout lead); register it with create_custom_symbol. Pass design_id so the lookup is recorded for the design's dossier and a registered part belongs to it.
| Parameter | Type | Description |
|---|---|---|
| query * | string | Substring to search for, e.g. 'NE555', 'USB-C', 'RP2040'. |
| library | string | Restrict to one symbol library, e.g. 'Timer'. |
| design_id | string | The design id returned by create_design or list_designs. |
{
"name": "search_kicad_symbol",
"title": "Search KiCad symbols",
"description": "Search KiCad's standard symbol libraries for parts whose name contains a substring. Use this whenever you are not 100% sure the (library, name) pair you're about to pass to Part(...) exists. Always prefer the package-suffixed variant the search returns over a generic name. If a part returns nothing here, get_kicad_symbol(library='custom', name='<part number>') may find it in the component database (a datasheet link and a pinout lead); register it with create_custom_symbol. Pass design_id so the lookup is recorded for the design's dossier and a registered part belongs to it.",
"inputSchema": {
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "Substring to search for, e.g. 'NE555', 'USB-C', 'RP2040'."
},
"library": {
"type": "string",
"description": "Restrict to one symbol library, e.g. 'Timer'."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Return the full pin list (number, name, electrical type) and description for a specific KiCad symbol. For some high-risk power parts it also returns curated topology_constraints from datasheet-style application notes and footprint_suggestions. Use this before writing pin connections (e.g. mcu['VCC'] += vcc) so names, constraints and footprints match the symbol exactly. For a part found in KiCad, the result is ALSO enriched with that part's topology + required external parts from a datasheet database (merged into topology_constraints). For a part NOT in KiCad (search returned nothing), call this with library='custom' and name='<part number>': the component database returns its datasheet link, package and an UNVERIFIED machine-extracted pinout. That is not a symbol: register the part with create_custom_symbol, whose pinout is checked against the datasheet. Pass design_id so the lookup is recorded for the design's dossier and a registered part belongs to it. Give library and name, or up to 12 of them in parts.
| Parameter | Type | Description |
|---|---|---|
| name | string | Symbol name, e.g. 'RP2040'. |
| parts | array | Batch form: several (library, name) pairs. |
| library | string | Symbol library, e.g. 'MCU_RaspberryPi', or 'custom' for a database part number. |
| design_id | string | The design id returned by create_design or list_designs. |
{
"name": "get_kicad_symbol",
"title": "Get a KiCad symbol",
"description": "Return the full pin list (number, name, electrical type) and description for a specific KiCad symbol. For some high-risk power parts it also returns curated topology_constraints from datasheet-style application notes and footprint_suggestions. Use this before writing pin connections (e.g. mcu['VCC'] += vcc) so names, constraints and footprints match the symbol exactly. For a part found in KiCad, the result is ALSO enriched with that part's topology + required external parts from a datasheet database (merged into topology_constraints). For a part NOT in KiCad (search returned nothing), call this with library='custom' and name='<part number>': the component database returns its datasheet link, package and an UNVERIFIED machine-extracted pinout. That is not a symbol: register the part with create_custom_symbol, whose pinout is checked against the datasheet. Pass design_id so the lookup is recorded for the design's dossier and a registered part belongs to it. Give library and name, or up to 12 of them in parts.",
"inputSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Symbol name, e.g. 'RP2040'."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"library",
"name"
],
"properties": {
"name": {
"type": "string"
},
"library": {
"type": "string"
}
}
},
"description": "Batch form: several (library, name) pairs."
},
"library": {
"type": "string",
"description": "Symbol library, e.g. 'MCU_RaspberryPi', or 'custom' for a database part number."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Search KiCad's standard footprint libraries. Returns 'Library:Footprint' strings suitable for the footprint= argument of Part(...). Query with the package family and pin count ('LGA-14', 'QFN-24', 'SOIC-8'), optionally a body size or pitch. When no name contains every word, near_misses lists footprints of the same package, ranked by body size and pitch. Pass design_id so the lookup is recorded for the design's dossier and a registered part belongs to it.
| Parameter | Type | Description |
|---|---|---|
| query * | string | Package to search for, e.g. 'SOIC-8', 'QFN-56 7x7', 'USB_C_Receptacle'. |
| design_id | string | The design id returned by create_design or list_designs. |
{
"name": "search_kicad_footprint",
"title": "Search KiCad footprints",
"description": "Search KiCad's standard footprint libraries. Returns 'Library:Footprint' strings suitable for the footprint= argument of Part(...). Query with the package family and pin count ('LGA-14', 'QFN-24', 'SOIC-8'), optionally a body size or pitch. When no name contains every word, near_misses lists footprints of the same package, ranked by body size and pitch. Pass design_id so the lookup is recorded for the design's dossier and a registered part belongs to it.",
"inputSchema": {
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "Package to search for, e.g. 'SOIC-8', 'QFN-56 7x7', 'USB_C_Receptacle'."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Register a connectable schematic symbol for a part that is NOT in KiCad's libraries (search_kicad_symbol returned nothing). Use this for specialty ICs — LED-matrix drivers, niche sensors, etc. — INSTEAD of telling the synthesizer to model the part with discrete passives (which leaves every pin dangling and breaks the board). Provide the full datasheet pinout. The part then becomes available to the synthesizer as Part('custom', '<name>') with the exact pin names you supply here, and is added to the Verified parts table. A part with three or more pins needs footprint= naming a real, in-library footprint for its package (search_kicad_footprint with the family and pin count, e.g. 'LGA-14'); the call is rejected without one, since a generated grid of pads cannot be assembled. List every pad of the footprint, NC pins included. When the package is not in KiCad's libraries, bring your own footprint instead: footprint_mod takes the whole .kicad_mod file as text (KiCad 6+, up to 1 MB; the CLI reads it with `koppar custom-symbol --footprint-file`). It is checked as a KiCad footprint, every pad must have a pin with that pad's number (and every pin a pad), and it is stored as 'custom:<name>': the symbol uses it, and it goes on the board, into project.zip and into the fp-lib-table. footprint is then not needed. The name is used for file names: letters, digits and _ . + - (anything else becomes _). The symbol belongs to design_id.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Part number, used as the symbol name (letters, digits, _ . + -). |
| pins * | array | Every pin from the datasheet. |
| datasheet | string | |
| design_id * | string | The design id returned by create_design or list_designs. |
| footprint | string |
Give the design a footprint of your own: a KiCad .kicad_mod (the file's text) for a package KiCad's libraries lack. It joins the design's "custom" footprint library and is used as "custom:<name>": pass that to create_custom_symbol (footprint=) or name it in the SKiDL script's footprint=; the board builder loads it like a library footprint and the KiCad project download carries it. The pads must be numbered like the pins. The CLI: `koppar footprint <design> part.kicad_mod`.
| Parameter | Type | Description |
|---|---|---|
| name | string | The footprint name (default: the name inside the file). |
| design_id * | string | The design id returned by create_design or list_designs. |
| kicad_mod * | string | The .kicad_mod file, as text. |
{
"name": "add_custom_footprint",
"title": "Add your own footprint",
"description": "Give the design a footprint of your own: a KiCad .kicad_mod (the file's text) for a package KiCad's libraries lack. It joins the design's \"custom\" footprint library and is used as \"custom:<name>\": pass that to create_custom_symbol (footprint=) or name it in the SKiDL script's footprint=; the board builder loads it like a library footprint and the KiCad project download carries it. The pads must be numbered like the pins. The CLI: `koppar footprint <design> part.kicad_mod`.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"kicad_mod"
],
"properties": {
"name": {
"type": "string",
"description": "The footprint name (default: the name inside the file)."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"kicad_mod": {
"type": "string",
"description": "The .kicad_mod file, as text."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Store the research dossier (markdown with ## Parts list, ## Power rails, ## Topology constraints, ## Notes, as the research guide describes). The verified pin tables from your lookups on this design are appended, and verified entries the design already had for parts you did not look up again are kept. Reports every (library, name) in the parts list that does not exist, with catalog candidates.
| Parameter | Type | Description |
|---|---|---|
| markdown * | string | The dossier. |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "save_dossier",
"title": "Save the parts dossier",
"description": "Store the research dossier (markdown with ## Parts list, ## Power rails, ## Topology constraints, ## Notes, as the research guide describes). The verified pin tables from your lookups on this design are appended, and verified entries the design already had for parts you did not look up again are kept. Reports every (library, name) in the parts list that does not exist, with catalog candidates.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"markdown"
],
"properties": {
"markdown": {
"type": "string",
"description": "The dossier."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Compile and check a complete SKiDL script: the symbol and footprint pre-flight (unambiguous typos are corrected and listed), SKiDL, the ERC score, KiCad ERC, floating subsystems, parts without a footprint, and supplier sourcing. Returns accepted plus blocking findings to fix and warnings. An accepted script becomes the design's circuit.py; one that is sent back is kept as attempt_N_circuit.py and leaves the design as it was. Takes up to a couple of minutes.
| Parameter | Type | Description |
|---|---|---|
| code * | string | The complete SKiDL Python script. |
| design_id * | string | The design id returned by create_design or list_designs. |
| check_sourcing | boolean | Check the parts against supplier catalogues (default true). |
{
"name": "submit_circuit",
"title": "Submit the schematic",
"description": "Compile and check a complete SKiDL script: the symbol and footprint pre-flight (unambiguous typos are corrected and listed), SKiDL, the ERC score, KiCad ERC, floating subsystems, parts without a footprint, and supplier sourcing. Returns accepted plus blocking findings to fix and warnings. An accepted script becomes the design's circuit.py; one that is sent back is kept as attempt_N_circuit.py and leaves the design as it was. Takes up to a couple of minutes.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"code"
],
"properties": {
"code": {
"type": "string",
"description": "The complete SKiDL Python script."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"check_sourcing": {
"type": "boolean",
"description": "Check the parts against supplier catalogues (default true)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}
}Apply SEARCH/REPLACE patches to your latest script and re-run every check, as submit_circuit does. The latest script is your last submission when it was sent back (attempt_N_circuit.py), otherwise the design's circuit.py. Each search must match the current file exactly once (whitespace-sensitive); an empty replace deletes. Nothing is applied if any block fails to match.
| Parameter | Type | Description |
|---|---|---|
| edits * | array | Ordered patches. |
| design_id * | string | The design id returned by create_design or list_designs. |
| check_sourcing | boolean | Check the parts against supplier catalogues (default true). |
{
"name": "edit_circuit",
"title": "Patch the schematic",
"description": "Apply SEARCH/REPLACE patches to your latest script and re-run every check, as submit_circuit does. The latest script is your last submission when it was sent back (attempt_N_circuit.py), otherwise the design's circuit.py. Each search must match the current file exactly once (whitespace-sensitive); an empty replace deletes. Nothing is applied if any block fails to match.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"edits"
],
"properties": {
"edits": {
"type": "array",
"items": {
"type": "object",
"required": [
"search",
"replace"
],
"properties": {
"search": {
"type": "string"
},
"replace": {
"type": "string"
}
}
},
"description": "Ordered patches."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"check_sourcing": {
"type": "boolean",
"description": "Check the parts against supplier catalogues (default true)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}
}Read a text file of the design: prompt.txt (brief), dossier.md, circuit.py, circuit.net, result.json, circuit.erc.json (KiCad ERC violations), attempt_N_circuit.py / attempt_N_error.txt, board_plan.json, pcb_result.json, pcb_run.log, circuit.drc.json (KiCad DRC), netclasses.resolved.json, dfm.json, harness.log.
| Parameter | Type | Description |
|---|---|---|
| path * | string | A file name, e.g. 'circuit.py'. |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "read_design_file",
"title": "Read a design file",
"description": "Read a text file of the design: prompt.txt (brief), dossier.md, circuit.py, circuit.net, result.json, circuit.erc.json (KiCad ERC violations), attempt_N_circuit.py / attempt_N_error.txt, board_plan.json, pcb_result.json, pcb_run.log, circuit.drc.json (KiCad DRC), netclasses.resolved.json, dfm.json, harness.log.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"path"
],
"properties": {
"path": {
"type": "string",
"description": "A file name, e.g. 'circuit.py'."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Everything a design review needs in one text: the brief, the dossier, circuit.py and the compiled connectivity (every net with every pin and its function), with the reviewer instructions. Review it yourself and fix blockers with edit_circuit.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_review_packet",
"title": "Design review packet",
"description": "Everything a design review needs in one text: the brief, the dossier, circuit.py and the compiled connectivity (every net with every pin and its function), with the reviewer instructions. Review it yourself and fix blockers with edit_circuit.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}What the board plan is decided from: the computed minimum board, BOARD STATS (pad density, fine-pitch parts, fanout), the parts and nets, board instructions the user gave, and the plan schema with its rules. Needs an accepted schematic.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_board_context",
"title": "Board planning context",
"description": "What the board plan is decided from: the computed minimum board, BOARD STATS (pad density, fine-pitch parts, fanout), the parts and nets, board instructions the user gave, and the plan schema with its rules. Needs an accepted schematic.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Start place and route with your board plan (the JSON object from the board guide: board, stated, edge, chain, groups, near, side, fixed, keepouts, netClasses). The plan is clamped and returned as applied. Runs for minutes in the background: follow it with get_board_status. Needs an accepted schematic; one board run per design at a time.
| Parameter | Type | Description |
|---|---|---|
| plan | object | The board plan object. Omit for the default plan. |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "start_board",
"title": "Place and route the board",
"description": "Start place and route with your board plan (the JSON object from the board guide: board, stated, edge, chain, groups, near, side, fixed, keepouts, netClasses). The plan is clamped and returned as applied. Runs for minutes in the background: follow it with get_board_status. Needs an accepted schematic; one board run per design at a time.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"plan": {
"type": "object",
"description": "The board plan object. Omit for the default plan.",
"additionalProperties": {}
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}The board run: stage, size, layers, placement, routing completion, open nets, DRC counts; once finished, DRC violations by type, whether the fab files are released and, when not, the diagnosed causes (first = fix first: parts that did not fit, collisions, missing footprints, open nets, thin power). wait_s holds the call until the run ends (or that many seconds pass).
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait for a running board to finish (max 55). |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_board_status",
"title": "Board status",
"description": "The board run: stage, size, layers, placement, routing completion, open nets, DRC counts; once finished, DRC violations by type, whether the fab files are released and, when not, the diagnosed causes (first = fix first: parts that did not fit, collisions, missing footprints, open nets, thin power). wait_s holds the call until the run ends (or that many seconds pass).",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait for a running board to finish (max 55)."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}The live-priced BOM: each line with references, value, footprint, the chosen offer (seller, part number, MPN, price, stock, match quality), alternatives and totals. refresh asks the sellers again (tens of seconds).
| Parameter | Type | Description |
|---|---|---|
| tier | string | JLCPCB PCBA tier to source for, kept with the design. 'economic' swaps Standard-only parts for Economic-eligible ones that match as well; default 'standard' (no filter). The BOM reports which parts decide the tier either way. |
| boards | integer | Boards to price for (default 1). |
| refresh | boolean | Ask the sellers again instead of the stored prices. |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_bom",
"title": "Bill of materials",
"description": "The live-priced BOM: each line with references, value, footprint, the chosen offer (seller, part number, MPN, price, stock, match quality), alternatives and totals. refresh asks the sellers again (tens of seconds).",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"tier": {
"enum": [
"economic",
"standard"
],
"type": "string",
"description": "JLCPCB PCBA tier to source for, kept with the design. 'economic' swaps Standard-only parts for Economic-eligible ones that match as well; default 'standard' (no filter). The BOM reports which parts decide the tier either way."
},
"boards": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Boards to price for (default 1)."
},
"refresh": {
"type": "boolean",
"description": "Ask the sellers again instead of the stored prices."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Pick which offer a BOM line uses: the line's references and a seller part number or MPN from its offer or alternatives in get_bom; null goes back to the automatic pick. Sourcing only: a different component is a circuit change.
| Parameter | Type | Description |
|---|---|---|
| part * | any | Seller part number or MPN from get_bom, or null. |
| refs * | array | References of the line, e.g. ["C1","C2"]. |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "choose_bom_part",
"title": "Choose a BOM offer",
"description": "Pick which offer a BOM line uses: the line's references and a seller part number or MPN from its offer or alternatives in get_bom; null goes back to the automatic pick. Sourcing only: a different component is a circuit change.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"refs",
"part"
],
"properties": {
"part": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Seller part number or MPN from get_bom, or null."
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"description": "References of the line, e.g. [\"C1\",\"C2\"]."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}
}Move every resistor, capacitor and inductor bought outside JLCPCB's basic library onto an in-stock basic-library part of the same value, package and (capacitors) at least the same voltage rating. Each part outside that library adds a loading fee to a JLCPCB order, usually more than the part. Each swap becomes the line's choice (choose_bom_part with null undoes it); lines with no readable value, no SMD size or no basic part are reported and left alone.
| Parameter | Type | Description |
|---|---|---|
| boards | integer | Boards the stock must cover (default 1). |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "consolidate_bom_basic",
"title": "Consolidate the BOM to JLCPCB basic parts",
"description": "Move every resistor, capacitor and inductor bought outside JLCPCB's basic library onto an in-stock basic-library part of the same value, package and (capacitors) at least the same voltage rating. Each part outside that library adds a loading fee to a JLCPCB order, usually more than the part. Each swap becomes the line's choice (choose_bom_part with null undoes it); lines with no readable value, no SMD size or no basic part are reported and left alone.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"boards": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Boards the stock must cover (default 1)."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}
}Whether the board has earned its fab files (zero serious DRC errors, nothing unconnected), and if not, why not.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_fab_status",
"title": "Fab release status",
"description": "Whether the board has earned its fab files (zero serious DRC errors, nothing unconnected), and if not, why not.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}The PCB and assembly providers, whether each can quote and take this kind of board today, and what a handoff sends them.
No parameters.
{
"name": "list_order_providers",
"title": "Manufacturers",
"description": "The PCB and assembly providers, whether each can quote and take this kind of board today, and what a handoff sends them.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One price for a quantity: parts from the sellers, the board and assembly from the chosen provider's quote, setup fees, and what the total does not include.
| Parameter | Type | Description |
|---|---|---|
| boards | integer | Quantity (default 1). |
| provider | string | Provider id from list_order_providers, e.g. "jlcpcb". |
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_order_price",
"title": "Order price",
"description": "One price for a quantity: parts from the sellers, the board and assembly from the chosen provider's quote, setup fees, and what the total does not include.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"boards": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Quantity (default 1)."
},
"provider": {
"type": "string",
"description": "Provider id from list_order_providers, e.g. \"jlcpcb\"."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Upload the released board (Gerbers, BOM, placement) to a manufacturer and return the page where the user pays. This publishes the design to a third party: call it only when the user has explicitly asked to order from that provider, and set user_confirmed only then. Some providers need a shipping address.
| Parameter | Type | Description |
|---|---|---|
| title | string | Order title at the provider. |
| boards | integer | Quantity (default 1). |
| provider * | string | Provider id from list_order_providers. |
| shipping | object | Delivery address, for providers that need one. |
| design_id * | string | The design id returned by create_design or list_designs. |
| user_confirmed * | boolean | The user explicitly asked to send this design to this provider. |
{
"name": "send_order_to_provider",
"title": "Send the order to a manufacturer",
"description": "Upload the released board (Gerbers, BOM, placement) to a manufacturer and return the page where the user pays. This publishes the design to a third party: call it only when the user has explicitly asked to order from that provider, and set user_confirmed only then. Some providers need a shipping address.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"provider",
"user_confirmed"
],
"properties": {
"title": {
"type": "string",
"description": "Order title at the provider."
},
"boards": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Quantity (default 1)."
},
"provider": {
"type": "string",
"description": "Provider id from list_order_providers."
},
"shipping": {
"type": "object",
"required": [
"countryCode",
"city",
"postalCode",
"address",
"contactName",
"phone"
],
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"state": {
"type": "string"
},
"address": {
"type": "string"
},
"company": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"contactName": {
"type": "string"
},
"countryCode": {
"type": "string"
}
},
"description": "Delivery address, for providers that need one."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"user_confirmed": {
"type": "boolean",
"const": true,
"description": "The user explicitly asked to send this design to this provider."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": true
}
}Replace the design's board with a .kicad_pcb you routed or edited yourself (the file, base64). The board must carry the design's circuit: every schematic part by reference, every pad on the net the netlist gives it; a footprint swap is allowed and recorded. Anything else is refused with the list of differences and nothing changes. The previous board is kept as circuit.before-upload.kicad_pcb. KiCad DRC judges the new board and releases or withholds the Gerbers, and the session chat gets a note of the upload. Not for a board workspace (import_kicad_project): its board tools edit the board in place.
| Parameter | Type | Description |
|---|---|---|
| note | string | What was done to the board, for the session chat. |
| design_id * | string | The design id returned by create_design or list_designs. |
| board_base64 | string | The .kicad_pcb file, base64 (or give workspace_id). |
| rules_base64 | string | The .kicad_dru beside the board, base64. |
| workspace_id | string | A board workspace of yours (import_kicad_project, e.g. one made from this design with from_design_id): its board, project rules and .kicad_dru are taken from there, no download and upload. |
| project_base64 | string | The .kicad_pro beside the board, base64: its design rules and net classes judge the board (without it the design keeps its own). |
Download URLs for the design (KiCad project, schematic, netlist, BOM CSV, board file, 3D model, Gerbers, order bundle) and which are available now. They take the same Authorization: Bearer API key; the CLI fetches them with `koppar download <design> <artifact>`.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by create_design or list_designs. |
{
"name": "get_downloads",
"title": "Downloads",
"description": "Download URLs for the design (KiCad project, schematic, netlist, BOM CSV, board file, 3D model, Gerbers, order bundle) and which are available now. They take the same Authorization: Bearer API key; the CLI fetches them with `koppar download <design> <artifact>`.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Bring an existing KiCad project in as a board workspace: the project folder as a ZIP (the .kicad_pcb, .kicad_pro, schematics, footprint and 3D-model folders), base64-encoded, up to about 18 MB zipped. An Altium Designer project (the .PcbDoc at the top of the ZIP) is converted with KiCad: the board, and its clearance, width, via and differential-pair rules as net classes; the reply lists the rules not carried (rooms, layers, lengths). The CLI does this with `koppar import <folder>`. Or from_design_id: the KiCad project of a design the pipeline built (its board, rules, schematics and custom footprints) opened as a workspace, to change the design rules, place and route it with the board tools and put the result back with upload_board (workspace_id). Returns the design_id the board tools take and a first get_board_info. A new revision of a board you already imported (changed in KiCad) is imported again with the session_id the first import returned: it opens as a new design in that same project, beside the revisions before it, so one board stays one project in the user's list. Not for changes the board tools can make on the design you have: work on that design_id.
| Parameter | Type | Description |
|---|---|---|
| brief | string | A note for the design record. No tool reads it: what to keep, widths and layers go in the options of set_design_rules and route_board. |
| title | string | |
| board_file | string | Which .kicad_pcb (or Altium .PcbDoc) at the top of the project, when there are several. |
| session_id | string | The project (web session) a new revision of this board goes into: the session_id the first import returned. Without it, an import whose title matches a project you opened before, or whose board file (the .kicad_pcb name) one of your imports had, joins that project, so revisions of one board stay tog… |
| zip_base64 | string |
The board as it stands: copper layers, outline, design rules and net classes, counts (footprints, nets, tracks, vias, zones, keepouts, KiCad unconnected items), zones and keepouts, and every footprint with reference, value, footprint, position (origin, mm), rotation, side, locked, DNP, courtyard box and 3D models.
| Parameter | Type | Description |
|---|---|---|
| refs | array | Only these footprints. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| include_footprints | boolean | List footprints (default true). |
{
"name": "get_board_info",
"title": "Board info",
"description": "The board as it stands: copper layers, outline, design rules and net classes, counts (footprints, nets, tracks, vias, zones, keepouts, KiCad unconnected items), zones and keepouts, and every footprint with reference, value, footprint, position (origin, mm), rotation, side, locked, DNP, courtyard box and 3D models.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"refs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only these footprints."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"include_footprints": {
"type": "boolean",
"description": "List footprints (default true)."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Put footprints exactly where given: KiCad board coordinates of the footprint origin in mm (y grows downward), rotation in degrees as KiCad shows it, side F or B (changing side flips the footprint, as KiCad does), locked. dx_mm/dy_mm/drot_deg move relative to where it is. Nothing is nudged or legalized: overlaps are for run_drc to report. Unknown references come back in missing.
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| placements * | array |
{
"name": "place_footprints",
"title": "Place footprints exactly",
"description": "Put footprints exactly where given: KiCad board coordinates of the footprint origin in mm (y grows downward), rotation in degrees as KiCad shows it, side F or B (changing side flips the footprint, as KiCad does), locked. dx_mm/dy_mm/drot_deg move relative to where it is. Nothing is nudged or legalized: overlaps are for run_drc to report. Unknown references come back in missing.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"placements"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"placements": {
"type": "array",
"items": {
"type": "object",
"required": [
"ref"
],
"properties": {
"ref": {
"type": "string"
},
"side": {
"enum": [
"F",
"B"
],
"type": "string"
},
"x_mm": {
"type": "number"
},
"y_mm": {
"type": "number"
},
"dx_mm": {
"type": "number"
},
"dy_mm": {
"type": "number"
},
"locked": {
"type": "boolean"
},
"rot_deg": {
"type": "number"
},
"drot_deg": {
"type": "number"
}
}
}
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Pack footprints inside the board outline with Koppar's heuristic placer (ratsnest-driven, courtyard-legal). By default every unlocked footprint moves and locked ones stay; refs names exactly which move (all others stay). Constraints: fixed (exact origin positions and rotation, never moved; locked footprints likewise), side, keepouts (rectangles), groups, near (ref within maxMm of an anchor), edge (ref to "left|right|top|bottom", optionally "@mm" along that edge from the outline's top-left corner). Nothing is left past the outline except a USB/barrel/jack opening's 1.2 mm lip; placement_notes lists every part that could not be placed where asked. Coarse by design: refine the result with place_footprints.
| Parameter | Type | Description |
|---|---|---|
| edge | object | Ref to the edge it sits on, optionally @mm: where along that edge its centre goes, from the outline's top-left corner (x on top/bottom, y on left/right). |
| near | array | |
| refs | array | The footprints that may move. |
| side | object | |
| fixed | object | |
| shove | number | Legaliser: a part may take a spot held only by movable parts under this fraction of its area (default 0.3, 0 off). |
| groups | array | |
| placer | string | "ml": the learned placer service (dense, two-sided when two_sided, honours keepouts); the packer when it is unavailable. |
| refine |
Dense placement by simulated annealing: wirelength inside the real outline (Edge.Cuts with its corners, notches and cutouts; a separate piece no held part stands on is left out) with courtyard gaps, edge connectors held on their edge, fixed and locked parts held, and, unless refs is given, the mounting holes, connectors and switches already on the board held too (held_mechanical). Kept clear: keepout rectangles (routing corridors) and the board's and held footprints' rule areas that forbid pads or footprints, on their own faces. A per-pad price for the bottom side (flip_cost, mm of wirelength; each bottom-side pad whose net has top-side pins costs a via). Starts from the current positions unless from_scratch. The result is legalised: no part on another, in a keep-out or off the board; a part with no legal spot that started off the board stays there (unplaced), and a result worse than the board had is not saved (the op fails, the board unchanged). Iterations scale with the parts moved within a 150 s budget: leave iterations unset.
| Parameter | Type | Description |
|---|---|---|
| t0 | number | Start temperature (default 15). ~0.5 keeps the current placement and only tidies it (refine, or squeeze into a smaller outline). |
| edge | object | Connector ref to the edge it sits on, optionally @mm: where along that edge its centre goes, from the outline's top-left corner (x on top/bottom, y on left/right) — the same meaning as in auto_place and a board plan. A fixed or locked ref keeps its pin. |
| halo | object | Routing room per ref, mm (a number all round, or footprint-local [left, top, right, bottom]). |
| near | array | Keep ref at its anchor (a decoupling capacitor at its IC, a crystal at its MCU): the board plan's near constraint, as a strong pull in the anneal. |
| refs | array | The footprints that may move (default: every unlocked one). |
Replace everything on Edge.Cuts with a new outline: rect (optionally with corner_radius_mm), a polygon of points, or fit_to_parts (the rectangle around every footprint courtyard plus margin_mm). Give exactly one.
| Parameter | Type | Description |
|---|---|---|
| rect | object | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| polygon | array | |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| fit_to_parts | object | |
| line_width_mm | number |
{
"name": "set_board_outline",
"title": "Set the board outline",
"description": "Replace everything on Edge.Cuts with a new outline: rect (optionally with corner_radius_mm), a polygon of points, or fit_to_parts (the rectangle around every footprint courtyard plus margin_mm). Give exactly one.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"rect": {
"type": "object",
"required": [
"x_mm",
"y_mm",
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"w_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"x_mm": {
"type": "number",
"description": "Left edge, board coordinates (KiCad mm, y grows downward)."
},
"y_mm": {
"type": "number",
"description": "Top edge."
},
"corner_radius_mm": {
"type": "number",
"minimum": 0
}
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": false,
"description": "[x_mm, y_mm]",
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
]
}
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"fit_to_parts": {
"type": "object",
"required": [
"margin_mm"
],
"properties": {
"margin_mm": {
"type": "number",
"maximum": 50,
"minimum": 0
},
"corner_radius_mm": {
"type": "number",
"minimum": 0
}
}
},
"line_width_mm": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Set the project design rules (.kicad_pro) and copper layer count. Works on a board workspace and on a generated design (create_design → start_board). On a generated design the rules go into circuit.kicad_pro/.kicad_dru in place (the previous ones are snapshotted under rules_revisions/), are kept by every later project write (project.zip, a new board run), the copper is not changed and KiCad DRC judges the board against them at once: the reply carries the DRC counts and whether the Gerbers are released; the next start_board routes to the default_* values. copper_layers, stackup and board_thickness_mm are workspace-only (a generated design changes them with a new board). preset "jlcpcb" applies JLCPCB's published minimums for the layer count and writes their per-feature limits (plated rings, pad hole spacing, hole-to-track) as KiCad custom rules (.kicad_dru) that run_drc checks; explicit values override the minimums. Board minimums (min_*), the Default net class (default_*), and named net classes with their net patterns. route_board routes with these rules and run_drc checks against them. Changing copper_layers rebuilds the stackup; tracks on removed layers are reported. copper_layers 1 is a single-sided board (hand etching): the KiCad file keeps F.Cu and B.Cu, and from then on the routers hold to one face (B.Cu as soon as a THT pad exists, else F.Cu) and place no via; copper on the other face is removed.
| Parameter | Type | Description |
|---|---|---|
| preset | string | one of ["jlcpcb"] |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| stackup | string | 1.6 mm impedance stackups, written into the board: JLCPCB's 4-layer 7628 (0.21 mm prepreg, their default) or 3313 (0.1 mm prepreg: thinner pairs for the same impedance), and 6- / 8-layer 3313 builds (approximations of the fab's, from its 3313 outer prepreg and human 1.6 mm boards). Needed before a n… |
| design_id * | string |
Add or remove keepout rule areas. Each keepout is a rect or polygon on the given copper layers (default all) and forbids what it names: no_tracks, no_vias, no_zone_fills (all three default true), no_pads, no_footprints. route_board keeps tracks and vias out of them and KiCad DRC enforces them. remove takes names (wildcards allowed).
| Parameter | Type | Description |
|---|---|---|
| add | array | |
| remove | array | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "set_keepouts",
"title": "Keepout areas",
"description": "Add or remove keepout rule areas. Each keepout is a rect or polygon on the given copper layers (default all) and forbids what it names: no_tracks, no_vias, no_zone_fills (all three default true), no_pads, no_footprints. route_board keeps tracks and vias out of them and KiCad DRC enforces them. remove takes names (wildcards allowed).",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"rect": {
"type": "object",
"required": [
"x_mm",
"y_mm",
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"w_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"x_mm": {
"type": "number",
"description": "Left edge, board coordinates (KiCad mm, y grows downward)."
},
"y_mm": {
"type": "number",
"description": "Top edge."
}
}
},
"layers": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(F|B|In\\d{1,2})\\.Cu$"
}
},
"no_pads": {
"type": "boolean"
},
"no_vias": {
"type": "boolean"
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": false,
"description": "[x_mm, y_mm]",
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
]
}
},
"no_tracks": {
"type": "boolean"
},
"no_footprints": {
"type": "boolean"
},
"no_zone_fills": {
"type": "boolean"
}
}
}
},
"remove": {
"type": "array",
"items": {
"type": "string"
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Check the copper against the project's net classes and differential pairs, which KiCad's DRC does not: every class or pair net's narrowest track and the length below its class width, and every pair (X_P/X_N, X+/X-, CAN X_H/X_L) with its coupled share at the class's diff_pair_gap, both lengths and the skew. Routing applies the same rules.
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "check_net_rules",
"title": "Check net classes and pairs",
"description": "Check the copper against the project's net classes and differential pairs, which KiCad's DRC does not: every class or pair net's narrowest track and the length below its class width, and every pair (X_P/X_N, X+/X-, CAN X_H/X_L) with its coupled share at the class's diff_pair_gap, both lengths and the skew. Routing applies the same rules.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Judge the copper by physics, which KiCad's DRC does not: impedance from the stackup on controlled nets, IR drop and heating on rails with a stated current, pair and lane skew, a ground via beside every high-speed layer change, 3W spacing between high-speed runs, and the via path under exposed paddles. Each check runs only when the board states something it can judge. With repair, the fixable findings are fixed in place (track width, skew meanders, return vias, widened rails), each kept only if KiCad counts nothing worse. finish_board runs the same repairs.
| Parameter | Type | Description |
|---|---|---|
| repair | boolean | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "check_physics",
"title": "Check the physics",
"description": "Judge the copper by physics, which KiCad's DRC does not: impedance from the stackup on controlled nets, IR drop and heating on rails with a stated current, pair and lane skew, a ground via beside every high-speed layer change, 3W spacing between high-speed runs, and the via path under exposed paddles. Each check runs only when the board states something it can judge. With repair, the fixable findings are fixed in place (track width, skew meanders, return vias, widened rails), each kept only if KiCad counts nothing worse. finish_board runs the same repairs.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"repair": {
"type": "boolean"
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Add or remove copper zones (pours). Each zone pours its net on the given copper layers over rect or polygon, by default the whole board outline. priority orders overlapping zones (higher fills first); clearance_mm and min_thickness_mm override the rules; thermal false connects pads solid. remove takes zone or net names (wildcards allowed) and never touches keepout areas. Run fill_zones afterwards, then run_drc.
| Parameter | Type | Description |
|---|---|---|
| add | array | |
| remove | array | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "set_zones",
"title": "Copper zones",
"description": "Add or remove copper zones (pours). Each zone pours its net on the given copper layers over rect or polygon, by default the whole board outline. priority orders overlapping zones (higher fills first); clearance_mm and min_thickness_mm override the rules; thermal false connects pads solid. remove takes zone or net names (wildcards allowed) and never touches keepout areas. Run fill_zones afterwards, then run_drc.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "object",
"required": [
"net",
"layers"
],
"properties": {
"net": {
"type": "string"
},
"name": {
"type": "string"
},
"rect": {
"type": "object",
"required": [
"x_mm",
"y_mm",
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"w_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"x_mm": {
"type": "number",
"description": "Left edge, board coordinates (KiCad mm, y grows downward)."
},
"y_mm": {
"type": "number",
"description": "Top edge."
}
}
},
"layers": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(F|B|In\\d{1,2})\\.Cu$"
}
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": false,
"description": "[x_mm, y_mm]",
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
]
}
},
"thermal": {
"type": "boolean"
},
"priority": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"clearance_mm": {
"type": "number",
"maximum": 5,
"exclusiveMinimum": 0
},
"min_thickness_mm": {
"type": "number",
"maximum": 5,
"exclusiveMinimum": 0
}
}
}
},
"remove": {
"type": "array",
"items": {
"type": "string"
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Lay exact copper by hand where the routers leave a gap: tracks as polylines on one copper layer, and through vias. width_mm, diameter_mm and drill_mm default to the board's current track and via sizes. Nets must exist on the board. Nothing is checked here: run_drc afterwards, and ripup_routing takes copper back out.
| Parameter | Type | Description |
|---|---|---|
| vias | array | |
| tracks | array | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "add_copper",
"title": "Add tracks and vias",
"description": "Lay exact copper by hand where the routers leave a gap: tracks as polylines on one copper layer, and through vias. width_mm, diameter_mm and drill_mm default to the board's current track and via sizes. Nets must exist on the board. Nothing is checked here: run_drc afterwards, and ripup_routing takes copper back out.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"vias": {
"type": "array",
"items": {
"type": "object",
"required": [
"net",
"x_mm",
"y_mm"
],
"properties": {
"net": {
"type": "string"
},
"x_mm": {
"type": "number"
},
"y_mm": {
"type": "number"
},
"drill_mm": {
"type": "number",
"maximum": 5,
"exclusiveMinimum": 0
},
"diameter_mm": {
"type": "number",
"maximum": 5,
"exclusiveMinimum": 0
}
}
}
},
"tracks": {
"type": "array",
"items": {
"type": "object",
"required": [
"net",
"layer",
"points"
],
"properties": {
"net": {
"type": "string"
},
"layer": {
"type": "string",
"pattern": "^(F|B|In\\d{1,2})\\.Cu$"
},
"points": {
"type": "array",
"items": {
"type": "array",
"items": false,
"description": "[x_mm, y_mm]",
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
]
}
},
"width_mm": {
"type": "number",
"maximum": 10,
"exclusiveMinimum": 0
}
}
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Remove every via the board does not need: groups of vias come out, the zones are refilled and KiCad's unconnected count compared, and a via stays only if removing it disconnects something. nets limits the candidates (GND and the plane rails first: pours already join most of their pads). Runs for minutes on a large board; then fill_zones, run_drc.
| Parameter | Type | Description |
|---|---|---|
| nets | array | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| workers | integer | |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "prune_vias",
"title": "Remove redundant vias",
"description": "Remove every via the board does not need: groups of vias come out, the zones are refilled and KiCad's unconnected count compared, and a via stays only if removing it disconnects something. nets limits the candidates (GND and the plane rails first: pours already join most of their pads). Runs for minutes on a large board; then fill_zones, run_drc.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"workers": {
"type": "integer",
"maximum": 8,
"minimum": 1
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Take clutter off the silkscreen. values "hide" (default) hides value and part-number fields; references "keep" (default), "fab" (moved to the fabrication layer) or "hide"; texts "fab" moves footprint texts off the silkscreen. run_drc's silk_overlap and silk_over_copper warnings count what is left.
| Parameter | Type | Description |
|---|---|---|
| texts | string | one of ["keep","fab"] |
| values | string | one of ["hide","show"] |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| references | string | one of ["keep","fab","hide"] |
{
"name": "set_silkscreen",
"title": "Tidy the silkscreen",
"description": "Take clutter off the silkscreen. values \"hide\" (default) hides value and part-number fields; references \"keep\" (default), \"fab\" (moved to the fabrication layer) or \"hide\"; texts \"fab\" moves footprint texts off the silkscreen. run_drc's silk_overlap and silk_over_copper warnings count what is left.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"texts": {
"enum": [
"keep",
"fab"
],
"type": "string"
},
"values": {
"enum": [
"hide",
"show"
],
"type": "string"
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"references": {
"enum": [
"keep",
"fab",
"hide"
],
"type": "string"
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Route under the project's rules and net classes. By default (no nets, no router, none of the single-route options below) it runs the full route pipeline Koppar benchmarks: the learned router on the whole board, repair rounds on what stays open, copper finishing (0/45/90 runs) and one repair round after it, inside one wall-clock cap: time_budget_s is that cap (default 1200, up to 1500), so the job runs up to about 20 minutes: follow it with get_board_job. The result gives the final unconnected items and DRC errors and a pipeline summary: the counts after the route and after each finish, whether the copper finishing was kept. preserve_existing unset keeps the copper of a board that has tracks or vias and routes a board without any from scratch; false routes every net again. pours, ml_options, pairs_first and class_vias shape the route and the repair rounds of that pipeline. nets, router, seed_existing or a rule override (clearance_mm, track_width_mm, via sizes, edge_clearance_mm: this run only, so not the pipeline, whose later stages hold the project rules) runs ONE route instead, with no copper finishing, for expert control (tidy_copper after it straightens the copper): nets limits it to those nets; preserve_existing (default true) keeps every track and via already on the board and routes only what is still open. pours: "keep" (the default on a board you brought) keeps the board's zones, and a zone of a net the route lays is that net's plane: each of its pads gets a via to it and the net is not routed as tracks (zones first, then route); "engine" drops them and lets the router plan its own planes. Rule overrides apply to this run only. The learned router takes its via discipline in ml_options. A single route takes time_budget_s (default 120, up to 900).
| Parameter | Type | Description |
|---|---|---|
| nets | array | Net names; * and ? wildcards, e.g. ["USB_D*", "+3V3"]. |
| pours | string | one of ["keep","engine"] |
| router | string | Unset: the full pipeline (above) on the whole board, "ml" for nets. "ml": the learned router service alone, 1 to 8 layers; the time budget is its deadline. Nets outside the nets scope, and with preserve_existing the nets their copper already connects, keep that copper and everything else is routed a… |
Bring a routed board to a changed circuit and keep every track that is still right: what KiCad calls Update PCB from Schematic, then the routing. New parts go on the board (place: a connector on an edge, the board grown when there is no room, the rest in free room near what they connect to; placements for exact poses), moved or re-netted pads lose only the branch of copper that led to them, copper a new part lands on goes, and only what is open is routed, with the rules read off the board. The answer says how many tracks and vias were kept, ripped and added, what is still open, and the errors that touch the change. A route that takes copper off the rip list is refused and the board stays.
| Parameter | Type | Description |
|---|---|---|
| place | array | New parts without a pose yet, and where they should go. |
| remove | array | Parts that leave the board. Parts in no netlist (a logo, a fiducial) stay otherwise. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| netlist * | string | The new KiCad netlist, as text. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| placements | object | Reference -> exact pose, for new parts and parts that move. |
| time_budget_s | integer |
Keep the copper of every net it already connects and route the nets still open around it: route_board with preserve_existing, with the learned router service. Default budget 120 s.
| Parameter | Type | Description |
|---|---|---|
| nets | array | Net names; * and ? wildcards, e.g. ["USB_D*", "+3V3"]. |
| pours | string | one of ["keep","engine"] |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| compact | boolean | Via choice as on route_board: true for the densest legal via (JLCPCB Kelvin test), false for the Kelvin-free 0.45/0.2. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| time_budget_s | integer |
{
"name": "repair_board",
"title": "Repair open connections",
"description": "Keep the copper of every net it already connects and route the nets still open around it: route_board with preserve_existing, with the learned router service. Default budget 120 s.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Net names; * and ? wildcards, e.g. [\"USB_D*\", \"+3V3\"]."
},
"pours": {
"enum": [
"keep",
"engine"
],
"type": "string"
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"compact": {
"type": "boolean",
"description": "Via choice as on route_board: true for the densest legal via (JLCPCB Kelvin test), false for the Kelvin-free 0.45/0.2."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"time_budget_s": {
"type": "integer",
"maximum": 900,
"minimum": 10
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Delete tracks and vias: of the given nets, on the given layers (vias are not layer-filtered), with an end inside region, or all. Filters combine. tracks/vias choose which kinds (both by default); zones also deletes the copper zones (pours) the same filters match (a zone inside region), never keepout areas. Locked items stay unless include_locked.
| Parameter | Type | Description |
|---|---|---|
| all | boolean | |
| nets | array | Net names; * and ? wildcards, e.g. ["USB_D*", "+3V3"]. |
| vias | boolean | |
| zones | boolean | |
| layers | array | |
| region | object | |
| tracks | boolean | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| include_locked | boolean |
Sweep the routing: zero-length and duplicate tracks, stub tracks (a free end, and everything the track touches stays joined without it), and vias that meet their net on fewer than two layers. Contact is copper overlap, as KiCad judges it. Refills the zones first so pours count as connections. Locked items stay. The board is put back if the unconnected count or the DRC errors rise. A track running on past its last junction is cut back to it (trim_overhangs). list_removed names every item that went.
| Parameter | Type | Description |
|---|---|---|
| refill | boolean | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| list_removed | boolean | |
| trim_overhangs | boolean | |
| dangling_tracks | boolean | |
| duplicate_tracks | boolean | |
| unconnected_vias | boolean |
Unpack a ZIP into the project folder, keeping its paths: new footprints into a .pretty library the fp-lib-table names, 3D models, a library table. Existing files are kept unless overwrite is true; the reply lists written, replaced and kept files. Base64, up to about 18 MB zipped.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| overwrite | boolean | |
| zip_base64 * | string |
{
"name": "add_project_files",
"title": "Add files to the project",
"description": "Unpack a ZIP into the project folder, keeping its paths: new footprints into a .pretty library the fp-lib-table names, 3D models, a library table. Existing files are kept unless overwrite is true; the reply lists written, replaced and kept files. Base64, up to about 18 MB zipped.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"zip_base64"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"overwrite": {
"type": "boolean"
},
"zip_base64": {
"type": "string"
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Replace footprints in place with another footprint from a library in the project's fp-lib-table (library:name): the reference, value, position, rotation (or rot_deg), side, lock and schematic link stay, and nets move pad by pad. pad_map maps a NEW pad number to the OLD pad whose net it takes, for packages numbered differently. The schematic symbols' Footprint fields are updated too. Reports new pads left without a net and old nets left behind.
| Parameter | Type | Description |
|---|---|---|
| swaps * | array | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "swap_footprint",
"title": "Swap footprints",
"description": "Replace footprints in place with another footprint from a library in the project's fp-lib-table (library:name): the reference, value, position, rotation (or rot_deg), side, lock and schematic link stay, and nets move pad by pad. pad_map maps a NEW pad number to the OLD pad whose net it takes, for packages numbered differently. The schematic symbols' Footprint fields are updated too. Reports new pads left without a net and old nets left behind.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"swaps"
],
"properties": {
"swaps": {
"type": "array",
"items": {
"type": "object",
"required": [
"refs",
"footprint"
],
"properties": {
"refs": {
"type": "array",
"items": {
"type": "string"
}
},
"pad_map": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"rot_deg": {
"type": "number"
},
"footprint": {
"type": "string",
"pattern": "^[^:]+:.+$"
}
}
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Refill every copper zone with KiCad's zone filler.
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "fill_zones",
"title": "Fill zones",
"description": "Refill every copper zone with KiCad's zone filler.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Silkscreen stamps for release, both off unless asked for: a small spec badge ("routed with Koppar", optionally the title, revision and part count) in the largest free patch of the front or back silk, and JLCPCB's JLCJLCJLCJLC placeholder on the back silk so their order number is printed there, not on the front. Free means clear of pads, mask openings, other silk, courtyards, holes and the edge. KiCad's DRC is run before and after and a stamp that changes any count is taken off again.
| Parameter | Type | Description |
|---|---|---|
| badge | boolean | Place the spec badge (default false). |
| parts | integer | Part count for the badge; counted from the board when unset. |
| title | string | Board title for the badge's second line. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| revision | string | Revision for the badge ("rev B"). |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| badge_side | string | Silk side for the badge; the larger free patch when unset. |
| jlc_order_number | boolean | Place JLCJLCJLCJLC on the back silk (default false). |
Tie neighbouring same-net SMD pads of the plane nets (GND, the rails with a pour) together on their own layer with short tracks, so a group shares one via to the plane instead of one via per pad, as a designer does. A tie is placed only where it misses every other net's pad, its tracks and vias, and the board edge. Before routing: route afterwards with preserve_existing (the default). After routing and prune_vias: run prune_vias on those nets again.
| Parameter | Type | Description |
|---|---|---|
| nets | array | Nets to tie (default: every net that has a pour). |
| layers | array | Copper layers to tie on (default F.Cu and B.Cu). |
| max_mm | number | Longest tie (default 2.5). |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| width_mm | number | Tie track width (default: the board's current track width). |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| avoid_copper | boolean | Treat other nets' tracks and vias as obstacles (default true). |
{
"name": "tie_rail_pads",
"title": "Tie plane-net pads together",
"description": "Tie neighbouring same-net SMD pads of the plane nets (GND, the rails with a pour) together on their own layer with short tracks, so a group shares one via to the plane instead of one via per pad, as a designer does. A tie is placed only where it misses every other net's pad, its tracks and vias, and the board edge. Before routing: route afterwards with preserve_existing (the default). After routing and prune_vias: run prune_vias on those nets again.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Nets to tie (default: every net that has a pour)."
},
"layers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Copper layers to tie on (default F.Cu and B.Cu)."
},
"max_mm": {
"type": "number",
"maximum": 10,
"minimum": 0.3,
"description": "Longest tie (default 2.5)."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"width_mm": {
"type": "number",
"maximum": 2,
"minimum": 0.05,
"description": "Tie track width (default: the board's current track width)."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"avoid_copper": {
"type": "boolean",
"description": "Treat other nets' tracks and vias as obstacles (default true)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Grow the tracks (and optionally vias) of the named nets in place, each as wide as its clearance to every other net's copper, holes and the board edge allows, up to the net's target width. Nothing moves and no via is added, so the score does not change. Routers neck power down to the signal width wherever the class width did not fit their grid; most necks have room around them. List the heaviest current first: earlier nets take the room. Pours are refilled after each net and a widening that leaves the board less connected is backed out. The result names what still holds each remaining neck (a neighbour to move or reroute).
| Parameter | Type | Description |
|---|---|---|
| nets * | object | Net -> target track width in mm. |
| vias | object | Net -> [diameter_mm, drill_mm] sizes to try, largest first; a via only ever grows. |
| guard | boolean | Refill pours and back out widenings that disconnect anything (default true). |
| necks | integer | How many remaining necks to report per net (default 12). |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "widen_nets",
"title": "Widen power nets in place",
"description": "Grow the tracks (and optionally vias) of the named nets in place, each as wide as its clearance to every other net's copper, holes and the board edge allows, up to the net's target width. Nothing moves and no via is added, so the score does not change. Routers neck power down to the signal width wherever the class width did not fit their grid; most necks have room around them. List the heaviest current first: earlier nets take the room. Pours are refilled after each net and a widening that leaves the board less connected is backed out. The result names what still holds each remaining neck (a neighbour to move or reroute).",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"nets"
],
"properties": {
"nets": {
"type": "object",
"description": "Net -> target track width in mm.",
"additionalProperties": {
"type": "number",
"maximum": 10,
"exclusiveMinimum": 0
}
},
"vias": {
"type": "object",
"description": "Net -> [diameter_mm, drill_mm] sizes to try, largest first; a via only ever grows.",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": false,
"prefixItems": [
{
"type": "number",
"maximum": 5,
"exclusiveMinimum": 0
},
{
"type": "number",
"maximum": 5,
"exclusiveMinimum": 0
}
]
}
}
},
"guard": {
"type": "boolean",
"description": "Refill pours and back out widenings that disconnect anything (default true)."
},
"necks": {
"type": "integer",
"maximum": 200,
"minimum": 0,
"description": "How many remaining necks to report per net (default 12)."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Close what the router left open the way a designer does: for each open net the diagnosis names the copper boxing it in; that copper is ripped (never a poured net), the open nets are routed FIRST into the space, then the ripped nets go back around them; up to `rounds` rounds, each kept only if KiCad counts fewer unconnected items. Use it after route_board leaves a handful of nets open (route_board's default pipeline already runs three rounds; this adds more, or follows a single route); repair_board never moves the blockers.
| Parameter | Type | Description |
|---|---|---|
| rounds | integer | Rip-and-reroute rounds (default 3). |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| reach_mm | number | Radius cleared of tracks and vias around a pad with no way out (default 1.5). |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| class_vias | boolean | Route with the Default class's via instead of the board's smallest legal one. |
| ml_options | object | |
| vias_in_pads | string | 'allow': vias may sit in pin pads (the board must be ordered with filled and capped vias). |
| time_budget_s | integer | Router budget per routing call (default 120). |
A filled pour cut into islands by routing: one through-via per island that KiCad finds cut off from its net, placed well inside the island and inside the net's main copper on another layer, clear of every other net between. Reports the islands it found no site for. Run run_drc afterwards.
| Parameter | Type | Description |
|---|---|---|
| nets | array | Net names; * and ? wildcards, e.g. ["USB_D*", "+3V3"]. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| max_vias | integer | |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "bridge_islands",
"title": "Join pour islands",
"description": "A filled pour cut into islands by routing: one through-via per island that KiCad finds cut off from its net, placed well inside the island and inside the net's main copper on another layer, clear of every other net between. Reports the islands it found no site for. Run run_drc afterwards.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Net names; * and ? wildcards, e.g. [\"USB_D*\", \"+3V3\"]."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"max_vias": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}After routing: every run redrawn as the fewest 0/45/90-degree segments that clear, and every track narrower than its net's netclass width widened where it fits (slid sideways, bumped around a lone obstacle, or necked only over the stretch that needs it; a via or thin track of another net moved aside when that is all that is in the way). No via is added or removed; a change that would split a pour is undone, and the board is kept only if KiCad counts nothing worse.
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "tidy_copper",
"title": "Tidy the copper",
"description": "After routing: every run redrawn as the fewest 0/45/90-degree segments that clear, and every track narrower than its net's netclass width widened where it fits (slid sideways, bumped around a lone obstacle, or necked only over the stretch that needs it; a via or thin track of another net moved aside when that is all that is in the way). No via is added or removed; a change that would split a pour is undone, and the board is kept only if KiCad counts nothing worse.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}After route_board and prune_vias: rip one net at a time, most vias first, route it alone around everything else at a high via price, and keep the new copper only when KiCad counts fewer vias with no new open item or DRC error (a reroute that cuts a pour into islands first gets one via per island, bridge_islands). Run run_drc and get_score afterwards; a second pass sometimes finds more.
| Parameter | Type | Description |
|---|---|---|
| nets | array | Net names; * and ? wildcards, e.g. ["USB_D*", "+3V3"]. |
| pairs | boolean | Rip and reroute a differential pair (_H/_L, _P/_N, +/-) together (default true: a leg rerouted alone comes back at its own length; a step that degrades a pair is never kept). |
| pours | boolean | Also polish the poured nets (default false): the pour and its stitch vias stay, the net is routed as a track tree on top, then its redundant stitch vias are pruned. A lottery: the tree that did this by accident (PCBGolf +3V3 53 -> 32) did not repeat in 2 deliberate tries. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| workers | integer | prune workers for a poured net (default 4). |
| max_nets | integer | Nets to try, most vias first (default 40). |
| min_vias | integer | Only nets with at least this many vias (default 2). |
| via_cost | number |
After route_board: re-route the weakly coupled differential pairs one at a time, least coupled first. Both legs are ripped and routed alone around everything else as a pair; the new copper stays only when the pair's coupled share rises by min_gain_pct, its skew stays within max_skew_mm, KiCad counts no new open item or DRC error, and the board gains at most max_extra_vias vias. Pairs routed with the whole board lose their lanes; alone they couple. Run check_net_rules before and after.
| Parameter | Type | Description |
|---|---|---|
| pairs | array | Only pairs with a leg matching these (default every pair under target_pct). |
| tries | integer | Router seeds per pair; the best acceptable one is kept (default 2). |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| ml_options | object | |
| target_pct | number | Pairs coupled below this are tried (default 70). |
| max_skew_mm | number | Largest length mismatch kept (default: the pair's current skew, at least 1 mm). |
| min_gain_pct | number | Coupling points a reroute must gain to be kept (default 10). |
For every net still open (or the nets named): each pad with the escape corridors free on its own layer, whether a via can be dropped beside it at all, and what blocks it (which part's pads, which net's tracks or vias, the board edge). A pad with no free corridor and no via site is CRAMPED — no router can reach it; the advice names the parts to move. Otherwise the advice says which nets to rip and route first. Use it instead of repeating repair_board on a net that keeps failing.
| Parameter | Type | Description |
|---|---|---|
| nets | array | Only these nets (default: every open net). |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| max_nets | integer | |
| reach_mm | number | How far a corridor must stay free (default 1.5). |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "diagnose_open_nets",
"title": "Why nets do not route",
"description": "For every net still open (or the nets named): each pad with the escape corridors free on its own layer, whether a via can be dropped beside it at all, and what blocks it (which part's pads, which net's tracks or vias, the board edge). A pad with no free corridor and no via site is CRAMPED — no router can reach it; the advice names the parts to move. Otherwise the advice says which nets to rip and route first. Use it instead of repeating repair_board on a net that keeps failing.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only these nets (default: every open net)."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"max_nets": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"reach_mm": {
"type": "number",
"maximum": 5,
"minimum": 0.5,
"description": "How far a corridor must stay free (default 1.5)."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}KiCad's DRC on the board as it is now, with schematic parity when the project has its schematic: error and warning counts by type, shorts, unconnected items, parity items, and the first violations with their items and positions (types filters, max_violations caps; default 40). Also mount_fit: parts reaching through the board (mid-mount jacks, USB-C) checked against their cutouts from their 3D models, with any body area over board material or within the fab's 0.2 mm milling tolerance of the cut.
| Parameter | Type | Description |
|---|---|---|
| types | array | |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| max_violations | integer |
{
"name": "run_drc",
"title": "Design-rule check",
"description": "KiCad's DRC on the board as it is now, with schematic parity when the project has its schematic: error and warning counts by type, shorts, unconnected items, parity items, and the first violations with their items and positions (types filters, max_violations caps; default 40). Also mount_fit: parts reaching through the board (mid-mount jacks, USB-C) checked against their cutouts from their 3D models, with any body area over board material or within the fab's 0.2 mm milling tolerance of the cut.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"max_violations": {
"type": "integer",
"maximum": 500,
"minimum": 1
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}An exact 2D picture of the board as an engineer reads it: copper per layer (the facing layer full strength, the others faded), pads, vias, pours, outline, courtyards and refs. side top|bottom, region [x, y, w, h] mm for a crop, drc_markers to circle every DRC violation, ratsnest to draw the open connections, highlight_nets/highlight_refs in magenta. The pixel-per-mm scale and region come back so a follow-up crop is exact. Download workspace.render.png.
| Parameter | Type | Description |
|---|---|---|
| refs | boolean | |
| side | string | one of ["top","bottom"] |
| layers | array | |
| region | array | [x_mm, y_mm, w_mm, h_mm] crop; default the whole board. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| markers | array | |
| ratsnest | boolean | |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| max_width | integer | |
| px_per_mm | number |
Export the assembled board as STEP (3D models, DNP parts left out). Download it as workspace.step; workspace.zip includes it.
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "export_step",
"title": "Export STEP",
"description": "Export the assembled board as STEP (3D models, DNP parts left out). Download it as workspace.step; workspace.zip includes it.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}The snapshots of this board, newest first. Revision N is the board as it was before change N (revision 0 is the project as imported); restore_board_revision N goes back to it.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "list_board_revisions",
"title": "Board revisions",
"description": "The snapshots of this board, newest first. Revision N is the board as it was before change N (revision 0 is the project as imported); restore_board_revision N goes back to it.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Put the board and its rules back as they were in a revision from list_board_revisions. The current board is saved as a new revision first, so the restore itself can be undone.
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| revision * | integer | |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "restore_board_revision",
"title": "Restore a revision",
"description": "Put the board and its rules back as they were in a revision from list_board_revisions. The current board is saved as a new revision first, so the restore itself can be undone.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"revision"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}The design's latest board job: its status and, once it ends, its result or error. wait_s holds the call until it ends. A job is allowed the time its budget asks for (time_budget_s, total_budget_s, rounds), and survives a server restart (the op starts over from its snapshot; route_board's pipeline goes on from its last finished stage).
| Parameter | Type | Description |
|---|---|---|
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "get_board_job",
"title": "Board job",
"description": "The design's latest board job: its status and, once it ends, its result or error. wait_s holds the call until it ends. A job is allowed the time its budget asks for (time_budget_s, total_budget_s, rounds), and survives a server restart (the op starts over from its snapshot; route_board's pipeline goes on from its last finished stage).",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Stop the design's running or queued board job (the KiCad plugin's Stop button). The board goes back to how it was before the job (its snapshot); a job already ended is left as it is.
| Parameter | Type | Description |
|---|---|---|
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
{
"name": "stop_board_job",
"title": "Stop the board job",
"description": "Stop the design's running or queued board job (the KiCad plugin's Stop button). The board goes back to how it was before the job (its snapshot); a job already ended is left as it is.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}Koppar turns a circuit description into a manufacturable PCB. Through these tools YOU do the thinking (part research, writing the SKiDL schematic, reviewing it, planning the board) and Koppar does the deterministic work: KiCad library lookups, compiling and checking the circuit, place and route, the design-rule check, live BOM pricing and fab files. No model runs on the Koppar side. Workflow: 1. create_design with the user's brief. Give the user the web_url: the design, schematic, 3D board and BOM appear there as you work. 2. Research. Read get_workflow_guide(stage="research"). Verify every part with search_kicad_symbol, get_kicad_symbol and search_kicad_footprint, passing design_id so parts you register (create_custom_symbol, database parts) belong to the design. A package KiCad does not have: give create_custom_symbol its .kicad_mod as footprint_mod (or add_custom_footprint first, then footprint="custom:<name>") and the part uses that footprint on the board and in the project, never a placeholder. Write the dossier and save it with save_dossier; resolve every part it reports unresolved. 3. Schematic. Read get_workflow_guide(stage="synthesis"). Write the SKiDL script and send it with submit_circuit. Fix every blocking finding and resubmit (edit_circuit patches circuit.py in place) until accepted is true. Warnings do not block. 4. Review, for designs with 4 or more active ICs. get_review_packet, review it as its instructions say, and fix the blocking issues with edit_circuit. 5. Board. get_board_context, write the plan JSON as get_workflow_guide(stage="board") describes, start_board with it, then get_board_status with wait_s until the run ends. A board that fails (open nets, DRC errors) gets a changed plan (larger board, 4 copper layers, parts moved) and another start_board. Fab files are released only for a board with zero serious DRC errors and nothing unconnected. set_design_rules changes a built board's rules (clearance, widths, net classes) in place: the copper stays, DRC re-judges it, and the next start_board routes to them. 6. Parts and fab. get_bom (choose_bom_part changes an offer; consolidate_bom_basic moves passives onto JLCPCB basic-library parts, which carry no loading fee), get_fab_status, get_order_price (list_order_providers says which manufacturers can quote today; ask the one that can), and get_downloads for the KiCad project, Gerbers and the assembly order bundle. upload_board puts a board you routed or edited yourself onto the design (same parts and nets as the schematic; send the .kicad_pro and .kicad_dru with it so KiCad judges it under its own rules; the chat is told). send_order_to_provider uploads the design to a manufacturer: only when the user asks for it. To re-place or re-route a board the pipeline built: call the board tools on the design itself (ripup_routing, route_board, repair_board, couple_pairs, fill_zones, run_drc...). They run in a workspace the design carries, with its revisions (restore_board_revision undoes); the job runs for its budget and survives a server restart. When a job leaves the board with no more open connections and no more DRC errors than the design's board, the design takes it (DRC and the release judged again, as upload_board does), and a released design keeps a released board. To work on a copy instead, import_kicad_project with from_design_id, then upload_board on the design with workspace_id. delete_design moves a design or workspace to the trash (restorable for 7 days); restore_design brings it back. route_board keeps the tracks and vias already on a board by default. Its answer starts with outcome: what was kept, and whether the widths were met. If a class width matters, read check_net_rules: DRC does not check widths. Sending the same request again gives the same kind of result; change the board, the rules or the budget. To change the circuit of a board that is already routed (a KiCad project imported as a workspace, say): update_board_from_netlist with the new
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| A 'Library:Footprint' from search_kicad_footprint. Required for 3+ pins unless footprint_mod is given. |
| reference | string | Reference prefix, e.g. 'U'. |
| description | string |
| footprint_mod | string | Your own footprint: the full text of a .kicad_mod file, starting with '(footprint'. Its pad numbers must match the pin numbers. |
{
"name": "create_custom_symbol",
"title": "Register a custom symbol",
"description": "Register a connectable schematic symbol for a part that is NOT in KiCad's libraries (search_kicad_symbol returned nothing). Use this for specialty ICs — LED-matrix drivers, niche sensors, etc. — INSTEAD of telling the synthesizer to model the part with discrete passives (which leaves every pin dangling and breaks the board). Provide the full datasheet pinout. The part then becomes available to the synthesizer as Part('custom', '<name>') with the exact pin names you supply here, and is added to the Verified parts table. A part with three or more pins needs footprint= naming a real, in-library footprint for its package (search_kicad_footprint with the family and pin count, e.g. 'LGA-14'); the call is rejected without one, since a generated grid of pads cannot be assembled. List every pad of the footprint, NC pins included. When the package is not in KiCad's libraries, bring your own footprint instead: footprint_mod takes the whole .kicad_mod file as text (KiCad 6+, up to 1 MB; the CLI reads it with `koppar custom-symbol --footprint-file`). It is checked as a KiCad footprint, every pad must have a pin with that pad's number (and every pin a pad), and it is stored as 'custom:<name>': the symbol uses it, and it goes on the board, into project.zip and into the fp-lib-table. footprint is then not needed. The name is used for file names: letters, digits and _ . + - (anything else becomes _). The symbol belongs to design_id.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"name",
"pins"
],
"properties": {
"name": {
"type": "string",
"description": "Part number, used as the symbol name (letters, digits, _ . + -)."
},
"pins": {
"type": "array",
"items": {
"type": "object",
"required": [
"number",
"name",
"type"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "input | output | bidirectional | power_in | power_out | passive | open_collector | tri_state | no_connect | unspecified"
},
"number": {
"type": "string"
}
}
},
"description": "Every pin from the datasheet."
},
"datasheet": {
"type": "string"
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"footprint": {
"type": "string",
"description": "A 'Library:Footprint' from search_kicad_footprint. Required for 3+ pins unless footprint_mod is given."
},
"reference": {
"type": "string",
"description": "Reference prefix, e.g. 'U'."
},
"description": {
"type": "string"
},
"footprint_mod": {
"type": "string",
"description": "Your own footprint: the full text of a .kicad_mod file, starting with '(footprint'. Its pad numbers must match the pin numbers."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}{
"name": "upload_board",
"title": "Upload a board",
"description": "Replace the design's board with a .kicad_pcb you routed or edited yourself (the file, base64). The board must carry the design's circuit: every schematic part by reference, every pad on the net the netlist gives it; a footprint swap is allowed and recorded. Anything else is refused with the list of differences and nothing changes. The previous board is kept as circuit.before-upload.kicad_pcb. KiCad DRC judges the new board and releases or withholds the Gerbers, and the session chat gets a note of the upload. Not for a board workspace (import_kicad_project): its board tools edit the board in place.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"note": {
"type": "string",
"description": "What was done to the board, for the session chat."
},
"design_id": {
"type": "string",
"description": "The design id returned by create_design or list_designs."
},
"board_base64": {
"type": "string",
"description": "The .kicad_pcb file, base64 (or give workspace_id)."
},
"rules_base64": {
"type": "string",
"description": "The .kicad_dru beside the board, base64."
},
"workspace_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,80}$",
"description": "A board workspace of yours (import_kicad_project, e.g. one made from this design with from_design_id): its board, project rules and .kicad_dru are taken from there, no download and upload."
},
"project_base64": {
"type": "string",
"description": "The .kicad_pro beside the board, base64: its design rules and net classes judge the board (without it the design keeps its own)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}| The zipped project folder, base64. |
| new_project | boolean | Start a new project even when one with this title exists. |
| from_design_id | string | A design of yours with a board (start_board or upload_board): its KiCad project becomes the workspace. Instead of zip_base64. |
{
"name": "import_kicad_project",
"title": "Import a KiCad project",
"description": "Bring an existing KiCad project in as a board workspace: the project folder as a ZIP (the .kicad_pcb, .kicad_pro, schematics, footprint and 3D-model folders), base64-encoded, up to about 18 MB zipped. An Altium Designer project (the .PcbDoc at the top of the ZIP) is converted with KiCad: the board, and its clearance, width, via and differential-pair rules as net classes; the reply lists the rules not carried (rooms, layers, lengths). The CLI does this with `koppar import <folder>`. Or from_design_id: the KiCad project of a design the pipeline built (its board, rules, schematics and custom footprints) opened as a workspace, to change the design rules, place and route it with the board tools and put the result back with upload_board (workspace_id). Returns the design_id the board tools take and a first get_board_info. A new revision of a board you already imported (changed in KiCad) is imported again with the session_id the first import returned: it opens as a new design in that same project, beside the revisions before it, so one board stays one project in the user's list. Not for changes the board tools can make on the design you have: work on that design_id.",
"inputSchema": {
"type": "object",
"properties": {
"brief": {
"type": "string",
"description": "A note for the design record. No tool reads it: what to keep, widths and layers go in the options of set_design_rules and route_board."
},
"title": {
"type": "string"
},
"board_file": {
"type": "string",
"description": "Which .kicad_pcb (or Altium .PcbDoc) at the top of the project, when there are several."
},
"session_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,80}$",
"description": "The project (web session) a new revision of this board goes into: the session_id the first import returned. Without it, an import whose title matches a project you opened before, or whose board file (the .kicad_pcb name) one of your imports had, joins that project, so revisions of one board stay together in the user's list."
},
"zip_base64": {
"type": "string",
"description": "The zipped project folder, base64."
},
"new_project": {
"type": "boolean",
"description": "Start a new project even when one with this title exists."
},
"from_design_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,80}$",
"description": "A design of yours with a board (start_board or upload_board): its KiCad project becomes the workspace. Instead of zip_base64."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}| string |
| "anneal": refine the placement by simulated annealing from this seed (wirelength-driven, same edge/fixed/keepouts, holes held) — the ML placer's structure with the annealer's tightness. |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| grid_mm | number | Placement grid for the refine step (0.254 = 10 mil); default off. |
| keepouts | array |
| bottom_ok | array | Refine: footprint-id substrings allowed on the back instead of bottom_any. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| flip_cost | number | Annealing price per bottom-side pad whose net has top pins (default 3). |
| two_sided | boolean | Small two-pad passives go to the back side. |
| bottom_any | boolean | Refine: any SMD-only part may go to the back, priced by flip_cost (default with two_sided); LEDs, switches, displays and test points stay on top. |
| ic_halo_mm | number | Refine: room kept around ICs with 48+ pads and fine-pitch ICs (default 1.5; other 16+ pad ICs get two thirds). |
| iterations | integer | Annealing iterations for refine (default 600000). |
| split_cost | number | Refine: price (mm of wirelength) of an SMD net with pads on both sides, i.e. a via. |
| hole_room_mm | number | Refine: room kept around mounting holes, both sides (default 1). |
| bottom_exclude | string | Refine: regex of refs or footprint ids that stay on top. |
| overlap_weight | number | Overlap price per mm2 at the end of the anneal (default 400; 4000 halves what a dense draw leaves). |
| connector_room_mm | number | Refine: room kept on the board side of every edge connector (default 2.5). |
| connector_flank_mm | number | Refine: room kept on the flanks of every edge connector (default 1.0); sets the pitch of connectors sharing an edge. |
| bottom_max_height_mm | number | Refine: tallest part allowed on the back (3D-model height, default 1.0). |
{
"name": "auto_place",
"title": "Auto-place footprints",
"description": "Pack footprints inside the board outline with Koppar's heuristic placer (ratsnest-driven, courtyard-legal). By default every unlocked footprint moves and locked ones stay; refs names exactly which move (all others stay). Constraints: fixed (exact origin positions and rotation, never moved; locked footprints likewise), side, keepouts (rectangles), groups, near (ref within maxMm of an anchor), edge (ref to \"left|right|top|bottom\", optionally \"@mm\" along that edge from the outline's top-left corner). Nothing is left past the outline except a USB/barrel/jack opening's 1.2 mm lip; placement_notes lists every part that could not be placed where asked. Coarse by design: refine the result with place_footprints.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"edge": {
"type": "object",
"description": "Ref to the edge it sits on, optionally @mm: where along that edge its centre goes, from the outline's top-left corner (x on top/bottom, y on left/right).",
"additionalProperties": {
"type": "string",
"pattern": "^(left|right|top|bottom)(@\\d+(\\.\\d+)?)?$"
}
},
"near": {
"type": "array",
"items": {
"type": "object",
"required": [
"ref",
"anchor"
],
"properties": {
"ref": {
"type": "string"
},
"maxMm": {
"type": "number",
"exclusiveMinimum": 0
},
"anchor": {
"type": "string"
}
}
}
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"description": "The footprints that may move."
},
"side": {
"type": "object",
"additionalProperties": {
"enum": [
"F",
"B"
],
"type": "string"
}
},
"fixed": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"x_mm",
"y_mm"
],
"properties": {
"x_mm": {
"type": "number"
},
"y_mm": {
"type": "number"
},
"rot_deg": {
"type": "number"
}
}
}
},
"shove": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "Legaliser: a part may take a spot held only by movable parts under this fraction of its area (default 0.3, 0 off)."
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"refs"
],
"properties": {
"near": {
"type": "string"
},
"refs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"placer": {
"enum": [
"packer",
"ml"
],
"type": "string",
"description": "\"ml\": the learned placer service (dense, two-sided when two_sided, honours keepouts); the packer when it is unavailable."
},
"refine": {
"enum": [
"anneal"
],
"type": "string",
"description": "\"anneal\": refine the placement by simulated annealing from this seed (wirelength-driven, same edge/fixed/keepouts, holes held) — the ML placer's structure with the annealer's tightness."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"grid_mm": {
"type": "number",
"maximum": 2,
"minimum": 0,
"description": "Placement grid for the refine step (0.254 = 10 mil); default off."
},
"keepouts": {
"type": "array",
"items": {
"type": "object",
"required": [
"x_mm",
"y_mm",
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"w_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"x_mm": {
"type": "number",
"description": "Left edge, board coordinates (KiCad mm, y grows downward)."
},
"y_mm": {
"type": "number",
"description": "Top edge."
},
"reason": {
"type": "string"
}
}
}
},
"bottom_ok": {
"type": "array",
"items": {
"type": "string"
},
"description": "Refine: footprint-id substrings allowed on the back instead of bottom_any."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"flip_cost": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Annealing price per bottom-side pad whose net has top pins (default 3)."
},
"two_sided": {
"type": "boolean",
"description": "Small two-pad passives go to the back side."
},
"bottom_any": {
"type": "boolean",
"description": "Refine: any SMD-only part may go to the back, priced by flip_cost (default with two_sided); LEDs, switches, displays and test points stay on top."
},
"ic_halo_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Refine: room kept around ICs with 48+ pads and fine-pitch ICs (default 1.5; other 16+ pad ICs get two thirds)."
},
"iterations": {
"type": "integer",
"maximum": 5000000,
"minimum": 1000,
"description": "Annealing iterations for refine (default 600000)."
},
"split_cost": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Refine: price (mm of wirelength) of an SMD net with pads on both sides, i.e. a via."
},
"hole_room_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Refine: room kept around mounting holes, both sides (default 1)."
},
"bottom_exclude": {
"type": "string",
"description": "Refine: regex of refs or footprint ids that stay on top."
},
"overlap_weight": {
"type": "number",
"maximum": 100000,
"minimum": 1,
"description": "Overlap price per mm2 at the end of the anneal (default 400; 4000 halves what a dense draw leaves)."
},
"connector_room_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Refine: room kept on the board side of every edge connector (default 2.5)."
},
"connector_flank_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Refine: room kept on the flanks of every edge connector (default 1.0); sets the pitch of connectors sharing an edge."
},
"bottom_max_height_mm": {
"type": "number",
"maximum": 20,
"minimum": 0,
"description": "Refine: tallest part allowed on the back (3D-model height, default 1.0)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}| seed | integer |
| fixed | object | Parts held at these origin positions; they are moved there on the board first. |
| shove | number | Legaliser: a part may take a spot held only by movable parts under this fraction of its area (default 0.3, 0 off). |
| gap_mm | number |
| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| grid_mm | number | Placement grid for free parts (0.254 = 10 mil, the designer habit); default off. |
| keepouts | array | Rectangles no part may cover, e.g. a bus corridor. |
| bottom_ok | array | Footprint-id substrings allowed on the bottom side (e.g. "0402"). |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| flip_cost | number |
| rotations | array |
| bottom_any | boolean | Any SMD-only part may go to the back (priced by flip_cost); LEDs, switches, displays and test points stay on top unless bottom_exclude says otherwise. |
| ic_halo_mm | number | Room kept around ICs with 48+ pads and fine-pitch ICs (default 1.5; other 16+ pad ICs get two thirds). |
| iterations | integer | Leave unset: 6000 per moving part (0.3-6 M) within a 150 s budget. Fewer only for a quick look. |
| net_weight | object |
| refit_from | object | Outline the current placement was drawn in; it is scaled affinely into the new outline before annealing (with t0 ~0.5: shrink a placement that closed). |
| split_cost | number | Price (mm of wirelength) of an SMD net with pads on both sides, i.e. a via. |
| from_scratch | boolean |
| hole_room_mm | number | Room kept around mounting holes on both sides for the screw head and standoff (default 1). |
| bottom_exclude | string | Regex of refs or footprint ids that stay on top regardless. |
| overlap_weight | number | Overlap price per mm2 at the end of the anneal (default 400; 4000 halves what a dense draw leaves). |
| edge_overhang_mm | object | Per edge ref, how far its body sits past the edge: default 0.5 for a USB/barrel/jack connector (at most its 1.2 mm lip), 0 (flush) for anything else, which may not overhang. |
| connector_room_mm | number | Room kept on the board side of every edge connector (default 2.5). |
| connector_flank_mm | number | Room kept on the flanks of every edge connector (default 1.0). |
| bottom_max_height_mm | number | Tallest part allowed on the back (3D-model height, default 1.0): the assembly box grows by the tallest back-side part. |
{
"name": "anneal_place",
"title": "Anneal a dense placement",
"description": "Dense placement by simulated annealing: wirelength inside the real outline (Edge.Cuts with its corners, notches and cutouts; a separate piece no held part stands on is left out) with courtyard gaps, edge connectors held on their edge, fixed and locked parts held, and, unless refs is given, the mounting holes, connectors and switches already on the board held too (held_mechanical). Kept clear: keepout rectangles (routing corridors) and the board's and held footprints' rule areas that forbid pads or footprints, on their own faces. A per-pad price for the bottom side (flip_cost, mm of wirelength; each bottom-side pad whose net has top-side pins costs a via). Starts from the current positions unless from_scratch. The result is legalised: no part on another, in a keep-out or off the board; a part with no legal spot that started off the board stays there (unplaced), and a result worse than the board had is not saved (the op fails, the board unchanged). Iterations scale with the parts moved within a 150 s budget: leave iterations unset.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"t0": {
"type": "number",
"maximum": 100,
"minimum": 0.01,
"description": "Start temperature (default 15). ~0.5 keeps the current placement and only tidies it (refine, or squeeze into a smaller outline)."
},
"edge": {
"type": "object",
"description": "Connector ref to the edge it sits on, optionally @mm: where along that edge its centre goes, from the outline's top-left corner (x on top/bottom, y on left/right) — the same meaning as in auto_place and a board plan. A fixed or locked ref keeps its pin.",
"additionalProperties": {
"type": "string",
"pattern": "^(left|right|top|bottom)(@\\d+(\\.\\d+)?)?$"
}
},
"halo": {
"type": "object",
"description": "Routing room per ref, mm (a number all round, or footprint-local [left, top, right, bottom]).",
"additionalProperties": {
"anyOf": [
{
"type": "number",
"maximum": 10,
"minimum": 0
},
{
"type": "array",
"items": false,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
}
]
}
},
"near": {
"type": "array",
"items": {
"type": "object",
"required": [
"ref",
"anchor"
],
"properties": {
"ref": {
"type": "string"
},
"maxMm": {
"type": "number",
"exclusiveMinimum": 0
},
"anchor": {
"type": "string"
}
}
},
"description": "Keep ref at its anchor (a decoupling capacitor at its IC, a crystal at its MCU): the board plan's near constraint, as a strong pull in the anneal."
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"description": "The footprints that may move (default: every unlocked one)."
},
"seed": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"fixed": {
"type": "object",
"description": "Parts held at these origin positions; they are moved there on the board first.",
"additionalProperties": {
"type": "object",
"required": [
"x_mm",
"y_mm"
],
"properties": {
"x_mm": {
"type": "number"
},
"y_mm": {
"type": "number"
},
"rot_deg": {
"type": "number"
}
}
}
},
"shove": {
"type": "number",
"maximum": 1,
"minimum": 0,
"description": "Legaliser: a part may take a spot held only by movable parts under this fraction of its area (default 0.3, 0 off)."
},
"gap_mm": {
"type": "number",
"maximum": 5,
"minimum": 0
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"grid_mm": {
"type": "number",
"maximum": 2,
"minimum": 0,
"description": "Placement grid for free parts (0.254 = 10 mil, the designer habit); default off."
},
"keepouts": {
"type": "array",
"items": {
"type": "object",
"required": [
"x_mm",
"y_mm",
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"w_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"x_mm": {
"type": "number",
"description": "Left edge, board coordinates (KiCad mm, y grows downward)."
},
"y_mm": {
"type": "number",
"description": "Top edge."
}
}
},
"description": "Rectangles no part may cover, e.g. a bus corridor."
},
"bottom_ok": {
"type": "array",
"items": {
"type": "string"
},
"description": "Footprint-id substrings allowed on the bottom side (e.g. \"0402\")."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"flip_cost": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"rotations": {
"type": "array",
"items": {
"type": "number"
}
},
"bottom_any": {
"type": "boolean",
"description": "Any SMD-only part may go to the back (priced by flip_cost); LEDs, switches, displays and test points stay on top unless bottom_exclude says otherwise."
},
"ic_halo_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Room kept around ICs with 48+ pads and fine-pitch ICs (default 1.5; other 16+ pad ICs get two thirds)."
},
"iterations": {
"type": "integer",
"maximum": 6000000,
"minimum": 1000,
"description": "Leave unset: 6000 per moving part (0.3-6 M) within a 150 s budget. Fewer only for a quick look."
},
"net_weight": {
"type": "object",
"additionalProperties": {
"type": "number",
"minimum": 0
}
},
"refit_from": {
"type": "object",
"required": [
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number"
},
"w_mm": {
"type": "number"
},
"x_mm": {
"type": "number"
},
"y_mm": {
"type": "number"
}
},
"description": "Outline the current placement was drawn in; it is scaled affinely into the new outline before annealing (with t0 ~0.5: shrink a placement that closed)."
},
"split_cost": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Price (mm of wirelength) of an SMD net with pads on both sides, i.e. a via."
},
"from_scratch": {
"type": "boolean"
},
"hole_room_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Room kept around mounting holes on both sides for the screw head and standoff (default 1)."
},
"bottom_exclude": {
"type": "string",
"description": "Regex of refs or footprint ids that stay on top regardless."
},
"overlap_weight": {
"type": "number",
"maximum": 100000,
"minimum": 1,
"description": "Overlap price per mm2 at the end of the anneal (default 400; 4000 halves what a dense draw leaves)."
},
"edge_overhang_mm": {
"type": "object",
"description": "Per edge ref, how far its body sits past the edge: default 0.5 for a USB/barrel/jack connector (at most its 1.2 mm lip), 0 (flush) for anything else, which may not overhang.",
"additionalProperties": {
"type": "number",
"maximum": 5,
"minimum": 0
}
},
"connector_room_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Room kept on the board side of every edge connector (default 2.5)."
},
"connector_flank_mm": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Room kept on the flanks of every edge connector (default 1.0)."
},
"bottom_max_height_mm": {
"type": "number",
"maximum": 20,
"minimum": 0,
"description": "Tallest part allowed on the back (3D-model height, default 1.0): the assembly box grows by the tallest back-side part."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}| The design id returned by import_kicad_project or list_designs. |
| net_classes | array |
| min_track_mm | number |
| copper_layers | any |
| hole_to_hole_mm | number |
| default_track_mm | number |
| min_clearance_mm | number |
| hole_clearance_mm | number |
| board_thickness_mm | number | Finished board thickness; the stackup is rebuilt to it. JLCPCB FR4: 0.4, 0.6, 0.8, 1.0, 1.2, 1.6, 2.0 mm. |
| min_via_annular_mm | number |
| min_via_diameter_mm | number |
| default_clearance_mm | number |
| default_via_drill_mm | number |
| min_through_drill_mm | number |
| default_via_diameter_mm | number |
| copper_edge_clearance_mm | number |
{
"name": "set_design_rules",
"title": "Set design rules",
"description": "Set the project design rules (.kicad_pro) and copper layer count. Works on a board workspace and on a generated design (create_design → start_board). On a generated design the rules go into circuit.kicad_pro/.kicad_dru in place (the previous ones are snapshotted under rules_revisions/), are kept by every later project write (project.zip, a new board run), the copper is not changed and KiCad DRC judges the board against them at once: the reply carries the DRC counts and whether the Gerbers are released; the next start_board routes to the default_* values. copper_layers, stackup and board_thickness_mm are workspace-only (a generated design changes them with a new board). preset \"jlcpcb\" applies JLCPCB's published minimums for the layer count and writes their per-feature limits (plated rings, pad hole spacing, hole-to-track) as KiCad custom rules (.kicad_dru) that run_drc checks; explicit values override the minimums. Board minimums (min_*), the Default net class (default_*), and named net classes with their net patterns. route_board routes with these rules and run_drc checks against them. Changing copper_layers rebuilds the stackup; tracks on removed layers are reported. copper_layers 1 is a single-sided board (hand etching): the KiCad file keeps F.Cu and B.Cu, and from then on the routers hold to one face (B.Cu as soon as a THT pad exists, else F.Cu) and place no via; copper on the other face is removed.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"preset": {
"enum": [
"jlcpcb"
],
"type": "string"
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"stackup": {
"enum": [
"JLC04161H-7628",
"JLC04161H-3313",
"KOPPAR-6L-1.6-3313",
"KOPPAR-8L-1.6-3313",
"KOPPAR-10L-1.6-3313"
],
"type": "string",
"description": "1.6 mm impedance stackups, written into the board: JLCPCB's 4-layer 7628 (0.21 mm prepreg, their default) or 3313 (0.1 mm prepreg: thinner pairs for the same impedance), and 6- / 8-layer 3313 builds (approximations of the fab's, from its 3313 outer prepreg and human 1.6 mm boards). Needed before a net class states diff_impedance_ohm."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"net_classes": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Net names; * and ? wildcards, e.g. [\"USB_D*\", \"+3V3\"]."
},
"track_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"clearance_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"via_drill_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"via_diameter_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"diff_pair_gap_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"diff_impedance_ohm": {
"type": "number",
"maximum": 200,
"minimum": 40,
"description": "Differential impedance (90 USB, 100 Ethernet/HDMI, 120 CAN): the pair width is derived from the gap and the stackup."
},
"diff_pair_width_mm": {
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"min_track_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"copper_layers": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 4
},
{
"type": "number",
"const": 6
},
{
"type": "number",
"const": 8
}
]
},
"hole_to_hole_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"default_track_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"min_clearance_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"hole_clearance_mm": {
"type": "number",
"minimum": 0
},
"board_thickness_mm": {
"type": "number",
"maximum": 3.2,
"minimum": 0.2,
"description": "Finished board thickness; the stackup is rebuilt to it. JLCPCB FR4: 0.4, 0.6, 0.8, 1.0, 1.2, 1.6, 2.0 mm."
},
"min_via_annular_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"min_via_diameter_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"default_clearance_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"default_via_drill_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"min_through_drill_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"default_via_diameter_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"copper_edge_clearance_mm": {
"type": "number",
"minimum": 0
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}| wait_s | integer | Seconds to wait (default 55); a job still running comes back "running" for get_board_job. |
| compact | boolean | true: the densest via the rules allow (0.4/0.2), which JLCPCB prices with a mandatory 4-wire Kelvin test (~$40 per order); false: never below the Kelvin-free 0.45/0.2. Unset: compact only on a board with an area-array package or vias in pads. |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| class_vias | boolean | Route with the Default class's via. Without it (and without via_diameter_mm) a route uses the board's smallest legal via where the class's is larger. |
| ml_options | object | Fields passed to the learned router service as they are (router "ml"): via_cost and via_cost_hi (prices in lattice cells; a move costs 1 and the served default via is 8, 12 while a net is on the quality ladder), ql_release (rejected rip trades before a net drops to via_cost, 0 never), endgame_releas… |
| pairs_first | boolean | Route the differential pairs (USB D+/D-, CAN H/L, X_P/X_N) alone first, then everything else around them: a port pad row only lets a pair out before the neighbours take its lane. |
| clearance_mm | number |
| via_drill_mm | number |
| vias_in_pads | string | 'forbid' (default): no via inside an SMD pad under 2 mm. 'allow': vias may sit in pin pads, for a board ordered with filled and capped vias (JLCPCB POFV); dense connector rows close that otherwise stay open. |
| seed_existing | boolean | ML router: the connected nets in scope are sent as their own routes (seed_copper) and the service reworks the finished board with its rip-up and via-economy passes; kept only when KiCad counts fewer vias. Scope nets to the routed signal nets (pour nets stay). |
| time_budget_s | integer | The full pipeline's wall-clock cap (default 1200), or a single route's budget (default 120, up to 900). |
| track_width_mm | number |
| via_diameter_mm | number |
| edge_clearance_mm | number |
| preserve_existing | boolean |
{
"name": "route_board",
"title": "Route the board",
"description": "Route under the project's rules and net classes. By default (no nets, no router, none of the single-route options below) it runs the full route pipeline Koppar benchmarks: the learned router on the whole board, repair rounds on what stays open, copper finishing (0/45/90 runs) and one repair round after it, inside one wall-clock cap: time_budget_s is that cap (default 1200, up to 1500), so the job runs up to about 20 minutes: follow it with get_board_job. The result gives the final unconnected items and DRC errors and a pipeline summary: the counts after the route and after each finish, whether the copper finishing was kept. preserve_existing unset keeps the copper of a board that has tracks or vias and routes a board without any from scratch; false routes every net again. pours, ml_options, pairs_first and class_vias shape the route and the repair rounds of that pipeline. nets, router, seed_existing or a rule override (clearance_mm, track_width_mm, via sizes, edge_clearance_mm: this run only, so not the pipeline, whose later stages hold the project rules) runs ONE route instead, with no copper finishing, for expert control (tidy_copper after it straightens the copper): nets limits it to those nets; preserve_existing (default true) keeps every track and via already on the board and routes only what is still open. pours: \"keep\" (the default on a board you brought) keeps the board's zones, and a zone of a net the route lays is that net's plane: each of its pads gets a via to it and the net is not routed as tracks (zones first, then route); \"engine\" drops them and lets the router plan its own planes. Rule overrides apply to this run only. The learned router takes its via discipline in ml_options. A single route takes time_budget_s (default 120, up to 900).",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Net names; * and ? wildcards, e.g. [\"USB_D*\", \"+3V3\"]."
},
"pours": {
"enum": [
"keep",
"engine"
],
"type": "string"
},
"router": {
"enum": [
"ml"
],
"type": "string",
"description": "Unset: the full pipeline (above) on the whole board, \"ml\" for nets. \"ml\": the learned router service alone, 1 to 8 layers; the time budget is its deadline. Nets outside the nets scope, and with preserve_existing the nets their copper already connects, keep that copper and everything else is routed around it (partial copper of a routed net is replaced)."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"compact": {
"type": "boolean",
"description": "true: the densest via the rules allow (0.4/0.2), which JLCPCB prices with a mandatory 4-wire Kelvin test (~$40 per order); false: never below the Kelvin-free 0.45/0.2. Unset: compact only on a board with an area-array package or vias in pads."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"class_vias": {
"type": "boolean",
"description": "Route with the Default class's via. Without it (and without via_diameter_mm) a route uses the board's smallest legal via where the class's is larger."
},
"ml_options": {
"type": "object",
"description": "Fields passed to the learned router service as they are (router \"ml\"): via_cost and via_cost_hi (prices in lattice cells; a move costs 1 and the served default via is 8, 12 while a net is on the quality ladder), ql_release (rejected rip trades before a net drops to via_cost, 0 never), endgame_release (false keeps failing nets at via_cost_hi), economy_via_mm (a via counts as this many mm in the economy pass, default 2), guide_via_w (per-cell via price from the model's via channel), plane_cost (signal copper on a poured layer, per cell), pair_w, guide_w, ripup, seed_offset, via_economy_victims (default 4; 8 trades harder), first_nets (globs routed before everything else: buses that span several connectors), draws (client-side: route this many seeded draws and keep the one that connects most then uses fewest vias; the tie-breaks alone move a 500-via board by about 8 vias), stitch_poured (false: no stitch via for a pad already on a layer poured with its net, GND pads on F/B), stitch_cluster_mm (join same-layer pads of a poured net within this reach by short traces and via once per cluster; 4 wins, 8 loses), stitch_cluster_nets (globs: which poured nets cluster), draw_open_penalty (client-side: vias an open net costs when draws are compared, default 0 = the most-connected draw always wins), layer_cost (per-cell price on named layers, {\"F.Cu\": 2}: the pour polish prices every layer but the plane's).",
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"additionalProperties": {
"type": "number"
}
}
]
}
},
"pairs_first": {
"type": "boolean",
"description": "Route the differential pairs (USB D+/D-, CAN H/L, X_P/X_N) alone first, then everything else around them: a port pad row only lets a pair out before the neighbours take its lane."
},
"clearance_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"via_drill_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"vias_in_pads": {
"enum": [
"forbid",
"allow"
],
"type": "string",
"description": "'forbid' (default): no via inside an SMD pad under 2 mm. 'allow': vias may sit in pin pads, for a board ordered with filled and capped vias (JLCPCB POFV); dense connector rows close that otherwise stay open."
},
"seed_existing": {
"type": "boolean",
"description": "ML router: the connected nets in scope are sent as their own routes (seed_copper) and the service reworks the finished board with its rip-up and via-economy passes; kept only when KiCad counts fewer vias. Scope nets to the routed signal nets (pour nets stay)."
},
"time_budget_s": {
"type": "integer",
"maximum": 1500,
"minimum": 10,
"description": "The full pipeline's wall-clock cap (default 1200), or a single route's budget (default 120, up to 900)."
},
"track_width_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"via_diameter_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"edge_clearance_mm": {
"type": "number",
"minimum": 0
},
"preserve_existing": {
"type": "boolean"
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}{
"name": "update_board_from_netlist",
"title": "Update the board from a changed netlist",
"description": "Bring a routed board to a changed circuit and keep every track that is still right: what KiCad calls Update PCB from Schematic, then the routing. New parts go on the board (place: a connector on an edge, the board grown when there is no room, the rest in free room near what they connect to; placements for exact poses), moved or re-netted pads lose only the branch of copper that led to them, copper a new part lands on goes, and only what is open is routed, with the rules read off the board. The answer says how many tracks and vias were kept, ripped and added, what is still open, and the errors that touch the change. A route that takes copper off the rip list is refused and the board stays.",
"inputSchema": {
"type": "object",
"required": [
"design_id",
"netlist"
],
"properties": {
"place": {
"type": "array",
"items": {
"type": "object",
"required": [
"ref",
"footprint"
],
"properties": {
"ref": {
"type": "string"
},
"edge": {
"enum": [
"top",
"bottom",
"left",
"right"
],
"type": "string"
},
"near": {
"type": "string"
},
"nets": {
"type": "array",
"items": {
"type": "string"
}
},
"pins": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"footprint": {
"type": "string"
}
}
},
"description": "New parts without a pose yet, and where they should go."
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "Parts that leave the board. Parts in no netlist (a logo, a fiducial) stay otherwise."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"netlist": {
"type": "string",
"description": "The new KiCad netlist, as text."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"placements": {
"type": "object",
"description": "Reference -> exact pose, for new parts and parts that move.",
"additionalProperties": {
"type": "object",
"required": [
"x_mm",
"y_mm"
],
"properties": {
"side": {
"enum": [
"front",
"back"
],
"type": "string"
},
"x_mm": {
"type": "number"
},
"y_mm": {
"type": "number"
},
"rot_deg": {
"type": "number"
}
}
}
},
"time_budget_s": {
"type": "integer",
"maximum": 900,
"minimum": 10
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}{
"name": "ripup_routing",
"title": "Rip up routing",
"description": "Delete tracks and vias: of the given nets, on the given layers (vias are not layer-filtered), with an end inside region, or all. Filters combine. tracks/vias choose which kinds (both by default); zones also deletes the copper zones (pours) the same filters match (a zone inside region), never keepout areas. Locked items stay unless include_locked.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"all": {
"type": "boolean"
},
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Net names; * and ? wildcards, e.g. [\"USB_D*\", \"+3V3\"]."
},
"vias": {
"type": "boolean"
},
"zones": {
"type": "boolean"
},
"layers": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(F|B|In\\d{1,2})\\.Cu$"
}
},
"region": {
"type": "object",
"required": [
"x_mm",
"y_mm",
"w_mm",
"h_mm"
],
"properties": {
"h_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"w_mm": {
"type": "number",
"exclusiveMinimum": 0
},
"x_mm": {
"type": "number",
"description": "Left edge, board coordinates (KiCad mm, y grows downward)."
},
"y_mm": {
"type": "number",
"description": "Top edge."
}
}
},
"tracks": {
"type": "boolean"
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"include_locked": {
"type": "boolean"
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}{
"name": "cleanup_board",
"title": "Clean up tracks and vias",
"description": "Sweep the routing: zero-length and duplicate tracks, stub tracks (a free end, and everything the track touches stays joined without it), and vias that meet their net on fewer than two layers. Contact is copper overlap, as KiCad judges it. Refills the zones first so pours count as connections. Locked items stay. The board is put back if the unconnected count or the DRC errors rise. A track running on past its last junction is cut back to it (trim_overhangs). list_removed names every item that went.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"refill": {
"type": "boolean"
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"list_removed": {
"type": "boolean"
},
"trim_overhangs": {
"type": "boolean"
},
"dangling_tracks": {
"type": "boolean"
},
"duplicate_tracks": {
"type": "boolean"
},
"unconnected_vias": {
"type": "boolean"
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}{
"name": "stamp_silkscreen",
"title": "Stamp silkscreen",
"description": "Silkscreen stamps for release, both off unless asked for: a small spec badge (\"routed with Koppar\", optionally the title, revision and part count) in the largest free patch of the front or back silk, and JLCPCB's JLCJLCJLCJLC placeholder on the back silk so their order number is printed there, not on the front. Free means clear of pads, mask openings, other silk, courtyards, holes and the edge. KiCad's DRC is run before and after and a stamp that changes any count is taken off again.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"badge": {
"type": "boolean",
"description": "Place the spec badge (default false)."
},
"parts": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Part count for the badge; counted from the board when unset."
},
"title": {
"type": "string",
"description": "Board title for the badge's second line."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"revision": {
"type": "string",
"description": "Revision for the badge (\"rev B\")."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"badge_side": {
"enum": [
"front",
"back"
],
"type": "string",
"description": "Silk side for the badge; the larger free patch when unset."
},
"jlc_order_number": {
"type": "boolean",
"description": "Place JLCJLCJLCJLC on the back silk (default false)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}{
"name": "finish_board",
"title": "Finish the open nets",
"description": "Close what the router left open the way a designer does: for each open net the diagnosis names the copper boxing it in; that copper is ripped (never a poured net), the open nets are routed FIRST into the space, then the ripped nets go back around them; up to `rounds` rounds, each kept only if KiCad counts fewer unconnected items. Use it after route_board leaves a handful of nets open (route_board's default pipeline already runs three rounds; this adds more, or follows a single route); repair_board never moves the blockers.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"rounds": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Rip-and-reroute rounds (default 3)."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"reach_mm": {
"type": "number",
"maximum": 5,
"minimum": 0.5,
"description": "Radius cleared of tracks and vias around a pad with no way out (default 1.5)."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"class_vias": {
"type": "boolean",
"description": "Route with the Default class's via instead of the board's smallest legal one."
},
"ml_options": {
"type": "object",
"additionalProperties": {}
},
"vias_in_pads": {
"enum": [
"forbid",
"allow"
],
"type": "string",
"description": "'allow': vias may sit in pin pads (the board must be ordered with filled and capped vias)."
},
"time_budget_s": {
"type": "integer",
"maximum": 1800,
"minimum": 10,
"description": "Router budget per routing call (default 120)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}
}| Via price for the lone reroute (default 60). |
| design_id * | string | The design id returned by import_kicad_project or list_designs. |
| ml_options | object |
| time_budget_s | integer | Router budget per net (default 120). |
| bridge_islands | boolean |
| total_budget_s | integer | Stop starting nets after this (default 1800). |
{
"name": "polish_vias",
"title": "Fewer vias, net by net",
"description": "After route_board and prune_vias: rip one net at a time, most vias first, route it alone around everything else at a high via price, and keep the new copper only when KiCad counts fewer vias with no new open item or DRC error (a reroute that cuts a pour into islands first gets one via per island, bridge_islands). Run run_drc and get_score afterwards; a second pass sometimes finds more.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"nets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Net names; * and ? wildcards, e.g. [\"USB_D*\", \"+3V3\"]."
},
"pairs": {
"type": "boolean",
"description": "Rip and reroute a differential pair (_H/_L, _P/_N, +/-) together (default true: a leg rerouted alone comes back at its own length; a step that degrades a pair is never kept)."
},
"pours": {
"type": "boolean",
"description": "Also polish the poured nets (default false): the pour and its stitch vias stay, the net is routed as a track tree on top, then its redundant stitch vias are pruned. A lottery: the tree that did this by accident (PCBGolf +3V3 53 -> 32) did not repeat in 2 deliberate tries."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"workers": {
"type": "integer",
"maximum": 8,
"minimum": 1,
"description": "prune workers for a poured net (default 4)."
},
"max_nets": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Nets to try, most vias first (default 40)."
},
"min_vias": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Only nets with at least this many vias (default 2)."
},
"via_cost": {
"type": "number",
"maximum": 1000,
"minimum": 1,
"description": "Via price for the lone reroute (default 60)."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"ml_options": {
"type": "object",
"additionalProperties": {}
},
"time_budget_s": {
"type": "integer",
"maximum": 600,
"minimum": 10,
"description": "Router budget per net (default 120)."
},
"bridge_islands": {
"type": "boolean"
},
"total_budget_s": {
"type": "integer",
"maximum": 7200,
"minimum": 60,
"description": "Stop starting nets after this (default 1800)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}| time_budget_s | integer | Router budget per try (default 90). |
| bridge_islands | boolean |
| max_extra_vias | integer | Vias a kept reroute may add to the board (default 2). |
| total_budget_s | integer | Stop starting pairs after this (default 1800). |
{
"name": "couple_pairs",
"title": "Couple differential pairs",
"description": "After route_board: re-route the weakly coupled differential pairs one at a time, least coupled first. Both legs are ripped and routed alone around everything else as a pair; the new copper stays only when the pair's coupled share rises by min_gain_pct, its skew stays within max_skew_mm, KiCad counts no new open item or DRC error, and the board gains at most max_extra_vias vias. Pairs routed with the whole board lose their lanes; alone they couple. Run check_net_rules before and after.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"pairs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only pairs with a leg matching these (default every pair under target_pct)."
},
"tries": {
"type": "integer",
"maximum": 6,
"minimum": 1,
"description": "Router seeds per pair; the best acceptable one is kept (default 2)."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"ml_options": {
"type": "object",
"additionalProperties": {}
},
"target_pct": {
"type": "number",
"maximum": 100,
"minimum": 1,
"description": "Pairs coupled below this are tried (default 70)."
},
"max_skew_mm": {
"type": "number",
"description": "Largest length mismatch kept (default: the pair's current skew, at least 1 mm).",
"exclusiveMinimum": 0
},
"min_gain_pct": {
"type": "number",
"maximum": 100,
"minimum": 1,
"description": "Coupling points a reroute must gain to be kept (default 10)."
},
"time_budget_s": {
"type": "integer",
"maximum": 600,
"minimum": 10,
"description": "Router budget per try (default 90)."
},
"bridge_islands": {
"type": "boolean"
},
"max_extra_vias": {
"type": "integer",
"maximum": 20,
"minimum": 0,
"description": "Vias a kept reroute may add to the board (default 2)."
},
"total_budget_s": {
"type": "integer",
"maximum": 7200,
"minimum": 60,
"description": "Stop starting pairs after this (default 1800)."
}
}
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}| courtyards | boolean |
| drc_markers | boolean |
| highlight_nets | array |
| highlight_refs | array |
{
"name": "render_board",
"title": "Render the board (2D, exact)",
"description": "An exact 2D picture of the board as an engineer reads it: copper per layer (the facing layer full strength, the others faded), pads, vias, pours, outline, courtyards and refs. side top|bottom, region [x, y, w, h] mm for a crop, drc_markers to circle every DRC violation, ratsnest to draw the open connections, highlight_nets/highlight_refs in magenta. The pixel-per-mm scale and region come back so a follow-up crop is exact. Download workspace.render.png.",
"inputSchema": {
"type": "object",
"required": [
"design_id"
],
"properties": {
"refs": {
"type": "boolean"
},
"side": {
"enum": [
"top",
"bottom"
],
"type": "string"
},
"layers": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "array",
"items": {
"type": "number"
},
"description": "[x_mm, y_mm, w_mm, h_mm] crop; default the whole board."
},
"wait_s": {
"type": "integer",
"maximum": 55,
"minimum": 0,
"description": "Seconds to wait (default 55); a job still running comes back \"running\" for get_board_job."
},
"markers": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"label": {
"type": "string"
}
}
}
},
"ratsnest": {
"type": "boolean"
},
"design_id": {
"type": "string",
"description": "The design id returned by import_kicad_project or list_designs."
},
"max_width": {
"type": "integer",
"maximum": 4000,
"minimum": 200
},
"px_per_mm": {
"type": "number",
"maximum": 400,
"minimum": 1
},
"courtyards": {
"type": "boolean"
},
"drc_markers": {
"type": "boolean"
},
"highlight_nets": {
"type": "array",
"items": {
"type": "string"
}
},
"highlight_refs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}