skypilot_volume_ls

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

readOnlyHint=true already declares a safe read operation, so the description doesn't need to. It does add useful context: refresh=True queries cloud APIs for current state, with a performance cost. Missing details like return format or pagination are covered by the output schema.

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?

Two sentences: the first states the core action, the second explains the only parameter. No wasted words, front-loaded with the primary purpose.

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?

With an output schema present, return values needn't be described. The description covers the tool's action and the sole parameter's behavior completely. A brief mention of when to choose this over skypilot_storage_ls would make it fully complete.

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 description coverage is 0% for the single boolean parameter, so the description must compensate. It explains exactly what refresh does, its default implication, and the slower-but-fresher trade-off. It doesn't state the default value explicitly, but the schema's default=false covers that.

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 a clear verb+resource ('List all volumes') sufficient to distinguish it from siblings like skypilot_volume_apply and skypilot_volume_delete. However, no explicit contrast is drawn with skypilot_storage_ls, the closest neighbor, leaving minor ambiguity about volume vs. storage listing.

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 explains the refresh parameter's trade-off (slower but up-to-date), which implicitly advises when to use it. But it offers no guidance on when to use this tool versus skypilot_storage_ls or skypilot_volume_validate, leaving usage context only implied.

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