Skip to main content
Glama

get_symbol_details

Retrieve a schematic component's fields and pins by reference from a .kicad_sch file to inspect or verify its properties in KiCad.

Instructions

Give the fields and the pins of one component of a schematic.

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>",
      "reference": "<reference>"
    },
    "name": "get_symbol_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_pathYesA .kicad_sch file of the project.
referenceYesThe reference of the component, for example "R1" or "U1".

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. It discloses what data comes back (fields and pins) for a specific placed component, implying a read-only lookup, but says nothing about failure behavior for an unknown reference or whether library definitions are included. Since an output schema exists, the return shape itself does not need describing here.

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?

A single front-loaded sentence with zero filler; the resource being acted on is stated immediately. It is arguably over-terse, but nothing is wasted.

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?

For a simple two-parameter read tool with full schema documentation and an output schema, the description is adequate but thin. It omits what distinguishes the returned 'fields' from check_symbol_fields and does not address behavior for missing references.

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 coverage is 100%, with both file_path and reference documented in-schema including a concrete example ('R1', 'U1'). The description adds no further meaning about these parameters, so the baseline 3 is appropriate.

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 – returns the fields and pins of a single schematic component – which an agent can distinguish from sibling check_symbol_fields or set_symbol_fields. It stops short of explicitly contrasting with those siblings, so it is clear but not fully differentiated.

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, no prerequisites, and no mention of alternatives such as get_schematic_info for whole-schematic data or get_library_symbol for library rather than placed parts. The phrase 'one component of a schematic' only faintly implies the single-part lookup scope.

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