ha_get_history

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

Without annotations, the description carries full burden. It discloses the time range and default but omits whether the operation is read-only, any side effects, or authentication needs. The read-only nature is implied but not stated.

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 sentence with 12 words, front-loading the purpose and key parameter. No unnecessary information.

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, output schema, or sibling guidance, the description covers the basic purpose but lacks return format details, pagination, or permission context. It is minimally adequate for a simple retrieval 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?

With 0% schema coverage, the description adds meaning by linking 'entity' to entity_id and explaining the 'hours' parameter as the time range with a default. However, it does not explicitly state that entity_id is required or describe expected formats.

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 the tool retrieves state-change history for an entity over a configurable time range. The verb 'Get' and resource 'state-change history' are specific, and the default of 24 hours adds precision. This distinguishes it from siblings like ha_get_entity (current state) and ha_get_states (all current states).

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?

The description implies usage for historical data retrieval but does not explicitly indicate when to use this tool versus alternatives like ha_get_entity for current state. No exclusions or alternative names are mentioned.

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