set_ibatv_offset

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

Discloses the requirement for USE_VIRTUAL_CURRENT_METER, implying it may fail if not enabled. However, lacks details on side effects, persistence, or need for reboot. No annotations to rely on.

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?

Single line with all essential information: purpose, prerequisite, type, range, and default. No 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?

For a simple setter with one parameter and no output schema, the description covers prerequisites, value constraints, and default. Missing info on return value (e.g., success indication) but acceptable.

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%, so baseline is 3. Description adds default value (0) not present in schema, providing extra context. Also repeats range and type for clarity.

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?

Description clearly states it sets the ibatv_offset (virtual current sensor voltage offset). Includes prerequisite and value range. Very specific and distinct among siblings.

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?

Specifies a prerequisite (USE_VIRTUAL_CURRENT_METER) but does not provide guidance on when to use this tool vs other set_* tools like set_ibata_offset. No alternatives mentioned.

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