generate_network_diagram

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

No annotations are provided, so the description carries the full burden. It lists input parameters and a return value but does not disclose whether the operation has side effects, requires permissions, or how the diagram is rendered. This leaves significant ambiguity about the tool's behavior.

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 well-structured with a one-line purpose, an argument list, and a return statement. No unnecessary words or redundancy.

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 five required parameters and no output schema or annotations, the description covers the parameters and return value but lacks details on the output format, error handling, and any dependencies. The mention of 'Returns: Network diagram' is vague, providing no information about the diagram's representation.

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 provides brief definitions for each parameter (e.g., 'cluster_cidr: Cluster (pod) network CIDR'), which adds meaning beyond the bare schema. However, it does not specify formats, allowed values, or examples, so while helpful, it is not exhaustive.

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 the tool 'Generate a network diagram for the cluster', using a specific verb and resource. It distinguishes itself from sibling tools like validate_network_cidr or check_network_overlap by focusing on diagram generation.

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 explicit guidance on when to use this tool versus alternatives. The purpose implies it is for generating a visual representation of network configuration, but no prerequisites or conditions are stated.

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