crm_get_role_details

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. It mentions that the tool retrieves permissions and hierarchy and includes error recovery for missing role_id, but it does not explicitly state that it is a read-only operation, nor does it describe the return format, pagination, or any access requirements. This is adequate but has clear gaps.

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 well-structured with a clear one-sentence summary followed by concise sections (Prerequisites, Next Steps, Common Pattern, Error Recovery). Each section is focused and adds valuable context without redundancy. The structured format makes it easy to scan and understand.

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 simple single-parameter tool with no output schema, the description is quite complete. It covers the workflow context, prerequisites, next steps, and error handling. The only missing element is a description of the return value structure, but given that the output schema is absent, the description's coverage is strong for the tool's simplicity.

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 already provides 100% coverage for the sole parameter role_id with a description. The description adds value by explaining how to obtain the role_id (via crm_get_all_roles), but this is a minor addition. The baseline of 3 is appropriate since the schema handles the parameter semantics well, and the description offers slight guidance without overexplaining.

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 tool's purpose: 'Get detailed metadata for a specific role including permissions and hierarchy.' This distinguishes it from sibling tools like crm_get_all_roles (list all roles) and crm_update_role (modify roles). The verb and resource are specific and unambiguous.

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 explicit usage guidance: prerequisites (use crm_get_all_roles to identify role_id), next steps (use crm_get_all_users, crm_get_all_profiles, crm_update_role), and a common pattern. It also includes error recovery steps, making it clear when and how to use this tool relative to alternatives.

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