zid_get_user_groups_by_name

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

The description redundantly states '(read-only)' which is already provided by the 'readOnlyHint' annotation. It does not disclose any other behavioral traits such as pagination behavior or required permissions, beyond what annotations already cover.

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 a single, clear sentence with no extraneous words. It front-loads the essential information and is perfectly concise.

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 presence of an output schema and annotations, the description is adequate for a simple read tool. It could be improved by mentioning that 'query_params' supports pagination, but this is already in the schema.

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?

All parameters are described in the input schema (100% coverage), so the description adds no additional meaning. The baseline score of 3 is appropriate as the schema does the heavy lifting.

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 action 'Get', the resource 'groups for a ZIdentity user', and the method 'by username'. It distinguishes from sibling tools like 'zid_get_user_groups' (presumably by ID) and 'zid_get_group_users_by_name' (reverse operation). The read-only qualifier adds specificity.

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 (by username) for when to use this tool, but it does not explicitly state when not to use it or mention alternatives. The sibling tool list helps, but the description itself does not guide away from other tools.

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