render_workflow

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

With no annotations, the description bears full burden. It discloses that multiple files (.mmd, .md, .html) are written to disk, but does not detail side effects (e.g., overwriting), idempotency, or permission requirements.

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 a single sentence that conveys essential information without fluff. It could be improved by adding a brief note on parameter usage, but it is appropriately sized.

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 5 parameters, low schema coverage, and no output schema, the description lacks completeness. It does not explain how source parameters interact, the purpose of direction, or what the generated .md and .html files contain.

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 only 20%, yet the description adds no additional meaning to parameters beyond what the schema provides. It does not explain direction, source_path, source_text, or source_type, failing to compensate for the low coverage.

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 verb (generate and write) and resource (Mermaid flowchart from workflow spec). It explicitly distinguishes from sibling tool render_erd by noting it is for workflows/pipelines.

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 clear sibling reference ('Same as render_erd but for workflows/pipelines'), indicating when to use this tool vs an alternative. However, it lacks explicit when-not-to-use or prerequisite guidance.

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