analyze_workflow

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

The description indicates the tool returns a 'concise text summary (not raw JSON) optimized for AI reasoning,' implying no side effects and a read-only operation. However, it does not explicitly state that no changes are made to the workflow or discuss any authentication or rate limits. Given no annotations, it carries the burden fully, but the description is still reasonably transparent.

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 extremely concise with three sentences, no redundant information, and is front-loaded with the core purpose. Every sentence serves a specific function: stating the action, indicating usage context, and providing an alternative.

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 (3 parameters, many siblings) and the absence of an output schema, the description is complete. It clearly describes what the tool returns, how to use it, and how it differs from related tools (get_workflow, modify_workflow). No additional information is necessary for correct selection and invocation.

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?

All three parameters are fully described in the input schema (100% coverage). The description adds value by suggesting 'Use list_workflows to see available files' for the filename parameter and by explaining the default view behavior for the 'view' parameter. While it does not repeat the schema details, it provides useful context beyond the 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 loads a saved workflow and returns a structured analysis covering sections, node settings, connections, and data flow. It explicitly distinguishes this tool from its sibling get_workflow by indicating that analyze_workflow is preferred unless raw JSON is needed.

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 explicit guidance on when to use the tool: 'Use this to understand any workflow before modifying or executing it.' It also gives when-not-to-use advice by saying 'Prefer this over get_workflow unless you need the raw JSON for enqueue_workflow or modify_workflow,' which names both alternatives and conditions.

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