analyze_storage

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

The description adds platform-specific behavior beyond the readOnlyHint annotation, explaining that cache_stats is SUSE-only. It also clarifies that disk_usage checks 'critical paths,' giving context without contradicting the read-only annotation.

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?

Three concise sentences front-load the core purpose, list actions with inline details, and end with platform constraints. No wasted words; every sentence earns its place.

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?

For a simple tool with one enum parameter and no output schema, the description covers purpose, actions, and platform compatibility. It doesn't mention return format, but the tool's scope is small enough that this is acceptable.

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 description enriches the enum parameter by explaining each value: disk_usage 'check disk space for critical paths' and cache_stats 'analyze zypp package cache.' This goes beyond the schema's generic 'Analysis type to perform' description.

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 'Unified storage analysis tool' and lists two specific actions (disk_usage, cache_stats) with brief explanations. This specific verb+resource scope distinguishes it from sibling package management and system diagnosis tools.

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 provides explicit platform usage guidance: 'Works on any system for disk_usage, SUSE only for cache_stats.' This tells the agent when each action is applicable, though it doesn't mention alternative tools or exclusions.

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