Skip to main content
Glama

search_library_symbols

Search KiCad library symbols by name, description, keywords, or footprint to locate matching parts; filter results by library, project, or hidden-library inclusion.

Instructions

Search the symbols of the KiCad libraries by name, description and keywords.

Each word of the query must be in the library ID ("Device:R"), the description, the keywords or the default footprint. A derived symbol gets the empty fields from its parent. The order is that of the symbol chooser of KiCad: an exact name first, then the best score. The first search reads all libraries (some seconds); then an index in the user cache directory is used until a library file changes.

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": {
      "query": "<query>"
    },
    "name": "search_library_symbols"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoThe maximum number of results in the table.
queryYesWords to find, for example "op amp rail-to-rail".
libraryNoOptional name of one library to search (also when it is hidden).
project_pathNoOptional project (.kicad_pro, .kicad_sch, .kicad_pcb or its directory), to include its libraries.
include_hiddenNoAlso search libraries that are hidden in KiCad.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the disclosure burden and does so: it warns that the first search reads all libraries and takes seconds, and that a cache index in the user cache directory is used until a library file changes. It also states the result ordering (exact name first, then best score). It does not explicitly say the operation is read-only or side-effect free, which is the only notable omission.

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?

The core action is front-loaded in the first sentence, with matching semantics, ordering, and the caching caveat following in a logical order. It is dense but nearly every sentence carries information; the caching note is slightly lengthier than strictly necessary.

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?

A read-only search tool with a full input schema and an output schema, so return values need no explanation. The description supplies matching rules, ordering, and the performance/caching caveat — everything an agent needs to call it and set expectations, minus explicit sibling routing.

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 the baseline is 3, but the description earns more: it defines that 'query' words must each appear in library ID, description, keywords or default footprint, and it explains that derived symbols inherit empty fields from their parent — semantics not present in the schema. It adds no extra detail on limit, include_hidden or project_path.

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 and resource ('Search the symbols of the KiCad libraries') plus the matched fields (name, description, keywords). It never names a sibling such as search_library_footprints, so an agent must infer the symbol-vs-footprint split from the tool name alone.

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?

The description explains how matching works and even the result ordering, which implicitly tells the agent this is a free-text library lookup. However, it gives no explicit when-to-use guidance against alternatives (e.g. a generic symbol search or a component-by-type search) and no when-not-to-use conditions.

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