Skip to main content
Glama

create_kicad_project

Creates a new KiCad project from a blank setup or template and fills the root schematic title block; handles overwrite confirmation errors.

Instructions

Create a new KiCad project, as the project manager of the installed KiCad (8, 9 or 10) makes it.

With no template ("empty"), the project gets the files of "New Project" of KiCad: KiCad 8 and 9 copy the project file kicad.kicad_pro of KiCad and write an empty schematic and board. KiCad 10 makes the project from its template "default" (it makes that template when it is not there). With a template, the project gets the files of "New Project from Template": the files of the template with the project name in the place of the template name, then the files that are missing. KiCad does not change the files of a template. The tool then writes the title, the company and the date into the title block of the root schematic that it wrote.

When the project folder is not empty (no template), or it has files of the template, KiCad asks the user. The tool then gives an error: ask the user, then call it again with overwrite=True.

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": {
      "project_path": "<project_path>",
      "project_name": "<project_name>"
    },
    "name": "create_kicad_project"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNoOptional title of the project. Default: project_name.
companyNoOptional name of the company.
templateNo"empty" (default) for a blank project, or a KiCad template: a name on the template pages of KiCad (KICAD_USER_TEMPLATE_DIR and KICAD<version>_TEMPLATE_DIR, for example "Arduino_Uno") or the path of a template folder.empty
overwriteNoTrue after the user confirmed: with a template, the files of the template replace the files with the same names; with no template, the tool makes the project in a folder that is not empty (the files of the folder stay, as in KiCad).
project_nameYesName of the project. As in the file dialog of KiCad, the extension ".kicad_pro" (or a last ".") goes: "board.kicad_pro" gives "board".
project_pathYesThe folder of the project.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations, the description carries the full behavioral burden and does so: it discloses version-specific file creation, that template files are never modified, that the root schematic title block gets title/company/date, and that a non-empty folder produces an error rather than silent overwriting. The destructive-vs-safe boundary is fully explicit via overwrite.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded and the error/overwrite guidance closes usefully, but the KiCad 8/9/10 file-by-file narration is more implementation detail than an agent needs to select or invoke the tool. Several sentences restate the same template-copy behavior.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter creation tool with full schema coverage and an output schema, nothing operationally important is missing: creation modes, template resolution, overwrite semantics, and the failure/recovery path are all covered.

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 already 100%, so the baseline is 3, but the description adds genuine meaning beyond the schema by stating that title/company are written into the title block of the root schematic and what a template actually does to the created files. That clarifies the effect of `template` and `overwrite` beyond their own schema text.

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?

Names a specific verb and resource ("Create a new KiCad project") and immediately scopes it to the installed KiCad project manager, including versions 8/9/10. It is clearly distinguishable from the sibling editing/analysis tools, none of which create projects.

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?

Clearly explains the two modes of use (blank project with "empty" vs. template-based) and, crucially, the recovery path when the target folder is non-empty: ask the user, then re-call with overwrite=True. No alternative tool is offered, but no plausible alternative exists among the siblings.

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