Skip to main content
Glama
Sign In
KiCad MCP Server (IPC API)

KiCad MCP Server (IPC API)

by lmaag182
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_items_by_id

Retrieve board items from a KiCad PCB using their unique UUIDs. Specify item IDs to get detailed information about specific components or elements.

Instructions

Retrieve board items by their KiCad UUID.

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": {
      "item_ids": "<item_ids>"
    },
    "name": "get_items_by_id"
  }
}

Input Schema

NameRequiredDescriptionDefault
item_idsYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3/5.0
Behavior2/5

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

No annotations are provided, so the description must disclose behavior. It only says 'Retrieve' (implies read-only) but omits details like whether multiple IDs can be batch-queried, error handling, or output structure. An output schema exists but is not leveraged in the description.

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?

A single sentence that is front-loaded and wastes no words. It efficiently conveys the core action.

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?

The tool is simple (1 parameter, output schema exists), but the description is minimal. It could be more complete by hinting at return fields or batch behavior, though the output schema partially compensates.

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

Parameters1/5

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

Schema description coverage is 0%, and the description adds no meaning to the 'item_ids' parameter. It only mentions 'KiCad UUID' without specifying format (array of strings?), leaving the agent to guess.

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 uses a specific verb ('Retrieve') and resource ('board items') and specifies the identifier type ('KiCad UUID'), clearly distinguishing it from sibling tools like 'get_items_by_net' or 'get_selection'.

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?

No guidance on when to use this tool versus alternatives. With many sibling tools that retrieve different types of items, the description lacks any context for selection.

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

Deploy Server

Other Tools