Get a board's DRC and ERC results
get_checksUse when the user asks whether a board passes KiCad's own checks, or before trusting a design: returns the stored DRC (design rules, unconnected copper, schematic-vs-board parity) and ERC (electrical rules) results for the board's current version, with exact error and warning counts per category and paged example violations. These are KiCad's checks as the board's author configured them, so rules they waived were never evaluated and are listed separately. This is not a design review. If the checks have not been run for this version the result says so, and that is NOT the same as passing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| board | Yes | A board: handle/slug or a boardrepo.com URL. Use search_boards for public boards or list_my_boards for personal and authorised organisation boards. Do not invent references. | |
| 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. | |
| cursor | No | Opaque pagination cursor from a previous call; pass to fetch the next page of violations. | |
| vendor | No | Optional fab house id from list_fab_profiles. Returns geometric checks against that fab's stored profile for this board instead of the board's own DRC/ERC. Do not invent an id. | |
| category | No | Optional: return only this category's violation details. Counts for every category are always returned regardless. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ran | Yes | ||
| note | No | ||
| vendor | No | ||
| errorCount | No | ||
| nextCursor | No | ||
| violations | No | ||
| hasNextPage | No | ||
| vendorLabel | No | ||
| warningCount | No |