Clear system log

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

Annotations already declare destructiveHint=true, but the description goes further by scoping the destruction ('structured error store', explicitly NOT home-assistant.log on disk) and stating a prerequisite ('Requires HA_ALLOW_WRITE=true in direct mode'). This is meaningful added context beyond the annotations.

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?

Three tight sentences, front-loaded with the action and then the rationale; every sentence carries distinct information (what it empties, why, what it does not touch, and the required flag).

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 destructive no-arg mutation with no output schema, the description covers scope of effect, prerequisites, the companion read tool, and the non-effect on disk logs. Nothing an agent needs to invoke it safely is missing.

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 description coverage is 100% and the single optional instance_id parameter is fully documented in the schema, including the refusal behavior on home mismatch. The description adds nothing about the parameter, so baseline 3 applies.

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?

States a specific verb+resource ('Empty Home Assistant's structured error store') and immediately distinguishes itself from its sibling by naming ha_get_system_log and the relationship between them. An agent can tell it apart from ha_get_error_log/ha_get_supervisor_log without opening any schema.

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?

Explicitly describes the intended workflow ('clear, reproduce the problem, then ha_get_system_log shows only what your reproduction caused'), which is exactly the when-to-use condition. It also names the alternative tool and clarifies the boundary (does not touch the on-disk log).

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