set_ibata_scale

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 persistence, side effects, or whether a reboot is required. The act of setting a parameter implies mutation, but without further details, transparency is limited.

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 with two sentences: the first states the purpose and units, the second provides a usage hint, and a bracketed segment adds range/default. No superfluous information.

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 one-parameter setter, the description covers the parameter's meaning, units, range, and default. It is nearly complete but lacks explanation of how the setting takes effect (e.g., immediate vs. after reboot), which would be useful.

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 (single integer 'value' with range). The description adds significant value by explaining the unit (mV/A × 10), the need for calibration, and the default value (558), providing context beyond the schema's range.

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') and the resource ('ibata_scale'), specifying it as the ADC current sensor scale factor with units (mV/A × 10). It distinguishes itself from siblings like 'get_ibata_scale' and other set tools.

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 calibration hint ('Calibrate against a known load'), implying usage in calibration scenarios. However, it lacks explicit guidance on when not to use the tool or alternatives, leaving usage context somewhat implied.

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