generate_uml_batch

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

Annotations provide idempotentHint=true (safe to retry) and readOnlyHint=false (modifies state). The description adds that it returns a list of per-index results or errors, but lacks details on partial failures, atomicity, or whether output_dir affects file storage. Basic transparency but could be more detailed.

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 two sentences, front-loaded with the main action, and every word adds value. No wasted or repetitive language.

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 the tool's complexity (2 parameters, one being an array of objects with no strict schema) and that an output schema exists, the description is fairly complete. It covers the item structure and the return format. A minor gap is the precise behavior of output_dir (e.g., if it creates directories), but overall it provides sufficient context for an AI agent.

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 description coverage is 0%, so the description compensates by explaining that 'items' are like generate_uml with specific parameters (diagram_type, code, output_format?, theme?, scale?) and that output_dir is an optional shared directory. This provides meaningful semantics beyond the raw 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?

The description clearly states the tool's purpose: generating multiple diagrams in one call. It distinguishes from the sibling 'generate_uml' by being a batch version, and lists the parameters that each item uses, similar to generate_uml.

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 usage context by stating 'Each item is like generate_uml' and mentions an optional shared output_dir. However, it does not explicitly state when to use this batch tool versus the single-call alternative, or when not to use it.

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