Skip to main content
Glama

list_schematic_components

Lists all placed schematic components from a .kicad_sch file, including reference and unit per sheet path, with optional filters for DNP status, reference type, and value.

Instructions

Give the components of a schematic file.

Each placed symbol of the file is in the list one time for each sheet path of the file, with the reference and the unit that KiCad gives that path (a sheet that the hierarchy uses two times gives two references). Power symbols are not components. The tool needs kicad-cli (the rules of the KiCad 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": {
      "file_path": "<file_path>"
    },
    "name": "list_schematic_components"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_pathYesA .kicad_sch file of the project.
filter_dnpNoOptional: True gives only the DNP components, False only the components that are not DNP.
filter_typeNoOptional start of the references, for example "R", "C" or "U" (no difference of case).
filter_valueNoOptional text in the Value field (no difference of case).

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the non-obvious duplication semantics (one entry per sheet path, so a reused sheet yields two references), the exclusion of power symbols, and a runtime dependency on kicad-cli. It omits read-only/safety framing and any note on ordering or volume, but the description's core behaviors are covered.

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?

The opening sentence is front-loaded and the following sentences each add distinct information (duplication rule, power exclusion, dependency). The parenthetical "(the rules of the KiCad version)" is slightly awkward but not wasteful.

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?

Return values are covered by an output schema, and all parameters are described, so the description only needs to convey behavior—which it does, including the per-sheet-path rule that an agent could not guess from the schema. The remaining gap is routing guidance relative to sibling listing 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%, so all four parameters (file_path, filter_dnp, filter_type, filter_value) are documented in the schema itself. The description adds no filter semantics beyond the schema, so 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?

States a specific verb and resource ("Give the components of a schematic file") and adds scope precision: one entry per sheet path, per-path reference/unit, power symbols excluded. It does not name a sibling alternative, so an agent must infer the boundary with tools like get_netlist_components or list_schematic_nets.

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?

The prerequisite "needs kicad-cli (the rules of the KiCad version)" gives useful context on when the tool can be invoked. However, there is no explicit guidance on when to choose this tool over netlist/schematic-net siblings, and no stated exclusions beyond the power-symbol note.

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