search_users

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

No annotations are provided, so the description must disclose behavioral traits. It merely says 'search' without mentioning whether it's read-only, permissions needed, or any side effects. The presence of an output schema partially compensates for return format, but overall transparency is low.

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 the purpose stated in the first sentence. It uses a clear docstring format with brief parameter descriptions. No unnecessary words.

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?

Given the simplicity of a user search and the presence of an output schema, the description covers the main purpose. However, it lacks details on search behavior (e.g., case sensitivity, partial matching) and pagination beyond max_results, leaving some gaps for an agent.

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 0%, so the description must add meaning. It explains query as 'search string', max_results as 'max results (default: 20)', and instance as 'YouTrack instance (optional)'. This provides basic context but lacks detailed format or constraints beyond what the schema's title implies.

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 it searches YouTrack users by name or login, providing a specific verb and resource. It distinguishes from sibling tools like search_issues or search_articles by targeting users.

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 implies the tool is for finding users by name or login, but does not explicitly state when to use it over alternatives or provide any exclusion criteria. Context is clear but lacks when-not guidance.

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