proxmox_find

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

No annotations are provided, so the description bears full responsibility. It discloses partial match support and the return fields (vmid, node, type). It implicitly signals a read-only operation without explicit side effect notes. Additional clarity on error behavior or authentication requirements would improve transparency, but the description is adequate.

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 three sentences long, front-loads the action and resource, and contains no redundant information. Every sentence contributes value.

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 (single parameter, no annotations, output schema exists), the description covers all essential aspects: what it does, how it matches (partial), and what it returns. The presence of an output schema relieves the description from detailing return structure.

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 schema has 0% description coverage for parameters, so the description must add meaning. It does so by explaining that the name parameter supports partial matches, which is a critical usage detail not evident from the schema alone. This fully compensates for the lack of schema 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?

The description clearly states the action (find), the resource (VM or container), the method (by name with partial match), and the output (vmid, node, type). It distinguishes from sibling tools which are all action-oriented, making its lookup purpose obvious.

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 explicitly positions the tool as useful before running admin actions, implying it is a prerequisite. While it does not elaborate on when not to use or alternative lookup methods, the context of sibling action tools provides sufficient guidance for typical use cases.

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