get_spa_pitch_width

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

With no annotations provided, the description carries full burden. It indicates a read operation and lists a requirement ('USE_WING'), but it does not disclose preconditions, side effects, or output format beyond implying a simple return of the current value.

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 a single concise sentence with additional details in parentheses, conveying purpose, requirement, type, and default without unnecessary 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?

Given the tool's simplicity (no parameters, no output schema), the description adequately explains what the parameter is (setpoint width), its type, default, and a prerequisite. It does not elaborate on the return value but states it is a retrieval of a specific setting.

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?

There are zero parameters, and schema coverage is 100%. The description adds value by specifying the data type (UINT16), default value (0), and a note that the default is 'per profile', which aids the agent in understanding the nature of the configuration.

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 retrieves the 'spa_pitch_width' parameter defined as 'Setpoint width for pitch SPA attenuation ramp'. Although its purpose is clear, it does not differentiate from sibling tools like get_spa_pitch_center or get_spa_pitch_mode.

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 notes the requirement 'USE_WING' and provides type/default info, but it offers no guidance on when to use this tool versus alternatives. No when-to-use or when-not-to-use context is given.

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