get_battery_config

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds value by giving units (0.01 V, mAh) and identifying that battery_meter/current_meter are measurement sources, but it says nothing about whether values are live vs. stored defaults or what the response shape looks like.

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?

A single dense line with no filler; the key list is front-loaded and every token carries information. It is slightly cryptic (French prose mixed with English CLI names) but wastes nothing.

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?

With no output schema, the description carries the burden of describing what comes back, and it partially does so by listing the config keys and units. It still omits the overall return structure and gives no hint that set_battery_config is the write counterpart, leaving the agent with an incomplete picture.

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 tool takes zero parameters, so the baseline is 4. The description's enumeration of config keys and their units is extra value, though it describes returned fields rather than inputs, which is a completeness rather than parameter concern.

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 names the resource ("Config batterie") and enumerates the specific configuration keys it covers (vbat_min/warning/max_cell_voltage, bat_capacity, battery_meter, current_meter), which goes beyond the name. However, it never states a verb or explicitly says it retrieves/returns these values, and it does not distinguish itself from siblings like get_battery, get_battery_state, or set_battery_config.

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?

There is no when-to-use guidance, no mention of prerequisites, and no reference to alternatives. Given the crowded sibling set (get_battery, get_battery_state, get_voltage_meters, get_current_meters, set_battery_config), the agent gets no help deciding when this tool is the right one.

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