Run a board's checks
run_checksUse when get_checks reports the checks have not been run for this board's current version and you need a verdict before answering. Runs KiCad's own DRC and ERC, or a fab house's manufacturability rules when vendor is given (list them with list_fab_profiles). EXPENSIVE and shared: this is a real kicad-cli run on one worker that everyone's boards queue behind, so run it when the answer matters, not on every board you look at. It usually returns the result directly. Status 'running' means a relevant check is queued or processing; read its result later with get_checks. Status 'busy' means another job holds the board's worker slot and nothing was started: call run_checks once more after retryAfterMs. Do not use it to re-run a board that already has a result at this version.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"board": "<board>"
},
"name": "run_checks"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| board | Yes | A personal board, or an organisation board with read:org consent and check permission: handle/slug or a boardrepo.com URL. Discover it with list_my_boards; do not guess one. | |
| rules | No | Optional: YOUR OWN limits in millimetres, when no published fab profile fits - an in-house process, a tier a vendor does not publish, or a house rule tighter than any of them. Keys are the same limit names list_fab_profiles reports (trackWidthOuterMm, clearanceOuterMm, drillPlatedMinMm, annularMinMm and so on); values are millimetres. Mutually exclusive with vendor. The result is never stored as if a fab had published it. | |
| vendor | No | Optional fab house. Known ids: jlcpcb, pcbway, oshpark, multi-cb, eurocircuits, advanced-circuits, seeed, elecrow. A house name or one of that house's profile ids also resolves. Omit to run the board's own DRC + ERC. | |
| version | No | Which saved version to read: a version number (3 or "v3"), a versionId from list_board_versions, "latest", or a release tag such as "rev-A". Omit for the latest version. Results echo the version they read; pass its id back to stay on it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||