get_remaining_capacity

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint, openWorldHint. Description adds useful context about return structure (capacity_remaining_pct only at group level, per-dimension entries) and warm-up behavior. No contradictions.

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 main purpose, then details. Uses clear Args section. No wasted words. Appropriate 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?

No output schema; description explains return values in detail (capacity_remaining_pct, per-dimension entries with units) and warm-up period. Covers all needed context for a read-only query tool.

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?

Schema has 0% description coverage. Description provides clear explanations: resource_id is 'The resource UUID — a ClusterComputeResource or HostSystem (from list_resources).' target is 'Optional Aria Operations target name from config. Uses default if omitted.' Adds significant meaning.

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?

Description clearly states the tool gets remaining capacity headroom for a cluster or host. Uses specific verb 'get' and resource 'remaining capacity'. Distinguishes from siblings like get_capacity_overview and get_time_remaining.

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?

Explicitly provides when-to-use guidance: 'Use get_capacity_overview for the combined view, or get_time_remaining for projected days-until-full.' Also notes that values are None during warm-up.

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