get_instance_details

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

The description discloses pagination support, configurable limits, and warns about include_all in large environments. No annotations provided, so this is helpful. It does not explicitly state it is read-only, but that's implied.

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 structured but includes a bullet list of functions that is somewhat redundant; the core information could be conveyed in fewer words. Still, it is not overly long.

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 complexity (6 params, many siblings, output schema exists), the description covers purpose, usage, parameters, and return type. It is missing explicit guidance on when to choose this over similar sibling tools.

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?

All 6 parameters are explained in the Args section with descriptions that add meaning beyond the schema. For example, explaining comma-separated lists and the behavior of all_instances and include_all.

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 it provides detailed information for OpenStack instances with specific aspects listed (name, ID, status, etc.), making the purpose clear. However, it does not explicitly differentiate from siblings like get_instance or search_instances, which also provide instance details.

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 includes a use case statement ('Use when user requests specific instance information...'), but does not provide guidance on when not to use it or mention alternatives among the many sibling tools.

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