Get Users

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive behavior, so the description's safety profile is covered. However, the description adds no behavioral context beyond 'search', such as pagination, sorting, or result structure, which would be helpful.

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 extremely short (two words), which is under-specified for a tool with 7 parameters and complex search/filter capabilities. It lacks structure and fails to earn its place as a useful guide.

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's complexity (7 parameters, no output schema) and minimal annotations, the description is severely incomplete. It does not explain that it returns a list of users, how filtering works, or any prerequisites.

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?

With 0% schema description coverage and 7 parameters, the description fails to add any meaning to the parameters. The phrase 'Search users.' gives no clue about how to use parameters like 'search', 'username', or 'active'.

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 'Search users.' provides a verb and resource but is essentially a tautology of the tool name 'gitlab_get_users'. It does not distinguish the tool from siblings like 'gitlab_get_user' or 'gitlab_whoami', offering no unique scope or context.

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?

No usage guidelines are provided. The description does not specify when to use this tool versus alternatives, such as when a single user vs. list is needed, or how it differs from 'gitlab_get_user'.

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