zpa_list_service_edges

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

The description adds minimal behavioral context beyond the existing `readOnlyHint` annotation. It does not disclose pagination behavior, rate limits, or any other operational traits that would help the agent understand side effects or scope.

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 concise at two sentences, with the first sentence establishing purpose and the second differentiating from a sibling. Every sentence serves a clear function.

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 5 parameters including pagination and filtering, no output schema, and only a readOnlyHint annotation, the description is insufficient. It omits details about how to use `page`, `page_size`, `search`, and what the response structure looks 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?

With only 20% schema description coverage (only the `query` parameter has a description), the description does not mention any parameters or add meaning to the ones lacking documentation. It fails to compensate for the low coverage.

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 verb 'List' and the resource 'ZPA Service Edges' with a specific focus on 'health/status'. It also distinguishes from the sibling `zpa_list_service_edge_groups`, which is the parent group resource.

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 explicitly distinguishes from the sibling tool `zpa_list_service_edge_groups`, guiding the agent on when to use this tool vs the parent group listing. However, it does not provide information about when not to use this tool or other contextual alternatives.

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