ui_toggle

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

Discloses use of TogglePattern, return values (On/Off/Indeterminate), and the need to resume execution if app is stopped. Annotations are minimal (only openWorldHint), so description adds value. No contradictions. Could elaborate on side effects or failure modes.

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?

Description is well-structured with clear sections: purpose, return value, usage tip, and parameter list. Each sentence serves a purpose. No redundancy. Front-loaded with essential info.

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?

Covers main functionality, return value, and a critical usage note (breakpoint state). Lacks information on error handling, what happens if element not found, or parameter combination rules. Output schema absent but return value is explained. Good for a simple tool.

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 has no parameter descriptions (0% coverage). Description provides one-line explanations for each parameter (e.g., 'AutomationId property', 'Optional XPath expression'). This adds basic meaning but lacks detail on formats, examples, or interrelationships. Adequate compensation for low schema coverage.

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 clearly states it toggles CheckBox/ToggleButton using UIA TogglePattern and returns new state. It distinguishes itself from sibling ui_click for checkboxes, providing specific verb+resource and differentiation.

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?

Explicitly advises using this over ui_click for checkboxes for reliable state feedback. Also notes prerequisite to resume execution if app is stopped. Could mention other alternatives like ui_invoke, but guidance is clear.

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