set_viewport_shading

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

Minimal behavioral disclosure beyond the name. It does not mention side effects, prerequisites (e.g., an active 3D viewport), or what happens with invalid arguments. Annotations are absent, so the description should fill this gap but falls short.

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?

Extremely concise with three clear sentences. The purpose is front-loaded, and every sentence provides necessary information without fluff.

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?

Adequately covers the tool's action and return value for a simple setter. Missing details on error handling or assumptions about the viewport state, but overall sufficient given low complexity.

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 input schema has 0% description coverage for the 'mode' parameter; the description compensates by listing the exact possible values (WIREFRAME, SOLID, MATERIAL, RENDERED), adding crucial meaning that the schema lacks.

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?

Clearly states it sets the viewport shading mode and lists the four possible modes, providing a specific verb and resource. However, it does not differentiate from sibling tools like set_viewport_overlay, which could cause confusion.

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 explicit guidance on when to use this tool versus alternatives. With many similar set_* tools, the description could mention that it is specifically for viewport shading, not for render settings or overlays.

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