pve_user_get

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 states the tool is read-only, which is key, and lists the returned data. However, it does not mention required permissions or rate limits. This is adequate but not comprehensive.

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, each serving a clear purpose. It is front-loaded with the primary purpose and efficiently provides alternatives. No redundant information.

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 presence of an output schema (not shown but noted), the description does not need to detail return values. It covers the purpose, read-only nature, and alternatives. It lacks permission prerequisites, but for a read-only get tool, this is still quite 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?

Schema description coverage is 50% (userid has only a title, proximo_target has a full description). The description does not add any parameter-specific information beyond what is in the schema. Baseline is 3 with moderate coverage, and no extra value is added.

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 verb ('Get'), the resource ('user config'), and specifies it's read-only. It lists the returned fields and distinguishes from sibling tools like pve_user_create/update/delete (mutations) and pve_acl_list (permissions).

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 mentions when to use alternatives: 'Use pve_user_create/update/delete to modify the user; use pve_acl_list to see their effective permissions.' This provides clear context for different tasks, though it doesn't include when to use this tool over others more broadly.

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