zid_get_user_groups_by_name

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

The description states 'Read-only' which matches the annotation readOnlyHint=true and adds details beyond it: case-insensitive partial matching, resolution precedence (email if '@' present, else login then display name), and 'first matching user' behavior. It also specifies that output is 'lean group summaries,' providing useful context. No contradictions with annotations.

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 two sentences, front-loaded with the purpose, and packed with relevant behavioral details. Every sentence earns its place; no redundant or vague wording.

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?

The tool has 4 parameters and no output schema. The description explains the core resolution logic and indicates output type ('lean group summaries'), but pagination behavior and exact return fields are not described. For a read-only list tool, this is reasonably complete, though a bit more detail on output structure would help.

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 low (25%), with only 'query' having a description. The tool description adds meaning to the key 'name' parameter (how it is matched and resolved), but limit and offset are not elaborated. These are conventional pagination parameters, but the description does not explicitly tie them to API behavior. The query parameter's rich description in the schema helps compensate.

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's function: 'List a ZIdentity user's group memberships, resolving the user by name.' The verb ('List'), resource ('group memberships'), and scope ('by name') are explicit, distinguishing it from siblings like zid_get_user_groups (likely by ID) and zid_get_group_users_by_name (reverse relationship).

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 provides clear context for when to use this tool: when you need a user's group memberships and only have a name, with specific resolution order (email, login, display name). However, it does not explicitly state when not to use it (e.g., if you already have the user ID, use zid_get_user_groups instead), so it lacks an explicit exclusion.

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