Set Flow State

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

With no annotations provided, the description 'Update runtime flow state' fails to disclose critical behavioral details such as whether the update is a full replacement or incremental, any side effects, or required permissions. It adds no value beyond the tool name.

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 brief (4 words), which wastes no words but lacks key details needed for an agent to use it correctly. It is minimally adequate but not well-structured for clarity.

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 single parameter and no output schema, the description should explain what 'flow state' means, whether the update is idempotent, and how it relates to other flow operations. It fails to provide sufficient context for an AI agent to understand the tool's behavior and integration.

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 already describes the 'state' parameter (object or JSON string), and the description does not add any additional semantics or constraints beyond what is in the schema. Since schema coverage is 100%, the baseline score of 3 is appropriate.

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 uses a specific verb 'Update' and explicitly names the resource 'runtime flow state', clearly distinguishing it from the read-only sibling tool node-red-runtime-get-flow-state.

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?

No guidance is provided on when to use this tool (e.g., to modify flow state) or when to avoid it compared to other sibling tools like node-red-flows-update. No prerequisites or alternatives are mentioned.

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