Get HA configuration

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

Annotations already assert readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so the safety profile is covered. The description adds the concrete HTTP endpoint, the raw return field list, and the specific error class (httpx.HTTPStatusError), which goes beyond the annotation surface. It does not mention rate limits or auth requirements, so it falls short of a 5.

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?

Front-loaded with the purpose, then endpoint, then when-to-use, when-not-to, returns, and errors in labeled blocks. Every sentence carries information and no filler is present.

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?

Although an output schema exists, the description still gives the agent the key return field names plus the failure mode (HTTPStatusError), and it pre-empts the obvious wrong-tool choices. For a no-param read tool in a crowded namespace, nothing material 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?

There are zero parameters, which is the baseline-4 case. The description correctly implies the tool takes no input by describing the call as a parameterless GET and focusing entirely on returns and errors.

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 and resource ('Get Home Assistant's current configuration') and spells out exactly what that payload contains (location, unit system, HA version, loaded components). The API endpoint is named, making the underlying resource unambiguous even among dozens of config-related siblings.

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 explicit 'Use when' criteria (version/location/unit system/components needed) and 'Not for' exclusions that name two concrete alternatives, ws_get_config and system_get_system_health. This is exactly the routing guidance an agent needs to disambiguate among the ws_* and system_* siblings.

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