splunk_get_storage_usage

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

No annotations are provided, so the description carries the whole burden; 'Inspect' implies a read-only operation, which is useful, and it scopes the data to partitions, $SPLUNK_DB volume and retention. It does not disclose cost/freshness of the collection, permission requirements, or whether the check is local-only versus cluster-wide.

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?

A single front-loaded sentence that names all three scopes with no filler. Every clause 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?

With no parameters and an output schema present, the description needn't explain return values, so the remaining burden is small. It adequately covers the three inspection targets, though a note on read-only nature and freshness would close the last gap given the lack of annotations.

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?

Zero parameters, so there is nothing to disambiguate and the baseline of 4 applies. The description adds nothing misleading about invocation.

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?

States a specific verb ('Inspect') and names concrete resources: filesystem disk partitions, the $SPLUNK_DB storage volume, and retention capacities. This is distinguishable from capacity-adjacent siblings such as splunk_get_license_usage or splunk_index_stats, though it never explicitly contrasts itself with them.

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 says only what is inspected, never when to reach for this tool versus splunk_get_server_health, splunk_index_stats, or splunk_get_license_usage when investigating disk pressure. No prerequisite conditions, no exclusions, no alternative routing.

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