Skip to main content
Glama
ProductOfAmerica

mcp-server-kicad

list_hierarchy

Read-onlyIdempotent

List the full sheet hierarchy of a KiCad schematic, starting from the root .kicad_sch file.

Instructions

List the full sheet hierarchy starting from a root schematic.

Args:
    schematic_path: Path to root .kicad_sch file

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schematic_pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rootYes
component_countYes
sheet_countYes
sheetsYes
Behavior3/5

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

Annotations already indicate read-only, non-destructive, idempotent behavior. The description adds the concept of 'full hierarchy' and 'root', but doesn't discuss potential behaviors like handling missing path or error conditions.

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 extremely concise: one sentence and a parameter line with no extraneous text. Every word earns its place.

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?

With an output schema present, return values need not be described. The description is adequate for a simple listing tool but lacks usage guidance and parameter edge cases.

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?

The description adds that 'schematic_path' expects a path to a root .kicad_sch file, which is not fully captured in the schema (0% coverage). However, it doesn't clarify that the parameter is optional or explain 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 the full sheet hierarchy from a root schematic. It uses specific verb 'List' and resource 'full sheet hierarchy', distinguishing it from siblings like 'list_schematic_sheets' which likely lists flat sheets.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives like 'list_schematic_sheets' or 'trace_hierarchical_net'. Usage context is implied but not explicitly stated.

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