nifi_export_flow

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description still earns credit by disclosing a non-obvious behavior: properties, run schedules, or network interfaces that NiFi reports invalid are masked in the component they are invalid on, consistent with other reads.

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?

The operation is front-loaded in the first sentence, and the masking caveat is a compact second paragraph. Both parts earn their place, though the masking sentence is somewhat dense.

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-value explanation is not required, and the description does note the output matches the UI export. However, as a read tool with an undocumented include_services flag and no routing versus nifi_get_flow, it is only minimally complete.

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% and the description adds no meaning for either parameter. In particular, include_services (default false) is entirely undocumented, leaving the agent to guess what 'services' are included and when to enable them; process_group_id is self-evident by name only.

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 a specific verb+resource ('Download a process group as a versioned flow snapshot') and adds a helpful anchor ('same JSON the UI exports'). It is clear what operation is performed, but it never explicitly distinguishes itself from close siblings such as nifi_get_flow, nifi_import_flow, or nifi_replace_flow.

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?

There is no explicit when-to-use guidance, no conditions for choosing this over nifi_get_flow, and no mention of prerequisites or exclusions. The implied usage (export/download) is inferable but never stated.

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