Upsert Vectors to Flow

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

Annotations already indicate readOnlyHint=false and destructiveHint=false, so the mutation nature is known. The description adds that the tool 'triggers the flow's document processing pipeline', providing context about side effects beyond the annotation, but lacks details on auth, rate limits, or what gets destroyed.

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 reasonably concise with separate 'Args' and 'Returns' sections, though the 'Args' section adds little value beyond the schema. It fits within a few lines and is front-loaded with the main action.

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 basic intent and pipeline triggering, but lacks details on edge cases (e.g., invalid flow_id) and behavior (insert vs. update logic). An output schema exists, so return value details are less critical, but the description is still incomplete for a mutation tool with pipeline side effects.

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 input schema provides detailed descriptions for all parameters (flow_id, override_config, stop_node_id), so the description adds little new semantic meaning. The description briefly mentions 'flow_id, optional override_config and stop_node_id' but does not enrich 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 'Insert or update vectors in a chatflow's vector store,' with a specific verb-resource pair that distinguishes this tool from siblings like flowise_query_vector_store. The title 'Upsert Vectors to Flow' reinforces the purpose.

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 'triggers the flow's document processing pipeline' but provides no guidance on when to use this tool versus alternatives (e.g., flowise_query_vector_store for reading). No explicit context for when-to-use or when-not-to-use.

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