pve_get_role

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

With no annotations provided, the description carries the full burden of behavioral disclosure. 'Get role configuration' implies a read-only operation, but it doesn't specify whether this requires authentication, what format the configuration data returns in, whether there are rate limits, or what happens if the role doesn't exist. The description provides minimal behavioral context beyond the basic operation.

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 extremely concise at just three words. It's front-loaded with the essential information (get role configuration) with zero wasted words or unnecessary elaboration. This is an excellent example of conciseness for a simple retrieval operation.

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 that there's no output schema and no annotations, the description is incomplete for helping an agent understand what to expect. While the tool appears simple (one parameter, read operation), the description doesn't explain what 'role configuration' includes, what format it returns, or any error conditions. For a tool with no structured output documentation, the description should provide more context about the return value.

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% description coverage (the 'roleid' parameter is documented as 'Role ID'), so the baseline is 3. The description doesn't add any additional meaning about the parameter beyond what the schema already provides - it doesn't explain what constitutes a valid role ID or where to find role IDs.

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 'Get role configuration' clearly states the action (get) and resource (role configuration), which is a specific verb+resource combination. However, it doesn't distinguish this tool from other 'get' tools in the sibling list (like pve_get_user, pve_get_group, etc.), leaving the purpose somewhat vague about what makes this particular 'get' operation unique.

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 provides no guidance on when to use this tool versus alternatives. There are many sibling tools for retrieving different types of configurations (users, groups, VMs, etc.), but the description doesn't indicate when role configuration specifically is needed or what prerequisites might exist for using this tool.

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