toggle_preview

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

No annotations are provided, and the description does not disclose behavioral traits such as required permissions, side effects (e.g., does toggling preview clear the programmer?), or whether the operation is reversible. Only the basic toggle action is stated.

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 concise, using a clear Args/Returns structure. Every sentence adds value, though it could be slightly more compact. It front-loads the purpose in the first sentence.

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?

Given no annotations and an output schema labeled as present but not shown, the description adequately explains parameters and the return type as a string. However, it lacks context on side effects, preconditions, or postconditions, making it incomplete for a tool that modifies state.

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?

With 0% schema description coverage, the description compensates by explaining each parameter in the 'Args' section: executor_id, page, and edit_mode. It adds meaning beyond the schema by describing the effect of each parameter, such as 'Optional page for page-qualified executor addressing'.

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 the tool toggles preview mode and explains it visualizes output without affecting DMX. It is a specific action on a distinct resource, differentiating it from the many sibling tools that deal with fixtures, macros, etc.

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?

No guidance on when to use this tool versus alternatives, nor any prerequisites or exclusions. The description assumes the user knows when to toggle preview, which limits its helpfulness for an AI agent.

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