get_vbat_sag_compensation

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

No annotations provided, so description fully explains behavior: compensatory effect, recommended target, and required setup. For a read-only tool, this is sufficient transparency.

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?

Concise 3-sentence description that efficiently conveys purpose, recommendation, and requirements. Could be structured more but is well-sized.

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?

Despite no output schema or annotations, the description provides enough context: what it does, the meaning of the value, a recommended setting, and prerequisites. Completely covers a simple getter 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?

No parameters in schema (100% coverage). The description adds value by noting the returned value type, range (0-150), and default (0), which goes beyond schema.

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 it retrieves the vbat_sag_compensation setting, explaining its function of compensating for battery voltage sag to maintain PID authority and throttle output. It distinguishes from the sibling set_vbat_sag_compensation tool.

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?

Provides context on when to use (to check the setting), recommends a target value of 90%, and notes prerequisites like cell voltage monitoring and OSD warning configuration. No explicit alternative getter exists, so guidance is adequate.

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