toggle_overlays

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

With no annotations, the description carries the behavioral burden. It discloses the core effect (show/hide the listed overlays) and explains the parameter, but it does not state whether the setting persists, whether it applies to all viewports, or what it returns. The name 'toggle' also slightly conflicts with the explicit set-to-'show' behavior, though the parameter explanation mitigates this.

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?

Two sentences with zero wasted words. The core action and the parameter explanation are front-loaded, making the definition instantly parseable.

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 boolean setter with one optional parameter and no output schema, the description plus the schema's default value is sufficient. It defines the operation, the affected overlay types, and how to achieve each state, so nothing critical is missing.

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?

The single parameter 'show' is fully explained with explicit semantics ('True to show overlays, False to hide'), directly compensating for the 0% schema description coverage. This adds real meaning beyond the bare boolean property and default value.

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 states a specific verb ('Toggle') with a clear resource ('viewport overlays') and enumerates which overlays are affected ('grid, axes, selection outlines'). This distinguishes it from siblings like set_viewport_shading and set_viewport_camera, even without naming them.

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 provides no guidance on when to use this tool instead of alternatives. It does not mention set_viewport_shading for shading modes or set_viewport_camera for camera controls, nor any conditions or exclusions. An agent must infer usage from the name alone.

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