wikijs_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 mentions 'Returns matching user profiles' but lacks details on pagination, case sensitivity, exact vs fuzzy matching, or rate limits. This leaves significant behavioral gaps for an AI agent.

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?

Two sentences with no fluff, directly stating the action and what is returned. Every word adds value.

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 no output schema, the description should clarify the return structure. It mentions 'matching user profiles' but not fields or pagination. For a simple search with one required parameter, it is minimally adequate but lacks completeness.

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 100% with parameter description 'Search query for user name or email.' The description adds 'Returns matching user profiles for collaboration context,' which provides output context but does not enhance parameter meaning beyond the schema. Baseline score of 3 is appropriate.

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 explicitly states the tool searches for users by name or email, distinguishing it from sibling tools like wikijs_search_pages and wikijs_search_tags. The specific verb 'Search for users' and resource 'users' make the 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 clearly indicates the tool's use case: finding users for collaboration context. While it doesn't explicitly state when not to use it or list alternatives, the context is clear enough for an agent to decide. Among siblings, no other tool searches users, so the usage is implicit.

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