get_tier1_gateway

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

Adds significant behavioral context beyond the readOnlyHint/idempotentHint annotations: specifies the return shape (single dict not list), enumerates the fields returned, and explicitly states what is NOT included (attached segments). This gives the agent a clear picture of the tool's output and limitations.

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 concise and front-loaded with the core purpose. Each sentence earns its place: usage context, return format, exclusions, and argument definitions. No redundant or filler content.

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 no output schema, the description fully compensates by listing return fields, explaining the distinction from the list tool, and embedding the tool in a workflow (after list, before update). It is self-sufficient for an agent to invoke correctly in context.

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 0% schema description coverage, the description compensates by explaining tier1_id as returned by list_tier1_gateways and target as the NSX Manager target from config (default if omitted). This adds practical meaning beyond the schema's raw parameter names. Slight room for improvement in detailing target's possible values, but it is adequate.

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?

States 'Get detailed info for one Tier-1 gateway' with a specific verb and resource. Differentiates from siblings by noting it returns a single detail dict (not list envelope) and is a prerequisite for update_tier1_gateway, and by pointing to list_segments for attached segments.

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 instructs to use after list_tier1_gateways and always before update_tier1_gateway, explaining why (PATCH needs current values). Also names list_segments as the alternative for attached segments, providing clear when-to-use and when-not-to-use guidance.

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