Skip to main content
Glama

export_erc_report

Run electrical rules checks on a KiCad schematic and save the results as a JSON report file for inspection or automation.

Instructions

Run the ERC of kicad-cli on a schematic 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": {
      "schematic_path": "<schematic_path>"
    },
    "name": "export_erc_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
output_pathNoOptional file of the report. Default: <schematic>_erc_report.json next to the schematic.
schematic_pathYesA .kicad_sch file of the project.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden and it discloses only that an external CLI (kicad-cli) is invoked and a file is written. It says nothing about overwriting an existing report, what happens when the schematic has ERC errors or the CLI fails, or any permissions/environment requirements for shelling out to kicad-cli.

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

Conciseness5/5

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

A single front-loaded sentence with the action first and the output artifact second; there is no filler or repetition, and every clause carries information.

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

Completeness3/5

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

The presence of an output schema and fully described parameters lowers the burden, and the core action is covered. Still, for a tool that spawns an external process and writes a file, missing notes on overwrite behavior and failure handling leave meaningful gaps for correct invocation.

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%, and the schema itself already documents output_path's default of '<schematic>_erc_report.json next to the schematic' and schematic_path's .kicad_sch requirement. The description adds no path format, relative-vs-absolute, or directory-existence semantics beyond that, so the baseline of 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 chain and resource: run kicad-cli ERC on a schematic and copy the JSON report into a file. That distinguishes it functionally from in-memory siblings like get_erc_violations, but it never names or contrasts any sibling explicitly, leaving an agent to infer the boundary.

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?

Use is only implied by the phrase 'copy its JSON report into a file' — an agent can guess this is the tool for a persisted report. There is no explicit when-to-use, no statement of when to prefer run_erc or get_erc_violations instead, and no prerequisites such as a valid kicad-cli install.

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