Listing users

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

Adds permission context beyond annotations, stating 'Perm: view_users'. Also confirms read-only behavior aligning with readOnlyHint. No contradictions.

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?

Very concise, with main action front-loaded. The first sentence is somewhat redundant with the title, but overall efficient with no unnecessary text.

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?

Describes basic function and required permission, but does not mention optional filtering or pagination parameters. Output schema exists, so return format is covered, but the description could be more complete for a listing tool with many options.

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%, so baseline is 3. Description does not add additional meaning to any parameter beyond what the schema already provides.

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 it gets a list of users within the current enterprise, distinguishing from sibling get_user which retrieves a single user. However, no explicit differentiation from other listing tools.

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?

Only mentions permission required (view_users) but does not provide guidance on when to use this tool versus alternatives like action1_get_user or action1_create_user.

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