pve_metrics_server_list

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

With no annotations, the description carries the full burden. It discloses the read-only nature (no side effects) and the return format (list of dicts with id, type, server, port). This is adequate for a simple list operation, though it could mention authorization or scope.

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 consists of two short sentences. The first sentence instantly conveys the main action and read-only nature. Every word serves a purpose, with no redundancy or fluff.

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 description covers the essential aspects: it lists all definitions, returns structured dicts, and mentions example targets. Given the existence of an output schema, it doesn't need to describe return values in depth. However, it could clarify that the list respects the proximo_target parameter, which is a system-level parameter.

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 100% coverage for the only parameter (proximo_target), with description provided in the schema. The tool description adds no extra semantic meaning beyond what the schema already provides, earning the baseline score of 3.

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 'List all PVE metrics server definitions (read-only)', which is a specific verb and resource. It distinguishes from siblings like pve_metrics_server_delete and pve_metrics_server_set by emphasizing the read-only 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 description implies usage for viewing configurations but does not explicitly state when to use this tool versus alternatives like pve_metrics_server_set or pve_metrics_server_delete. No context about prerequisites or typical workflow is provided.

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