set_vbat_scale

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

No annotations are provided, so the description carries full burden. It mentions calibration and a default value but fails to disclose potential effects, persistence, or prerequisites for this mutation tool.

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 (one short sentence plus inline notes) and front-loads the key information. However, it lacks structure, mixing purpose, instruction, and type info in a single line.

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 no output schema and no annotations, the description covers the calibration goal and default value but omits prerequisites, persistence, and any side effects. It is adequate for a simple parameter setter but not fully complete.

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 description is minimal ('Value for vbat_scale (UINT8)'). The tool description adds crucial context: the calibration process ('adjust until reported voltage matches a multimeter') and the default value (110), which aids correct parameter selection.

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 vbat_scale for voltage divider calibration, with a specific goal (adjust until multimeter matches). This distinguishes it from numerous sibling 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 implies use for calibration but does not specify when to use versus alternatives like set_vbat_divider or set_vbat_multiplier. No explicit exclusions or context provided.

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