jira_users_search

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

Annotations already provide readOnlyHint=true. The description adds the return structure '{total, users: [{account_id, display_name, email, active}]}' which helps the agent understand output. No mention of edge cases or pagination, but adequate.

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?

Three sentences, front-loaded with purpose, then usage, then return format. No unnecessary words. Very 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?

Tool is simple (2 params, no nested objects) and description covers purpose, usage, and return structure. With output schema helping, this is complete.

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%. For the query parameter, description adds examples ('jane.doe@example.com', 'Jane', 'jdoe'), adding meaningful context beyond schema. For max_results, it confirms defaults but doesn't add new info; still helpful.

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 'Search for Jira users by email or display name' with a specific verb and resource. It also distinguishes from the sibling tool jira_users_get by specifying a different input (already having account_id).

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?

Explicitly says when to use ('Always use this to look up a user's account_id before adding them to groups or assigning issues') and when not to use with a named alternative ('Not this when you already have the account_id: use jira_users_get instead').

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