get_realtime_data

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

Describes the operation as read-only ('Fetch', 'Retrieves'), lists error conditions, and provides return structure details. No annotations are present, so description covers the behavioral aspects well.

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?

Well-structured with summary, units, clear Args/Returns/Raises sections. Front-loaded with main purpose, no superfluous content.

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 single-parameter tool, the description fully covers input, output (detailed return structure), and error behavior, making it self-contained without needing an output schema.

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?

Clearly explains the parameter 'device_sn', including the distinction from WiFi dongle SN and the default environment variable. This adds significant value beyond the schema which lacks descriptions.

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 'Fetch real-time solar inverter data' with a specific data source. It distinguishes from the sibling tool 'set_battery_self_use_mode' which is a write operation.

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 like data source and default environment variable, but lacks explicit when-to-use or when-not-to-use guidance relative to siblings.

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