create_network_diagram

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

With no annotations, the description carries the transparency burden. It usefully discloses that different node types get distinct shapes and colors, and that a path to a .excalidraw file is returned. It does not mention file overwrite behavior, path creation, or failure cases, which would be valuable for a tool that writes files.

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 compact and well-organized into purpose, Args, and Returns. The only minor redundancy is the near-repetition of 'network topology diagram' and 'network diagram' in the first two sentences.

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?

The description covers the core purpose, parameters, and return value, which is enough for an agent to invoke this tool. It lacks only non-critical context like default output path behavior and file overwrite semantics, and it does not explain why network topology is distinct from architecture diagrams.

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 Args section compensates for the 0% top-level schema description coverage by briefly explaining all five top-level parameters, including optionality and theme values. Nested field semantics are mostly delegated to the schema's $defs, which is acceptable, though the description could have elaborated on link structure.

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 identifies the tool's action ('Create a network topology diagram') and resource (typed network diagram with nodes and links). It implies differentiation from siblings like create_flowchart or create_er_diagram by its focus on network topology, but it never names an alternative.

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 implies a network-topology use case through terms like 'server', 'database', and 'loadbalancer', but it does not explicitly say when to choose this tool over siblings such as create_architecture_diagram or import_mermaid. There are no direct when-to-use or when-not-to-use instructions.

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