Skip to main content
Glama

export_drc_report

Run a KiCad DRC on a board and save its JSON report to a file, with an optional custom output path.

Instructions

Run the DRC of kicad-cli on a board and copy its JSON report into a file.

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": {
      "pcb_path": "<pcb_path>"
    },
    "name": "export_drc_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
pcb_pathYesThe .kicad_pcb file.
output_pathNoOptional file of the report. Default: <board>_drc_report.json next to the board.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden, and it does disclose two useful facts: it shells out to the external kicad-cli binary and it writes a file to disk (a side effect). It does not say whether an existing report file is overwritten, whether a run with violations is treated as an error, or whether the CLI invocation is slow — gaps that matter for a mutating filesystem operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence that front-loads the action and ends with the outcome; nothing is wasted. Slightly awkward phrasing ("the DRC of kicad-cli") but structurally sound.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and the input schema is fully documented, so return values and parameters need no further explanation. For a two-parameter tool this is nearly complete; only the file-overwrite and DRC-failure behavior are left unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters are already documented, including the default naming convention for output_path. The description reinforces that output is a JSON file but adds no format, path-resolution, or override semantics beyond the schema — the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ("Run the DRC of kicad-cli on a board") plus the artifact it produces ("copy its JSON report into a file"). This implicitly separates it from siblings like run_drc (no file output) and get_drc_violations (returns violations rather than writing a report), though no sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: the "copy its JSON report into a file" phrasing suggests this is the tool to pick when a persisted JSON artifact is wanted rather than inline violations. There is no explicit statement of when to prefer this over run_drc or get_drc_violations, and no prerequisites (e.g., kicad-cli availability) are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.