pve_get_vm_rrddata

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

There are no annotations, so the description carries the full burden. It only lists metric categories and says 'over time' without explaining output format, timeframe handling, aggregation, or that it is a read-only operation. This is insufficient to predict behavior beyond a vague sense of returned data.

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?

One short sentence, front-loaded with the core purpose. No fluff or redundancy.

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 has an output schema, so return values are likely specified there, but the description omits any guidance on the required/variable parameters. An agent cannot correctly choose a timeframe or know that vm_name is mandatory from the description alone. The description is too sparse to fully support tool invocation.

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 coverage is 0%: neither vm_name nor timeframe is described in the description. The mention of 'over time' vaguely alludes to the timeframe concept but does not map to the parameter or explain its options/default. The description does not compensate for the schema's lack of parameter documentation.

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 returns historical performance metrics for a VM, listing specific metric types (CPU, RAM, net I/O, disk I/O) and emphasizing the time dimension. This differentiates it from sibling tools like pve_get_node_rrddata (node metrics) and pve_get_vm_status (current status).

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 the tool (when you need historical VM metrics) but does not explicitly state alternatives or conditions where other tools would be preferred. It gives clear context but no exclusions.

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