Skip to main content
Glama
vilaabo

zephyr-scale-mcp

by vilaabo
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

download_attachment

Read-only

Download a Zephyr Scale attachment to a local file using its ID or direct URL. Specify the output path to save the file.

Instructions

Download a Zephyr Scale attachment to a local file. Address it either by attachmentId (from list_attachments or an upload response) or by the exact url field that list_attachments returns — pass exactly one of the two. Note: Zephyr Scale serves attachment content from /rest/tests/1.0/attachment/{id}; that is the URL the official list endpoint itself hands out, so this tool follows it. For safety, a passed url must point at the configured Jira host — credentials are never sent elsewhere. The file is written to outputPath on the machine running this MCP server (the parent directory must exist). Returns { savedTo, bytes }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoExact download url as returned by list_attachments; must be on the configured Jira host
outputPathYesLocal path to write the file to (the parent directory must exist)
attachmentIdNoNumeric attachment id (from list_attachments or an upload response)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Discloses important behavioral traits: mutual exclusion of parameters, URL safety check, file writing prerequisites, and return format. Adds value beyond the readOnlyHint annotation.

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

Conciseness5/5

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

Concise and well-structured: first sentence states purpose, subsequent sentences detail usage and constraints. No unnecessary information.

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

Completeness5/5

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

Completely covers all necessary aspects: action, parameters, safety, output format, and prerequisites. No gaps given the tool's simplicity and presence of annotations.

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

Parameters4/5

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

Adds meaning beyond schema by explaining mutual exclusivity of attachmentId and url, and providing safety context. Schema coverage is 100% but description enriches understanding.

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

Purpose5/5

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

Clearly states 'Download a Zephyr Scale attachment to a local file', specifying verb and resource. Differentiates from siblings like upload_attachment and delete_attachment.

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

Usage Guidelines4/5

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

Provides clear instructions on addressing by attachmentId or url, safety constraints, and file writing requirements. Does not explicitly compare to alternatives but gives sufficient context.

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

Deploy Server

Other Tools