get_cluster_info

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

Describes the tool as 'real-time retrieval' with no side effects, and specifies return format (success: formatted info, failure: error message). With no annotations, the description adequately covers behavioral traits for a read-only operation, though it could mention freshness or auth expectations.

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?

Well-structured with clear sections and front-loaded purpose. A bit verbose with redundant items like 'formatted output for LLM automation', but still efficient and easy to parse.

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 (no params, output schema exists), the description provides complete context: purpose, usage scenarios, return format. Adequate for an agent to decide and invoke correctly.

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?

No parameters exist, so baseline is 4. The description adds no parameter information beyond the schema, but that is acceptable given zero parameters.

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?

Clearly states it retrieves basic information for an Ambari cluster, listing specific fields like name, version, provisioning state, and security type. Distinguishes from siblings by focusing on overall status vs. specific services or hosts.

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 'Required Usage Scenarios' with specific triggers (e.g., 'when users request cluster info, status, or summary'). Lacks exclusion criteria or alternative sibling mentions, but the guidance is clear and actionable.

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