list_segments

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

Annotations already declare readOnly, idempotent, non-destructive, open-world. The description adds valuable behavioral context: the exact result envelope shape, the meaning of `truncated`, and the warning to check it before treating the result as complete. This goes well beyond what annotations alone provide.

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?

Well-structured and front-loaded: first sentence states purpose, then result envelope, then usage guidance, then Args. Every sentence carries useful information—the envelope details are dense but necessary since there's no output schema.

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?

For a list tool with no output schema, the description fully compensates: it explains the return shape, truncation semantics, and how to proceed to related tools (get_segment, get_logical_port_status). It also handles all parameter semantics with a single simple arg, making it complete for agent use.

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 0%, but the description explicitly documents the only parameter: 'target: NSX Manager target from config (default if omitted).' This adds practical meaning beyond the schema's type/default by explaining its source and default behavior.

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 opens with '[READ] List all NSX network segments' — a specific verb, resource, and listed output fields (type, subnet, admin state, port count). It clearly differentiates from get_segment and other list tools like list_ip_pools.

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?

Explicitly states workflow: 'Use this first to resolve a segment_id, then get_segment for its ports and linked gateway, or get_logical_port_status for realized state.' It also excludes distributed firewall rules and points to vmware-nsx-security, giving clear when-to-use and alternatives.

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