ztw_list_ip_groups

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

The readOnlyHint annotation already establishes that the operation is read-only, and the description's 'Read-only' statement is redundant. It does add one meaningful behavior detail: 'search' performs a server-side substring match. However, it does not disclose pagination behavior, response shape, defaults, or any other operational traits beyond what annotations already imply.

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 short and front-loaded, with the main purpose in the first sentence. However, 'Read-only.' is already covered by the annotations and adds no new value, so it is slightly redundant rather than fully earning 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?

The tool is a simple read-only list with two optional parameters and an adequate description for basic usage. But given many closely related sibling list tools and no output schema, the description does not fully explain how this tool differs from the other IP group list variants or what the returned records look like.

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?

The 'query' parameter has a richly detailed schema description, while 'search' has none. The description compensates by explaining 'search' is a server-side substring match on the group name, which is essential parameter meaning not present in the schema. This gives real value for both parameters.

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 uses a specific verb and resource: 'List ZTW IP groups'. It clearly states the tool's core operation, but it does not distinguish it from closely related sibling tools such as ztw_list_ip_destination_groups, ztw_list_ip_source_groups, or the 'lite' variants.

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 given about when to use this tool versus alternatives. There is no mention of when to prefer this over ztw_list_ip_groups_lite, or how it compares to the destination/source IP group listers. The only context is the search parameter description, which does not address tool selection.

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