set_spa_roll_width

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

With no annotations, the description carries full burden. It reveals that the tool sets a configuration parameter, the data type (UINT16), default (0 per profile), and prerequisite. However, it does not disclose side effects, permission requirements, or whether changes take effect immediately or after reboot.

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 sentence with parenthetical notes. It is concise, front-loaded with the action, and every piece of information serves a purpose.

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 setter with one parameter and no output schema, the description is fairly complete: it explains the effect, prerequisite, and default. Could mention value validation or range limits, but it's adequate.

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 one parameter 'value' with generic description. The tool description adds meaning by explaining that this value sets the range over which attenuation ramps, clarifying the parameter's purpose beyond its name.

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 action (Set spa_roll_width) and explains its purpose: 'Setpoint range over which attenuation ramps from 0 to full (roll).' It is distinct from siblings like get_spa_roll_width.

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 includes a prerequisite ('Requires: USE_WING'), but does not provide guidance on when to use this tool vs alternatives or when not to use it. Sibling tools include many set_ parameters, but no direct alternative is mentioned.

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