openstack_list_hypervisors

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

With no annotations, the description carries the full burden. It mentions 'with resource stats' which hints at the output, but it fails to explain why a required 'device_id' is needed for a list operation. This is a significant behavioral gap; it does not disclose whether the tool lists all hypervisors or only those associated with a specific device, nor does it mention any read-only nature or limitations.

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 a single, concise sentence (7 words) that front-loads the core action. Every word contributes to the meaning, with no unnecessary elaboration.

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?

As a simple list tool without an output schema, the description must clarify what the tool returns and why it requires a device_id. The phrase 'with resource stats' touches on output but leaves the mandatory parameter unexplained. This ambiguity makes the description incomplete for successful invocation.

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 100% coverage with the device_id description 'OpenStack device ID', but both the schema and description are vague about the parameter's role. The description does not clarify why device_id is required for listing hypervisors, so it adds no meaningful value beyond the schema.

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 'List hypervisors in OpenStack with resource stats' clearly states the action (list) and the resource (hypervisors in OpenStack), adding a specific detail (resource stats). It distinguishes the tool from other OpenStack list tools such as openstack_list_servers and openstack_list_flavors.

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 usage is implied by the name and description: it is for listing hypervisors, which is distinct from other sibling OpenStack tools. However, the description does not explicitly state when to choose this over alternatives, nor does it mention any prerequisites or exclusions.

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