Skip to main content
Glama
Avinash1286

KiCAD MCP Server

by Avinash1286

Remove Hierarchical Sheet

remove_hierarchical_sheet
Destructive

Remove a hierarchical sheet reference from a parent KiCad schematic by matching sheet name or sub-sheet file. Deletes the sheet block and instance entry, leaving the sub-sheet file intact.

Instructions

Remove a hierarchical-sheet reference from a parent schematic (the reverse of add_hierarchical_sheet). Identify the sheet by sheetName (matches the sheet's name property) or by subsheetPath (matched by basename against the sheet's file property). Deletes the (sheet ...) block and any matching (sheet_instances) page entry. Does NOT delete the sub-sheet .kicad_sch file on disk.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sheetNameNoSheet display name to remove (matches the Sheetname/Sheet name property)
subsheetPathNoSub-sheet file to remove (matched by basename against the Sheetfile property)
schematicPathYesPath to the parent .kicad_sch

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

The description goes beyond the annotations (which already indicate destructiveHint=true) by specifying exactly what gets removed: the (sheet ...) block and matching (sheet_instances) page entry. It also explicitly discloses what it does NOT do (delete the sub-sheet file), providing important behavioral nuance. No contradiction with annotations.

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?

The description is three sentences, each earning its place: the first defines the operation, the second explains identification, and the third details scope and the file deletion caveat. It is front-loaded and free of unnecessary wording.

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 destructive tool, the description covers all relevant aspects: what gets removed, how to identify the target, and what is preserved. With an output schema present, return value details are not required. Given its moderate complexity and good annotations, the description is complete and contextually sound.

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 description coverage is 100%, so the schema already documents all three parameters. The description does reiterate how sheetName and subsheetPath are matched (by name property and basename against file property), which adds slight emphasis, but it stays consistent with the schema. Baseline 3 is appropriate since the schema carries the parameter meaning.

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 action: 'Remove a hierarchical-sheet reference from a parent schematic', identifying both verb and resource. It also differentiates from siblings by explicitly noting it's 'the reverse of add_hierarchical_sheet', making the purpose unambiguous.

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 clear context by framing the tool as the reverse of add_hierarchical_sheet, which implies when to use it. It also explains which sheet is affected via sheetName or subsheetPath and clarifies what is deleted (sheet block and sheet_instances entry). However, it does not explicitly state exclusions or alternative tools for file deletion, though the note about not deleting the .kicad_sch file offers indirect 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