set_spa_pitch_width

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

No annotations are present, so the description bears full responsibility for behavioral disclosure. It states the data type and default value but does not describe side effects, persistence, or limits of operation (e.g., what happens if an out-of-range value is set). The prerequisite is noted but not elaborated.

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 extremely concise, front-loading the purpose and following with essential notes in parentheses. No superfluous words; every sentence adds necessary context.

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 parameter setter, the description covers the key points: what it sets, the data type, default, and prerequisite. It could be more complete by hinting at effective ranges or consequences, but it is adequate for typical use.

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 schema covers 100% of parameters with a minimal description, but the tool description adds value by specifying the data type (UINT16), default value (0), and that it is per profile. This provides crucial context beyond the schema's generic range, guiding the agent to supply an appropriate unsigned 16-bit integer.

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 that the tool sets the 'setpoint width for pitch SPA attenuation ramp', specifying the exact parameter and its role. While it is distinguishable from siblings like set_spa_pitch_center, it does not explicitly differentiate itself.

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 mentions a prerequisite ('Requires: USE_WING'), which provides important context for when the tool is applicable. However, it lacks guidance on when to use this tool versus alternatives (e.g., other SPA-related setters).

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