confluence_user_search

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

No annotations are provided, so the description must cover behavioral traits. It states the search criteria and limit behavior, but does not disclose return format, pagination details beyond limit, authentication requirements, or potential rate limits. For a simple search tool, this is adequate but minimal.

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 consists of two short sentences, front-loading the purpose and then providing additional parameter detail. There is no redundant or extraneous information. Every sentence serves a clear purpose.

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 tool has only two parameters, no output schema, and no nested objects, the description provides the essential purpose and parameter behavior. However, it lacks information about the return value structure (e.g., list of user objects, fields included), which would be helpful for an agent invoking the tool.

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 describes both parameters with 100% coverage. The description adds value by clarifying the special behavior of 'limit=0' (unlimited results) and the default value of 25, which goes beyond the schema's 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?

The description clearly states the tool searches Confluence users by display name or email, which matches the tool name. However, it does not explicitly differentiate from the sibling tool confluence_user_get, which might retrieve a single user by ID. The verb 'search' and the resource 'Confluence users' are specific and 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 includes parameter behavior (limit of 0 returns all matches, default 25) and a reference to a CLI command, but it does not provide guidance on when to use this tool versus alternatives like confluence_user_get or jira_user_search. No 'when to use' or 'when not to use' context is given.

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