crm_get_user_details

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

No annotations exist, so the description carries the burden. It discloses error recovery behavior for missing users and hints at access checks, but does not specify return format, pagination, permission details, or rate limits. Some transparency is present, but key behavioral details are omitted.

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 organized with bold labels and every section provides workflow or error-recovery value. 'Next Steps' and 'Common Pattern' overlap somewhat, but the text remains compact and scannable.

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 one-parameter read-only tool, the description covers what data is returned (roles, profiles, permissions), prerequisite workflow, and error handling. There is no output schema, but the return scope is clearly indicated.

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 describes user_id as 'ID of the user' with 100% coverage. The description adds no further parameter-level semantics, so it relies on the schema—meeting the baseline of 3.

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 states 'Get detailed metadata for a specific user including roles, profiles, and permissions,' using a specific verb, resource, and content scope. This clearly distinguishes it from siblings like crm_get_all_users (list users) and crm_get_role_details (role-specific).

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?

Provides explicit prerequisites ('Use crm_get_all_users to identify target user_id'), next steps, and a common workflow pattern. It falls short of stating when-not-to-use or explicit alternatives, but the workflow context is clear.

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