proxmox-api-schema

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

Annotations already declare readOnlyHint and idempotentHint, so the bar for added behavioral disclosure is lower. The description adds context by explaining the three levels of output detail and that it reads from the OpenAPI spec, which goes beyond the annotations.

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 sentences with no filler. The purpose is front-loaded and the usage modes are summarized in a compact, scannable second sentence.

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?

For a read-only discovery tool with three all-optional parameters, the description covers the important call variants without needing to describe an output schema. It lacks explicit mention of sibling alternatives, but this is not essential for using the tool correctly.

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 description coverage is 100%, so the schema already documents tag, path, and method. The description adds meaningful semantics by mapping argument combinations to output granularity: no args → tag summary, tag → operations, path → full details, which is not fully captured in the schema.

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 states a specific verb ('Discover') and resource ('Proxmox VE API operations and their parameters from the OpenAPI spec'), which clearly identifies what the tool does. It also distinguishes itself from execution-focused siblings by framing itself as a discovery/schema-exploration tool.

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 gives explicit invocation guidance: no args for a tag summary, tag for operation lists, and path for full parameter details. It does not explicitly name alternatives or state when not to use this tool, but the usage modes are clear enough for an agent to call it correctly.

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