Skip to main content
Glama
Sign In
KiCad MCP Pro

KiCad MCP Pro

by Valxyria
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

sch_get_sheet_info

Read-onlyIdempotent

Retrieves metadata for a specified child sheet in a KiCad schematic, including sheet name, properties, and location.

Instructions

Return metadata for a specific child sheet.

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": {
      "sheet_name": "<sheet_name>"
    },
    "name": "sch_get_sheet_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
sheet_nameYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the read-only behavior is covered. The description adds minimal context by specifying 'child sheet', but does not disclose error conditions, what metadata is returned, or any side effects. It does not contradict the annotations.

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 a single concise sentence, front-loaded with the action and resource. Every word earns its place, and there is no irrelevant 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 tool is simple with one parameter and an output schema (which may document return values). However, the description lacks usage context and does not clarify what 'child sheet' means precisely or how sheet_name should be specified. It is adequate but has gaps in practical guidance.

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

Parameters2/5

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

Schema description coverage is 0%, and the description provides no additional meaning for the single required parameter 'sheet_name'. The name is relatively self-explanatory, but no format, path expectations, or default behavior is specified, so the description does not compensate for the lack of schema documentation.

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 'Return metadata for a specific child sheet' uses a specific verb ('Return') and identifies the resource ('metadata for a specific child sheet'). It clearly distinguishes from sibling tools like sch_list_sheets (which lists sheets) and other get_* tools by targeting a single child sheet's metadata.

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 such as sch_list_sheets or other sheet-related tools. The description does not mention prerequisites, context, or exclusions, leaving the agent without direction for selecting it.

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

Deploy Server

Other Tools