pve_get_cluster_resources

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

With no annotations, the description introduces the key behavior of returning all cluster resources in a single call and suggests performance ('Fast'). It does not explicitly state that the operation is read-only or that results can be filtered by the 'type' parameter, which limits full transparency.

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 two brief, front-loaded sentences. Every word contributes: 'all cluster resources' defines scope, 'in one bulk call' conveys efficiency, and the resource list adds concreteness. 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 is simple, and the presence of an output schema reduces the need to explain return values. However, the description omits the optional 'type' parameter that controls filtering, which would be useful for an agent deciding whether to use this bulk tool vs a specific resource tool. Overall it is acceptable but not 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?

The description lists resource types that loosely correspond to the enum values (vm, node, storage) but does not explain the 'type' parameter as a filter. It also introduces 'LXC' as a separate category when the schema treats LXC as a VM subtype, and omits 'sdn' entirely. The schema's enum lacks descriptions, so the description needed to compensate but does so incompletely.

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 tool's function: 'All cluster resources in one bulk call' and enumerates the included resource types (VMs, nodes, storage, LXC). This distinguishes it from sibling tools like pve_get_nodes or pve_list_vms by emphasizing the aggregate, bulk nature.

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 phrase 'one bulk call' and 'Fast overview' clearly imply when this tool should be used: when a broad, multi-resource snapshot is needed quickly, contrasting with the more specific sibling tools. However, it does not explicitly list alternative tools or state when not to use it.

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