update_workflow_mermaid_diagram

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

With no annotations provided, the description carries full responsibility for behavioral disclosure. It only lists arguments and hints at id source, but fails to mention if the update is destructive, whether it overwrites the entire diagram, any side effects on related data, or the return value. The presence of an output schema is not referenced.

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 very short, using a compact 'Args:' format. It efficiently conveys the parameter explanations in two lines. However, it lacks a proper sentence or introductory phrase that states what the tool does.

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?

For a tool with 2 required parameters and no annotations, the description is inadequate. It does not state the tool's purpose explicitly, describe return values, or indicate any behavioral constraints. The output schema exists but is unmentioned, leaving the agent without complete context.

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 must compensate. It adds meaning: id is 'workflow id' and can be fetched from get_workflows output; mermaidDiagram is 'workflow mermaid diagram'. This goes beyond the property names but lacks constraints like format, allowed values, or examples.

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 tool name 'update_workflow_mermaid_diagram' clearly indicates the action, and the description lists the parameters with explanations (id is workflow id, mermaidDiagram is the diagram). However, it does not explicitly state 'Updates the mermaid diagram of a workflow' or differentiate from sibling tools like modify_workflow, so clarity is good but not perfect.

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 a specific usage hint: the id can be fetched from the output of get_workflows. This guides the agent on how to obtain the required id. However, it does not mention when to use this tool over alternatives (e.g., modify_workflow) or any prerequisites or conditions.

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