get_ha_group

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

With no annotations, the description must convey behavioral traits. It implies a read operation but does not disclose any side effects, permissions needed, or error behavior. The minimal description leaves uncertainty about what 'configuration' entails.

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?

The description is brief with a clear header and argument list. However, it is too terse, providing just the bare minimum without additional helpful context that could fit in a similar length.

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 the tool's simplicity and the presence of an output schema, the description is partially adequate but fails to provide sufficient context for an agent to select it among many sibling tools. No information about HA groups or when to retrieve configuration is given.

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?

The schema has 0% description coverage for the single parameter 'group'. The description adds 'group: Group ID', which minimally clarifies the parameter but lacks details on format, allowed values, or relationship to other resources.

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 states 'Get HA group configuration', clearly indicating the verb and resource. It distinguishes from sibling tools like 'list_ha_groups' and 'get_ha_resource' by specifying the resource type (HA group) and action (get).

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?

No guidance is provided on when to use this tool versus alternatives such as 'get_ha_resource' or 'list_ha_groups'. There is no mention of prerequisites, context of use, or when-not-to-use.

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