get_vbat_duration_for_warning

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

No annotations provided; description carries full burden. It explains the parameter's behavior (duration for warning alarm) and format (UINT8, 0–150, default: 0), and adds context that it prevents brief-spike false alarms. For a read-only getter, this is adequate.

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?

Extremely concise: a single sentence covering purpose and behavior, followed by inline format specification. No wasted words, front-loaded with key 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 getter with no output schema, the description fully covers the return value meaning, constraints, and purpose. No gaps remain—an agent can correctly interpret and invoke the tool.

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?

Input schema has no parameters (0). Baseline is 4. The description adds full meaning for the return value: explains what the value represents and its constraints (UINT8, range, default). This is excellent for a param-less tool.

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 explicitly states the tool retrieves a setting: 'Consecutive tenths-of-seconds the voltage must remain below the warning threshold before the warning alarm fires.' The verb 'Get' and resource 'vbat_duration_for_warning' are clear, and it is distinct from siblings like get_vbat_duration_for_critical.

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?

No explicit guidance on when to use this tool vs alternatives. While it's a simple getter, the description lacks 'when to use' or 'when not to use' advice. Useful context is provided about preventing false alarms, but no differentiation from other voltage-related getters.

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