Skip to main content
Glama

get_schematic_info

Extract a KiCad schematic file's title block, component and sheet counts, and sheet paths to inspect project structure.

Instructions

Give the title block, the counts and the sheets of a schematic file.

The components and the sheet symbols are the ones that KiCad loads for the project of the file (the references of each sheet path). 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": "get_schematic_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_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

B3.1/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose two useful traits: the result reflects what KiCad loads for the whole project (hierarchical sheet paths), and it depends on kicad-cli being installed with matching version rules. It does not state behavior when kicad-cli is missing or how the tool behaves on a standalone sheet with no project context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Short and front-loaded with the main output content, but the prose is choppy and parenthetical ('the rules of the KiCad version') is cryptic rather than informative. The structure is serviceable yet partly wasted on ambiguous phrasing.

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?

An output schema exists, so return values need no explanation, and the kicad-cli prerequisite is a genuine addition. However, for a read tool with no annotations, the description leaves gap around failure modes and the meaning of 'counts', so it is only just adequate for the tool's complexity.

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 file_path parameter is already documented as a .kicad_sch file. The phrase 'the project of the file' adds a mild constraint — the file is expected to belong to a project — but no format, path, or resolution detail beyond the schema.

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?

The description names a specific verb and resource ('Give the title block, the counts and the sheets of a schematic file') and clarifies that components/sheet symbols reflect the full hierarchical project load, which separates it from flat listing siblings like list_schematic_components. 'The counts' remains vague — it never says counts of what (sheets, components, symbols).

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?

There is no explicit when-to-use guidance and no named alternative among the many sibling schematics tools. The only conditional context offered is a prerequisite (kicad-cli), not a routing rule for choosing this tool over list_schematic_components or export_schematic_svg.

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