jira_find_users

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

With no annotations, the description carries the full burden. It discloses a key behavioral nuance: Jira Cloud v3 requires accountId instead of usernames/emails, and this tool performs the resolution. It does not detail the exact response structure or pagination, but the essential behavior is well communicated.

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 concise with two sentences, front-loaded with the purpose and immediately followed by the important usage note. The included API doc link is a useful addition without bloating the 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?

The description effectively positions the tool as a prerequisite step within the Jira workflow, explains why it is necessary, and provides an API reference. Given the simple schema and clear output implication (resolving to accountId), it is contextually complete even without an output schema.

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 already provides complete descriptions for both parameters (query and maxResults), covering 100% of parameter semantics. The description adds context about accountId but does not significantly extend parameter-level meaning beyond what the schema offers.

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 searches for Jira users by display name, username, or email address. This is a specific verb and resource, and it is distinct from sibling tools that focus on issues and metadata, making its purpose 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 explicitly instructs that this tool MUST be run first to resolve a user's display name or email to their accountId before using assignee/reporter fields in Jira Cloud v3. This provides clear when-to-use guidance and ties directly into the workflow of sibling tools like jira_create_issue.

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