jira_user_search

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

Despite no annotations, description discloses return format (YAML with fields), GDPR redaction of email, substring matching behavior, and limit defaults (0 for unlimited). Good behavioral transparency.

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?

Single paragraph, front-loaded with main action, no fluff. Could be slightly more structured, but concise and informative.

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 simple search tool with 2 params and no output schema, description covers all necessary context: search behavior, return fields, usage example, and limit details. 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 already covers both parameters (100% coverage). Description adds value by explaining substring matching, GDPR redaction, and limit behavior beyond schema descriptions.

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?

Description clearly states it searches JIRA users by display-name or email substring, with specific verb and resource. Distinguishes from sibling tools like jira_user_get and jira_search.

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 guidance to use returned account_id as input to jira_write assignee/reporter. Tips about alternate spellings for better matches. Could be more explicit about when not to use, but overall helpful.

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