confluence_user_search

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

Discloses that limit=0 returns all matches and that the tool mirrors a command-line utility. No annotations exist, but the description covers key behavior. However, it omits mention of read-only nature and return format.

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?

Extremely concise: two sentences with no filler. The first sentence states purpose, the second adds parameter nuance and context.

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?

No output schema is provided, and the description does not mention the return type or fields. For a search tool, this is a gap. The description is adequate but incomplete.

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 schema already has 100% coverage. The description adds value by explaining 'by display name or email' and the special case of limit=0, beyond the schema's default description.

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 'Search Confluence users by display name or email', specifying the action and resource. Distinguished from siblings like 'confluence_search' (content search) and 'jira_user_search' (Jira 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?

Describes limit behavior and notes its CLI equivalent ('omni-dev atlassian confluence user search'). While it provides context, it does not explicitly state when not to use this tool or compare with alternatives directly.

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