vaillant_get_devices

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

No annotations provided; description compensates by declaring the tool is static and read-only, which are key behavioral traits. However, lacks details on auth requirements or potential errors.

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?

Single sentence with clear list of included data. Front-loaded with core purpose. 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, no output schema, and 1 undocumented parameter, the description provides a high-level overview but lacks completeness on parameter semantics and return format. Adequate for a simple read-only tool but has gaps.

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?

Schema has one parameter (system_id) with 0% description coverage. The tool description does not explain what system_id is, its format, or how to obtain it, leaving the parameter entirely undocumented.

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 clearly states it provides static hardware inventory including specific components, and notes it's read-only. Distinct from siblings (diagnostics, energy report, status).

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?

Implicitly useful for retrieving hardware details, but no explicit when-to-use/when-not-to-use guidance or comparison with siblings.

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