Skip to main content
Glama

connect_kicad

Connect to a running KiCad instance via IPC API. This must be called before any other tool operations.

Instructions

Connect to a running KiCad instance via the IPC API.

This must be called before any other operations. Ensure KiCad is running with the API server enabled in Preferences > Plugins.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
socket_pathNoOptional path to IPC socket. If not provided, reads from KICAD_API_SOCKET environment variable or uses default platform path.
kicad_tokenNoOptional API token for authentication.
timeout_msNoConnection timeout in milliseconds. Default 2000.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

No annotations are provided, so the description must cover behavioral traits. It mentions the connection prerequisite but does not describe side effects, error handling, or what happens on failure.

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?

Two concise sentences: first states the main purpose, second gives essential usage guidance. No extraneous 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?

For a connection tool with simple optional parameters, the description covers the key requirement (call first, ensure KiCad is ready). Could mention timeout or auth behavior but adequate.

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% and each parameter is well-described in the schema. The description adds no extra meaning beyond stating optionality and defaults.

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 tool connects to a running KiCad instance via the IPC API and specifies it must be called before any other operations, distinguishing it from siblings like check_connection.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides when to use (first) and how to ensure KiCad is ready (enable API server), but lacks explicit when-not-to-use or alternative tools.

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/daedalus/mcp-kicad'

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