nifi_list_connections

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description earns credit by disclosing payload semantics: `queued.count`/`queued.bytes` are numeric while `_display` variants are formatted strings — a non-obvious trait that helps the agent parse results.

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 plus the endpoint reference, front-loaded with the operation and scope. Efficient with no filler, though the trailing payload note is slightly clipped in presentation.

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?

For a single-parameter read tool with an output schema and full annotation coverage, the description is essentially complete. The one gap is that pg_id behavior (default root) is left entirely to the schema.

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% for the single pg_id parameter, so the schema documents little. The description only implies the ID via the endpoint template ('process-groups/{id}/connections') and never explains the default 'root' meaning, leaving the parameter semantics thin.

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+resource ('Connections in a process group') and adds scope detail (queue depth and backpressure settings). It is clearly distinguishable from the singular nifi_get_connection, though it does not explicitly name siblings it should not be confused with.

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 when-to-use guidance, no alternatives named, no exclusions. The agent must infer from the name and the backing endpoint (GET /process-groups/{id}/connections) that this is a read-listing operation scoped to one process group.

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