pve_version

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

No annotations are provided, so the description carries the full burden. It implies a read-only operation ('Get'), which is safe, but does not disclose behavioral traits like authentication needs, rate limits, or what specific information is returned (e.g., API version number, compatibility details). It adds some context by specifying 'API version information' but lacks depth for a tool with no annotation support.

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, efficient sentence: 'Get Proxmox VE API version information'. It is front-loaded with the core action and resource, with zero wasted words, making it highly concise and well-structured for quick understanding.

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?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is adequate but minimal. It states what the tool does but does not explain the return format or potential use cases, leaving gaps in completeness for an agent that might need more context to interpret results effectively.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description does not add parameter semantics, which is acceptable here. A baseline of 4 is appropriate as it compensates for the lack of parameters by being straightforward, though it could briefly note the absence of inputs.

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 'Get Proxmox VE API version information' clearly states the verb 'Get' and the resource 'Proxmox VE API version information', making the purpose specific and understandable. However, it does not explicitly differentiate from sibling tools like 'pve_get_node_version', which might retrieve node-specific version details, leaving some ambiguity in sibling differentiation.

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 no guidance on when to use this tool versus alternatives, such as 'pve_get_node_version' for node-level version info or other API-related tools. It lacks explicit context, prerequisites, or exclusions, offering minimal usage direction beyond the basic purpose.

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