Get Sheet Properties

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

Annotations already indicate readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds valuable context by specifying the sheet hierarchy, the inclusion of full property maps (including custom properties set via set_sheet_property), and the optional filtering behavior. 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.

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

The description is two sentences, front-loaded with the primary action and resource, and second sentence adds the optional filtering. Every word contributes meaning; there is no fluff or repetition.

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

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

For a simple read-only listing tool with annotations covering safety and an output schema provided, the description fully captures the tool's scope and behavior. The mention of hierarchical sheets and custom properties adds necessary context beyond the schema, making it complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% for all three parameters, so the schema already documents them. The description adds a small clarification that sheetName or sheetPath returns only that sheet, but this is mostly redundant with the schema descriptions. No new parameter-specific semantics are introduced.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('List') and clearly defines the resource ('hierarchical sheets in a schematic') and the returned data (name, file, uuid, position, property map). It also distinguishes from sibling tools like set_sheet_property and add_hierarchical_sheet by focusing on read-only listing.

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

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

The description clearly states the tool's purpose and optional filtering by sheetName or sheetPath, giving users context on when to use it. It does not explicitly name alternatives or exclusions, but the read-only nature and sibling tool names provide enough indication.

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