create_sdn_vnet

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

With no annotations, the description must fully convey behavioral traits. It only states 'Create', implying mutation, but omits side effects, idempotency, error conditions, or any constraints beyond the parameter hints.

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 extremely concise: one line for the action followed by a clean parameter list with no extraneous text. Every token is necessary and well-organized.

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?

Despite an output schema being present, the description fails to mention return values, prerequisites (e.g., zone must exist), or constraints on optional parameters. It leaves significant gaps for a 5-parameter creation tool.

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 description includes brief one-word descriptions for each parameter (e.g., 'VNet ID', 'Zone ID', 'VLAN tag'), adding meaning beyond the raw schema names. However, it lacks detail on formats, valid values, or relationships, and schema coverage is 0%, so the description partially 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 clearly states 'Create an SDN VNet', specifying a concrete action and resource. While it doesn't explicitly distinguish from sibling tools like create_sdn_subnet or create_sdn_zone, the resource name is unique and the action is unambiguous.

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?

The description provides no guidance on when to use this tool versus alternatives (e.g., update_sdn_vnet, delete_sdn_vnet), nor does it mention prerequisites or context such as requiring an existing zone.

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