deploy_create_network

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

No annotations provided; description mentions client-side validation ('validated as syntactically correct') but does not disclose idempotency, side effects, permissions, or what happens on duplicate CIDR.

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?

Single sentence with precise wording. No redundant information.

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 3 parameters and full schema coverage, description adequately states core purpose but lacks context on return values (no output schema) or post-creation behavior. Sufficient for a straightforward creation tool but could be improved.

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?

Schema coverage is 100% with clear parameter descriptions. However, tool description ambiguously references separate 'ip_address' and 'prefix_length' despite schema having only a single 'cidr' string, potentially confusing the agent. Adds minimal value beyond schema.

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?

Description clearly states action ('Create') and resource ('Network') identified by CIDR. Distinguishes from sibling tools like deploy_delete_network and deploy_get_network.

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?

No guidance on when to use this tool versus alternatives such as deploy_create_site or deploy_create_network_tunnel_group. Missing context about prerequisites or exclusions.

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