Skip to main content
Glama
ProductOfAmerica

mcp-server-kicad

get_symbol_instances

Read-onlyIdempotent

Retrieve all symbol instances from a KiCad root schematic file. Provide the schematic path to get a list of symbols used in the design.

Instructions

List all symbol instances from a root schematic's symbolInstances table.

Args:
    schematic_path: Path to root .kicad_sch file

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schematic_pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
instancesYes
countYes
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, so the description adds no further behavioral context beyond the table specificity. It does not contradict 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?

Extremely concise: two lines front-loaded with the purpose and one parameter detail. Every sentence earns its place with no wasted words.

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?

Given the existence of an output schema and simple single-parameter tool, the description is mostly complete. Lacks details on requiredness of the path or error handling, but sufficient for basic use.

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?

The description adds meaning to the schematic_path parameter by specifying it is a path to a .kicad_sch file. The schema lacks parameter descriptions, so the description compensates well.

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 clearly states the verb 'List' and the specific resource 'symbol instances from a root schematic's symbolInstances table'. This distinguishes it from sibling tools like list_schematic_components by specifying the exact table.

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 implies usage when needing symbol instances from a root schematic, but does not explicitly state when to use this tool versus alternatives like list_schematic_components or list_schematic_sheets. No when-not or alternative guidance is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ProductOfAmerica/mcp-server-kicad'

If you have feedback or need assistance with the MCP directory API, please join our Discord server