pve_group_get

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

Explicitly states read-only and returns specific fields. No annotations provided, so description carries burden. Lacks explicit statement of idempotency or safety, but 'read-only' implies no side effects.

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?

Two sentences: first states purpose and output, second gives usage guidelines. No wasted words, highly efficient.

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?

With output schema present, description adequately covers return values. Mentions key fields. Could mention error handling for missing groupid, but not critical for a read-only get.

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 coverage is 100% (both parameters described). Description only adds that the groupid identifies the group and that output includes groupid, comment, member list. Does not add significant meaning beyond 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?

Clearly states verb 'Get', resource 'a group's full config', and is explicitly read-only. Differentiates from sibling tools pve_group_create/update/delete and pve_acl_list.

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?

Explicitly tells when to use this tool (read config) and when to use alternatives: pve_group_create/update/delete for management, pve_acl_list for ACL entries. Provides clear context.

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