get_integration_flow

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

With no annotations provided, the description bears the full burden of behavioral disclosure. It only states that the tool 'get metadata,' which implies a non-destructive read operation, but fails to mention any required permissions, rate limits, error handling, or side effects. The description is too minimal to adequately inform an AI agent about behavioral traits.

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 description consists of two concise sentences with no fluff. The first sentence immediately states the purpose, making it easy to scan. Every part is relevant and earned its place.

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?

Given that an output schema exists (so return values need not be explained) and there are only two parameters, the description is minimally acceptable. However, it lacks any information about preconditions, error scenarios, or additional context such as whether the tool is read-only or requires specific authentication. For a get operation, it could be slightly more 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?

The input schema has zero description coverage (0%), so the description must compensate. It adds useful context for the version parameter ('active' for current version), but does not explain the iflow_id parameter beyond its name. Schema coverage is low, and only one of two parameters receives additional semantics.

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 clearly states the verb (Get), the resource (metadata of an integration flow), and the required identifiers (ID and version). It effectively distinguishes from sibling tools like get_integration_package or get_iflow_configurations by specifying 'integration flow' and 'metadata'.

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 description provides a specific usage tip for the version parameter ('Use version='active' for the currently active version.'), but does not offer broader guidance on when to use this tool versus alternatives such as get_iflow_configurations or list_package_iflows. No when-not-to-use or exclusion criteria are given.

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