get-flows-state

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

No annotations are provided, so the description carries full burden. It only states it returns runtime state and active status, but does not disclose any behavioral traits like safety, idempotency, or required permissions. For a read-only tool, it should at least explicitly note it does not modify anything.

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?

Two-sentence description, no unnecessary words. Front-loaded with action verb 'Retrieves'. Every sentence adds value.

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 no parameters and no output schema, the description is reasonably complete for a simple read operation. It could be enhanced by clarifying the format of the returned state (e.g., JSON object with flow IDs and statuses), but it covers the essential purpose.

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?

No parameters exist (schema coverage 100% with empty schema). Description adds no parameter info, which is appropriate. Baseline for zero parameters is 4.

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?

Specifically states it retrieves the current deployment state of all flows in Node-RED. Verb 'Retrieves' and resource 'deployment state of all flows' are clear. Distinguishes from siblings like 'get-flows' (list flows) and 'set-flows-state' (modify 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?

Implies usage for checking deployment state, but lacks explicit when-not or alternatives. With sibling tools like 'set-flows-state' and 'get-flows', additional guidance on when to use this over them would improve it. However, the description's 'current deployment state' provides clear context.

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