get_iflow_resource

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

Without annotations, the description must disclose behavioral traits. 'Download' implies a read operation, but no mention of side effects, permissions, rate limits, or data format. Lacks depth for a mutating or sensitive operation.

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 is short but includes an 'Args:' section that separates parameter info. It's front-loaded with the main action, but the format could be more streamlined without repeating information.

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 4 unannotated parameters and an existing output schema, the description should cover more context. It misses explanations for iflow_id, version, and resource_name, and does not describe the output format or potential errors.

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%, so the description must explain parameters. Only resource_type is partially explained (list of values). Three required parameters (iflow_id, version, resource_name) have no semantic information.

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 tool's purpose: 'Download a specific resource from an integration flow.' This distinguishes it from sibling tools like list_iflow_resources (lists resources) and download_integration_flow (downloads entire 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?

No guidance on when to use this tool versus alternatives, nor any context about prerequisites or exclusions. The list of resource_type values is provided but no further usage direction.

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