Skip to main content
Glama
ProductOfAmerica

mcp-server-kicad

list_schematic_sheets

Read-onlyIdempotent

Retrieve all hierarchical sheet names from a KiCad schematic file. Optionally specify a path to inspect a particular schematic.

Instructions

List all hierarchical sheets in the schematic.

Args:
    schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schematic_pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, covering safety. The description adds the scope ('all hierarchical sheets') and the optional default path behavior, which is useful context, but does not disclose return format or potential errors. Since annotations handle the safety profile, this is acceptable.

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?

The description is two sentences: the first states the purpose, the second covers the parameter. All information is front-loaded and every sentence earns its place. There is no redundancy or filler.

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?

For a simple read-only list tool with an output schema, the description covers the essential aspects: what it does and what the parameter means. It lacks explicit usage guidance or prerequisites, but given the straightforward nature and good annotations, it is nearly complete. A minor gap is not clarifying whether 'all hierarchical sheets' includes nested sheets recursively.

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

Parameters5/5

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

The description explicitly explains the single parameter: 'Path to .kicad_sch file. Optional; omit to use the configured default.' This provides meaning beyond the input schema, which only has a default empty string and no description. It clearly conveys the parameter's purpose, optionality, and default behavior.

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?

The description clearly states the tool lists all hierarchical sheets in the schematic, using the specific verb 'List' and a specific resource. This distinguishes it from other list_* tools that target different entity types (components, labels, wires, etc.).

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 description implies usage by stating what it does, but does not explicitly provide when-to-use context or alternatives. Sibling tools like list_hierarchy and get_sheet_info exist, but no guidance is given on when to prefer this tool over them.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ProductOfAmerica/mcp-server-kicad'

If you have feedback or need assistance with the MCP directory API, please join our Discord server