create_c4_diagram_tool

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

With no annotations, the description carries full burden. It discloses that it generates source code from explicitly defined elements, relationships, and boundaries. However, it does not mention any side effects, mutation, or limitations (e.g., no image rendering), which would be helpful for an agent to fully understand 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: a one-line summary followed by a clear Args list with parameter details. Every sentence adds value, and the format is front-loaded for quick understanding.

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 purpose, parameters, and output format adequately. Since an output schema exists, it doesn't need to detail return values. It could elaborate on diagram type semantics, but given sibling tools may cover that, the description is sufficiently complete for a 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 input schema has 0% description coverage, but the tool's description compensates by explaining each parameter's meaning and structure (e.g., 'elements: List of C4 elements, each with: type, alias, label, description, technology'). This provides significant value beyond the schema's type-only definitions.

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 purpose: 'Create a C4 architecture diagram from structured data.' It specifies the output (Mermaid or PlantUML source code) and distinguishes itself from siblings like 'get_c4_reference_tool' and 'scan_codebase_tool' by focusing on creation.

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 clear context for usage (when you have structured C4 data) and lists supported diagram types. However, it lacks explicit guidance on when not to use it or how to choose between output formats or diagram types, leaving some interpretation to the agent.

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