solar_battery

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

Description implies a read-only operation with 'Real-time data' and lists return fields, but does not explicitly state non-destructive nature, authentication needs, or rate limits. Annotations are absent, so description carries the burden.

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?

Two sentences effectively convey purpose and return data without redundancy. No unnecessary words.

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 annotations or output schema, the description sufficiently explains the tool's function and the data it returns. Lacks mention of potential limitations or prerequisites, but adequate for a simple read 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?

The tool has no parameters and schema coverage is 100%, so no additional parameter info is needed. Description adds value with field details but is not required; baseline score of 4 is appropriate.

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 provides real-time data from the BYD Battery-Box Premium HV, distinguishing it from sibling tools like configure_inverter, solar_devices, solar_meter, and solar_power_flow.

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 guidance on when to use this tool versus alternatives, e.g., for specific battery metrics vs. overall system status. The description only lists data fields without context.

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