nifi_system_diagnostics

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safe-read profile is covered structurally. The description adds the backend GET /system-diagnostics hint, useful for anyone reasoning about caching or cost, but says nothing about the effect of the verbose flag or the response shape.

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 lines: the returned metrics lead, the routing condition follows. No filler and nothing buried.

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, and the annotations cover safety. The only real gap is the undocumented verbose parameter, which is minor for an optional flag defaulting to false.

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 `verbose` parameter, and the description does not mention it at all, so nothing tells the agent what enabling verbose changes. With low coverage the description was expected to compensate, and it does not.

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 enumerates the exact resources returned — JVM heap, thread counts, repository disk usage, uptime — which is concrete and far more informative than a generic 'get system diagnostics'. It implicitly distinguishes itself from the flow-inspection siblings by scoping to system health, though no explicit verb frames the action.

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?

"Use when diagnosing performance or memory pressure rather than flow logic" gives a clear when-to-use condition and steers the agent away from the flow-logic sibling cluster. It stops short of naming a specific alternative tool for the flow-logic case, so it is strong context rather than a full routing rule.

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