nifi_update_connection

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the safety profile is covered; the description usefully adds that only provided fields are sent (partial semantics) and that NiFi checks component state only when a destination changes. That is real behavioral value beyond the annotations, though permissions or side effects on queued FlowFiles are not covered.

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 short sentences, front-loaded with the purpose, then the partial-update rule and the running-flow caveat. No filler; every sentence earns its place.

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?

An output schema exists so return values need not be explained, but with 0% schema coverage the description should specify acceptable formats for the expiration and backpressure fields and mention the verbose/connection_id parameters. The partial-update and state-check notes are helpful but the parameter documentation gap remains.

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?

Schema description coverage is 0%, so the description carries the burden; it names three of the five fields (name, backpressure, FlowFile expiration) but omits 'verbose' and 'connection_id', and gives no value formats for the string fields (e.g., '1 GB' or '30 sec'), which an agent needs for back_pressure_data_size_threshold and flow_file_expiration.

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?

States a specific verb (Change) and resource (a connection) plus the three mutable aspects (name, backpressure, FlowFile expiration), which clearly separates it from nifi_create_connection and nifi_empty_queue. It stops short of explicitly naming the sibling alternatives, so it lands at 4 rather than 5.

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 'Sends only the fields you set' clause implicitly tells the agent this is a partial-update tool and the running-flow note gives context, but there is no explicit when-to-use/when-not guidance or routing to alternatives (e.g., nifi_create_connection for new connections). Usage is implied rather than stated.

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