list_users

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

The annotations already declare readOnlyHint=true, so the agent knows it's safe. The description adds that query filters by name substring, but does not disclose pagination behavior via offset/count or default behavior (e.g., whether it lists all users or only a subset). With annotations covering safety, a score of 3 is warranted for the limited additional context.

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 exceptionally concise with two sentences. The first sentence states the core purpose, and the second adds the most important parameter detail. Every word earns its place.

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 3 parameters and an output schema exists, the description is minimally adequate. It covers the key functionality (listing users with optional name filter) but lacks details on pagination, scope, and what constitutes a 'user list'. The presence of an output schema reduces the need for return value explanation, but behavioral gaps remain.

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 description coverage is 0%, so the description must compensate. It only explains the 'query' parameter partially (substring filter). The 'count' and 'offset' parameters are completely undocumented in both schema and description, leaving the agent to infer their meaning from names only.

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 lists users and mentions optional query filtering by name substring. However, it does not differentiate from sibling tools like 'get_user_info', which returns a single user, or other list tools. The verb 'list' and resource 'users' are specific, but scope is unclear.

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 guidance is provided on when to use this tool versus alternatives such as 'get_user_info' or other list tools. There is no mention of prerequisites, context (e.g., workspace vs. system users), or when not to use it.

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