crm_get_all_users

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

With no annotations provided, the description carries the burden of behavioral disclosure. It adds useful context about error recovery (e.g., trying different type filters, checking org user limits) and implies a read operation via the 'get' verb, but does not disclose return format, pagination, authorization requirements, or data volume. This is helpful but incomplete.

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 longer than typical but well-structured with clear headings (Prerequisites, Next Steps, Common Pattern, Error Recovery). Each section adds value by guiding the agent through a multi-step workflow. The main purpose is front-loaded, and while slightly verbose for a simple tool, the organization makes it 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?

For a tool with one optional parameter and no output schema, the description provides strong context: what it does, how it fits into a broader workflow, and error recovery. It falls short of being complete by not describing the response structure or fields returned, but for a list operation this level of detail is quite sufficient.

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 100%, with the parameter 'type' described as 'Optional type filter (AllUsers, AdminUsers, etc.)'. The description repeats this and provides examples but adds no additional semantics beyond the schema. Baseline 3 is appropriate since the schema already documents the parameter effectively.

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 function: 'Get all users in the organization with optional type filtering.' This is a specific verb+resource combination with scope. It distinguishes itself from sibling tools like crm_get_user_details and crm_create_user by focusing on the broad list operation.

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 includes explicit workflow guidance: 'Prerequisites: Use crm_get_all_profiles and crm_get_all_roles first' and 'Next Steps: Use crm_get_user_details...' This gives clear context on when and how to use the tool relative to alternatives, plus error recovery tips for troubleshooting, far exceeding basic usage guidance.

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