list_tier0_gateways

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

Beyond annotations, it discloses the result envelope with a truncation caveat ('check truncated before calling it complete') and proactively states the scope limitation about Tier-0 creation. This adds meaningful behavioral context.

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 front-loaded with the purpose, then workflow guidance, then args. Every sentence earns its place with no filler, making it highly efficient.

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 simple list tool, it covers what it returns, how to use it in a multi-step workflow, the truncation behavior, and parameter semantics. It is comprehensive without verbosity.

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 only parameter, target, is documented in the description as 'NSX Manager target from config (default if omitted),' adding meaning that the schema's type/default alone lack. Since schema coverage is 0%, this fully compensates.

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 'List all Tier-0 gateways with HA mode and transit subnets,' a specific verb+resource pairing that immediately distinguishes the tool from sibling get_tier0_gateway. It clearly focuses on listing all gateways rather than fetching a single one.

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 positions this as the entry point: 'Use this first to resolve a tier0_id, then get_tier0_gateway... or get_bgp_neighbors...' and notes that Tier-0s aren't created by this skill, preventing misuse.

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