get_teamnet_virtual_network

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

No annotations are provided, and the description gives no behavioral context beyond the verb 'Get'. It does not disclose whether the operation is read-only, what permissions are required, what the response looks like, or how the vnet is scoped to the account. The description adds no value beyond the tool name itself.

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 a single concise sentence with no filler or redundant information. It front-loads the operation and the resource, making it easy to scan and understand quickly.

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 two-parameter retrieval tool, the description is minimally viable: an agent can infer that it needs account_id and vnet_id and that it will get details. However, with no output schema and no explanation of the returned details or account-scoping behavior, the description leaves some contextually important gaps.

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 schema has 100% description coverage for both parameters, with descriptions for vnet_id and account_id. The tool description does not add any additional meaning about how the parameters relate to each other or the expected format, so the schema is left to carry the semantic load.

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 states a specific verb, 'Get', and a specific resource, 'team virtual network', clearly indicating a single-resource retrieval operation. The get/list distinction from sibling list_teamnet_virtual_networks is implicit, though the description does not define what 'details' means or which fields are returned.

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 guidance on when to use this tool versus alternatives such as list_teamnet_virtual_networks or get_magic_transit_route. The description only states what the tool does and does not mention any prerequisites or exclusions, so an agent must rely on the tool name to infer usage context.

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