hybrid_connectivity

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds nothing behavioral on top - no indication of whether this returns a full dump or filtered view, no scope/pagination notes, no mention of potential size.

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?

A single dense sentence with every clause carrying real content about covered entities, and the primary subject (VPN and ExpressRoute) is front-loaded. It is a verbless fragment, which slightly hurts readability but not length or focus.

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?

With no output schema, the description must stand in for the return value, and it does outline the entity/attribute coverage reasonably well. However, it gives no sense of result structure, breadth, or how multiple gateways/connections are grouped, which matters for a cross-cutting connectivity view.

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 tool takes zero parameters, so there is nothing for the description to clarify; the baseline of 4 applies. No parameter-related information is missing.

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 enumerates the exact resources covered (VPN/ExpressRoute gateways, VNet, SKU, BGP, point-to-site, connections, remote side, spoke VNets via peering), which makes the domain unambiguous. It lacks an explicit verb such as 'returns' or 'maps', so the agent must infer this is a read/aggregation tool, and no sibling is named for contrast.

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?

There is no statement of when to use this tool versus alternatives such as infra_summary, route_for, or export_map, and no prerequisites or scope conditions. The agent is left to infer usage purely from the subject matter.

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