qnap_resource_usage

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

With no annotations, the description must carry the full burden of behavioral disclosure. It simply says 'Get' which implies a read-only operation, but it does not mention return format, units, permissions, or any side effects. This is minimal disclosure for a tool that accesses system metrics.

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?

The description is a single, front-loaded sentence that states the action and target without any fluff or repetition. It earns its place by conveying the essential 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?

The tool is simple, with one parameter and no output schema. The description names the resource categories (CPU, memory, disk) but does not specify whether the output is percentages, raw values, or a snapshot vs. historical data. This leaves some ambiguity for the agent, though the core functionality is clear.

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 schema already describes the only parameter (device_id) as 'QNAP NAS device ID' (100% coverage). The description adds the context that the usage is from QNAP NAS, but it does not provide additional parameter-specific details beyond the schema baseline.

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 the action ('Get') and the specific resource ('CPU, memory, and disk usage from QNAP NAS'). It distinguishes this tool from sibling QNAP tools like qnap_system_info or qnap_get_volumes by focusing on resource usage metrics.

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 implies when to use this tool (when you need CPU, memory, or disk usage metrics), but it does not explicitly contrast with alternatives such as qnap_system_info or qnap_get_disks. No exclusions or alternative tool names are provided.

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