Update Flowise Flow

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

Annotations provide readOnlyHint=false, destructiveHint=false, idempotentHint=true. The description adds the partial update behavior ('only provided fields will be updated') which is not in annotations, but does not disclose other traits like authorization needs or rate limits.

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 with three sentences plus bulleted examples, structured with Args, Returns, and Examples sections. Every part adds value without redundancy.

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 the partial update behavior and provides examples for common use cases. It does not specify the format of flow_data (JSON string) or detail the return structure, but these are provided in the input schema and output is hinted at. Overall adequate for a tool with good schema coverage.

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 description does not individually describe parameters, but the input schema has clear descriptions for each field. The description provides usage examples (rename, update config, make public) that add contextual meaning beyond the schema, compensating for the lack of parameter descriptions in the text.

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 'Update an existing chatflow or agentflow', specifying a specific verb and resource. It distinguishes from sibling tools like create, delete, and get, making the purpose unambiguous.

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 mentions that 'Only provided fields will be updated', implying it's a partial update, but lacks explicit guidance on when to use this tool versus alternatives like create or delete. No exclusions or prerequisites are stated.

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