Skip to main content
Glama

generate_netlist

Exports a KiCad schematic's netlist to a temporary XML file and returns its path for tracing connections, nets, and components. Regenerate it after each schematic change.

Instructions

Make the netlist of a schematic with kicad-cli, and give the path of its file.

kicad-cli writes the netlist (KiCad XML) of the full project into a file in the temporary folder of the system. Give this file to trace_netlist_connection, get_netlist_nets and get_netlist_components. Make the netlist again after a change of the schematic.

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": "generate_netlist"
  }
}

Input Schema

NameRequiredDescriptionDefault
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

A4.1/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full behavioral burden and does disclose the key side effect: kicad-cli writes a KiCad XML netlist of the full project into the system temporary folder. That tells the agent this is a file-producing operation and where the file lives. Gaps remain: nothing about failure modes (e.g. kicad-cli unavailable), whether an existing file is overwritten, temp-file lifetime/cleanup, or expected runtime.

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?

Front-loaded with the action and the returned artifact, then the mechanism and the downstream consumers. Slight redundancy between "give the path of its file" and the sentence explaining where the file is written, but nothing is wasted at a harmful level.

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, so return-value detail is unnecessary, and the description correctly focuses on the file-producing behavior and the handoff to three consumers. It is nearly complete for a one-parameter tool, with the only meaningful omission being temp-file persistence/cleanup semantics that matter because the output is passed to other tools.

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 single parameter is documented as "A .kicad_sch file of the project." The description adds only modest extra meaning, notably that the netlist covers the whole project rather than the single sheet. With the schema doing the detailed work, baseline 3 applies.

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

Purpose5/5

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

"Make the netlist of a schematic with kicad-cli, and give the path of its file" states a specific verb (generate), a specific resource (KiCad netlist), and the concrete artifact returned (a file path). That distinguishes it clearly from the netlist-consuming siblings (get_netlist_nets, get_netlist_components, trace_netlist_connection), which only read an already-produced netlist.

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

Usage Guidelines4/5

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

The description gives explicit ordering guidance: hand the produced file to trace_netlist_connection, get_netlist_nets and get_netlist_components, and regenerate "after a change of the schematic." This is clear workflow context, but it offers no exclusion guidance (e.g. that it is unnecessary when a netlist already exists and is current) and does not contrast with export_bom or the analyze_* alternatives.

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