nifi_get_process_group

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds only the backing endpoint (GET /process-groups/{id}) and the 'root' default note; it says nothing about the cost of the call, pagination, or what 'verbose' changes behaviorally.

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, front-loaded with the returned data and followed by the endpoint and the key default. Near-zero waste, though the opening noun fragment reads as a caption rather than a complete statement of action.

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 field-level return documentation is unnecessary, and the description does summarize the returned categories. However, with an undocumented 'verbose' parameter and no sibling differentiation, the definition is only minimally complete for an agent choosing among the many process-group tools.

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% with two undocumented parameters. The description partially explains pg_id by noting that 'root' selects the top-level group, but the 'verbose' flag is left entirely unexplained in both schema and description, which is a meaningful gap given it presumably alters the response.

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 names the resource (a process group) and enumerates the specific data returned: identity, component-state counts, and version-control state. It is a noun fragment rather than a verb phrase, and it never explicitly contrasts itself with close siblings like nifi_process_group_status or nifi_get_process_group_contents, so an agent must infer the boundary.

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 only guidance is the parameter hint 'Pass "root" for the top-level group', which is argument syntax, not usage context. There is no statement of when to call this versus nifi_process_group_status or nifi_get_process_group_contents, and no preconditions.

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