Skip to main content
Glama

nifi_get_flowfile

Read-onlyIdempotent

Retrieve metadata and attributes for one queued FlowFile in an Apache NiFi connection queue using its connection ID and FlowFile UUID.

Instructions

Metadata and attributes for one queued flowfile.

Backed by GET /flowfile-queues/{id}/flowfiles/{uuid}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
connection_idYes
flowfile_uuidYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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 the useful distinction that this returns metadata/attributes (not content) and discloses the backing REST endpoint, but says nothing about auth needs, rate limits, or behavior for missing/expired flowfiles.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short lines, front-loaded with the purpose, no filler. The endpoint line is compact and adds provenance, though it is arguably redundant with the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return shape need not be described. However, in a large sibling set with an adjacent content tool, the absence of parameter explanations and routing guidance leaves the definition only minimally sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry the parameter burden, and it does not. Neither connection_id nor flowfile_uuid is explained; the agent can only infer their meaning from the endpoint template and the phrase 'one queued flowfile'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific resource and scope: metadata and attributes for exactly one queued flowfile, which is enough to distinguish it from nifi_get_flowfile_content (content) and nifi_queue_listing (bulk). It does not name those siblings explicitly, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use statement, no prerequisites, and no mention of the alternative tools an agent should consider (content retrieval vs. metadata, queue listing vs. single item). The phrase 'queued flowfile' only loosely implies the context.

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