Skip to main content
Glama
Avinash1286

KiCAD MCP Server

by Avinash1286

Set Sheet Property

set_sheet_property
Destructive

Set or update custom sheet properties on hierarchical sheet blocks in KiCAD schematics. Identify the sheet by name or path; creates hidden property if missing, updates value if present.

Instructions

Add or update a custom property on a hierarchical sheet's (sheet ...) block — e.g. cell identity or generator parameters carried as sheet metadata. Identify the sheet by sheetName or sheetPath (basename match against the sheet's file property). The property is created hidden if absent, otherwise its value is updated in place; the file's formatting is preserved. The built-in 'Sheet name'/'Sheet file' properties cannot be set here — use add/remove_hierarchical_sheet to manage the sheet link.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesProperty name (e.g. 'IS.Cell')
valueYesProperty value
sheetNameNoSheet display name (matches the Sheetname/Sheet name property)
sheetPathNoSub-sheet file (matched by basename against the Sheetfile property)
schematicPathYesPath to the parent .kicad_sch

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations indicate destructiveHint=true and readOnlyHint=false, which the description aligns with by explaining write/update behavior. It adds useful context about hidden creation, in-place updates, and formatting preservation, going beyond the annotations. However, it does not detail potential failure modes or what happens if the sheet is not found.

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 well-structured sentences that front-load the main action and then provide necessary details and exclusions. No redundant wording, every sentence contributes.

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?

The description covers purpose, identification, behavior, and exclusions, which is sufficient given the detailed annotations and presence of an output schema. It doesn't elaborate on error conditions, but that is a minor gap for a tool with clear schema and annotation support.

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 100%, so the baseline is 3. The description adds value by explaining the matching semantics for sheetName/sheetPath (basename match against file property) and clarifying that key/value represent custom metadata. This goes beyond the schema descriptions.

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 specific and actionable language ('Add or update a custom property') and identifies the exact resource ('hierarchical sheet's block'). It distinguishes itself from sibling tools by explicitly excluding built-in 'Sheet name'/'Sheet file' properties and pointing to add/remove_hierarchical_sheet for managing sheet links.

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

Usage Guidelines5/5

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

Provides explicit when-to-use context (adding/updating custom sheet metadata) and clearly states what cannot be done (built-in properties) with a directed alternative (use add/remove_hierarchical_sheet). Also clarifies identification via sheetName or sheetPath with basename matching, giving practical usage guidance.

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/Avinash1286/KiCAD-MCP-Server-THEAVI'

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