Skip to main content
Glama

Import a KiCad project

import_kicad_project

Bring an existing KiCad project in as a board workspace: the project folder as a ZIP (the .kicad_pcb, .kicad_pro, schematics, footprint and 3D-model folders), base64-encoded, up to about 18 MB zipped. The CLI does this with koppar import <folder>. Or from_design_id: the KiCad project of a design the pipeline built (its board, rules, schematics and custom footprints) opened as a workspace, to change the design rules, place and route it with the board tools and put the result back with upload_board (workspace_id). Returns the design_id the board tools take and a first get_board_info.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
briefNoWhat the user wants done with the board, for the design record.
titleNo
board_fileNoWhich .kicad_pcb at the top of the project, when there are several.
zip_base64NoThe zipped project folder, base64.
from_design_idNoA design of yours with a board (start_board or upload_board): its KiCad project becomes the workspace. Instead of zip_base64.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / from_design_id
      Added value: +{
      +  "description": "A design of yours with a board (start_board or upload_board): its KiCad project becomes the workspace. Instead of zip_base64.",
      +  "pattern": "^[A-Za-z0-9_-]{8,80}$",
      +  "type": "string"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "zip_base64"
      -]
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already state readOnlyHint=false, destructiveHint=false, openWorldHint=false, so the description must add beyond that and it does: the ~18 MB zipped size limit, base64 encoding requirement, the returned design_id plus a first get_board_info, and the follow-up upload_board workflow. Failure modes and permission requirements are not covered, keeping it at a 4.

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?

Front-loaded with the primary purpose and input modes, with no filler sentences. However, it is a dense, run-on block where the return value and workflow notes are crammed into the final clause, which slightly reduces scannability.

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?

There is no output schema, and the description compensates by stating what is returned (design_id and a first get_board_info). Both input paths, the size limit, and the downstream workflow are covered, leaving only minor gaps like edge cases for multiple board files.

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 80%, so the baseline is 3, but the description adds real meaning: zip_base64 is the zipped project folder with an explicit size cap, and from_design_id is framed as the alternative path ('Or from_design_id') that opens an existing design's project as a workspace. brief and title remain unelaborated, so not a 5.

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?

States a specific verb (import) and resource (KiCad project) and distinguishes two distinct input modes: a zipped project folder or a pipeline-built design via from_design_id. It also names the workspace outcome and return value, so an agent can tell it apart from siblings like start_board, create_design, and upload_board.

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?

Gives a clear context for each mode: bring an existing project in via ZIP, or open a pipeline-built design to change rules, route, and push back with upload_board. The CLI equivalent (`koppar import <folder>`) is a helpful orientation cue. It does not explicitly exclude alternatives such as start_board for a blank board, so it stops short of full when-not guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources