set_ibatv_scale

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

Without annotations, the description discloses the data type, range, default, and a required build flag. It does not mention persistence or side effects, but the tool is a simple setter and the details given are adequate for a basic understanding.

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 additions; it is concise, front-loaded with the action, and every element adds value without redundancy.

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, the description is fairly complete. It covers purpose, constraints, default, and prerequisite. Missing detail on whether the setting takes effect immediately or requires a reboot, but still 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?

Schema coverage is 100%, and the description adds the default value (0) and the requirement (USE_VIRTUAL_CURRENT_METER), which are not in the schema. This adds meaningful context beyond the schema alone.

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 tool sets the scale of a virtual current sensor, distinguishing it from siblings like set_ibata_scale (actual current sensor) and set_ibatv_offset (offset).

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?

It provides a prerequisite (USE_VIRTUAL_CURRENT_METER) but does not explicitly exclude alternatives or give when-to-use versus siblings. The name and description imply the context for virtual sensors, which is clear enough for an agent.

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