Download integration artifact

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

Annotations already declare readOnlyHint=true; the description adds that the operation writes a zip to a specified output path, which is useful. It does not disclose behavior when the output file already exists or when the optional version parameter is omitted, but there is no contradiction with annotations.

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?

A single, direct sentence with the main verb and object front-loaded. There is no filler or redundant restating of the tool name.

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?

For a tool with 3 parameters, zero schema descriptions, and no output schema, this description is not sufficient. An agent would still guess about version semantics, how the output path is handled, and how to discover valid artifact ids using sibling list 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%, so the description needed to explain id, version, and output_path. It only hints that output_path is the destination for the zip and that the artifact is identified by an id; the version parameter is left completely unexplained.

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 states a specific verb ('Download'), resource ('integration design-time artifact (iFlow)'), and format ('as a zip file'). It is clearly distinct from upload, deploy, and get-style siblings in the tool list.

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 context implies this tool should be used when a design-time artifact needs to be fetched as a zip, but it does not explicitly state when to prefer it over other download or get tools, nor does it mention any exclusions or alternatives.

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