Skip to main content
Glama

get_library_symbol

Retrieve a KiCad library symbol's fields, units, and pins. Use it to inspect symbol definitions, including inherited fields, flags, and pins from parent and root symbols, before placing or editing components.

Instructions

Show the content of a symbol of a KiCad library: fields, units and pins.

The library comes from the library tables of the installed KiCad and of the project, as in the symbol chooser of KiCad. A derived symbol (extends ...) is shown as KiCad places it: the fields of the symbol and of its parents, the flags of its parent, and the units and pins of its root symbol.

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": {
      "lib_id": "<lib_id>"
    },
    "name": "get_library_symbol"
  }
}

Input Schema

NameRequiredDescriptionDefault
lib_idYesThe library ID, for example "Device:R" or "MCU_ST_STM32F4:STM32F405RGTx".
project_pathNoOptional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does meaningful work: it discloses library resolution sources (installed KiCad tables plus project tables) and the derived-symbol merge behavior — fields and units/pins inherited from parents and root symbol, flags taken from the parent. What is missing is an explicit statement that this is a pure read with no side effects and whether unknown lib_ids error or return empty.

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 purpose is front-loaded in the first sentence and the second paragraph exists solely to explain library resolution and derived-symbol materialization, both of which change how the agent interprets the result. No filler or repetition of schema content.

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?

An output schema exists, so return-value detail is not required, and for a two-parameter read tool the definition covers resolution scope and inheritance behavior well. A brief note on missing-symbol behavior or that the call is side-effect free would make it fully complete.

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

Parameters4/5

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

Schema coverage is 100%, so lib_id format and project_path defaults are already documented. The description still adds semantic value by explaining what project_path actually does — that project libraries are merged with the installed KiCad library tables — which the schema only gestures at with 'to include its libraries'.

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?

States a specific verb ('Show') and resource ('content of a symbol of a KiCad library') and enumerates exactly what is returned: fields, units and pins. It does not, however, distinguish itself from adjacent siblings such as get_symbol_details or get_library_footprint, which an agent must disambiguate on its own.

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?

Usage is implied rather than prescribed: the agent can infer this is the lookup-by-lib_id path, and the note that libraries resolve 'as in the symbol chooser of KiCad' clarifies scope of the search space. There is no explicit when-to-use/when-not statement and no named alternative for the neighboring symbol/footprint tools.

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