Skip to main content
Glama

Get Research Deliverable

get_research_deliverable
Read-onlyIdempotent

Poll a Hub export. A succeeded job returns a fresh private download_url with source access rechecked at download. Expired or revoked sources cannot be downloaded.

Input Schema

NameRequiredDescriptionDefault
job_idYes
organization_idNoOrganization for this operation and billing. Use list_organizations to choose an active membership.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / organization_id / description
      Previous value: -"Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet."New value: +"Organization for this operation and billing. Use list_organizations to choose an active membership."
  2. Added

TDQS

B3.1/5.0
Behavior4/5

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

Annotations already say readOnly, idempotent, and non-destructive, so safety is covered. The description still adds real value: a succeeded job returns a FRESH private download_url, source access is rechecked at download time, and expired or revoked sources will fail. That is genuine behavioral context an agent cannot get from annotations or schema.

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?

Three short sentences, front-loaded with the action and followed by the key return-value and access-constraint facts. Every sentence carries information; nothing is padding.

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-value detail is not strictly required, and the description usefully flags the download_url behavior. But for a polling tool it omits the essentials: what a pending or failed job yields, whether the caller should poll repeatedly, and the dependency on queue_research_deliverable for job_id. Adequate but with clear gaps.

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 coverage is only 50%, and the undocumented parameter is the required job_id, whose schema entry carries only format/pattern constraints. The description uses "job" but never says that job_id comes from queue_research_deliverable, nor does it mention organization_id or any hint about how these interact. It does not compensate for the coverage gap.

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

Purpose3/5

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

The description states a verb and target ("Poll a Hub export") and clarifies that a succeeded job yields a download_url, so the core action is graspable. However, "Hub export" is jargon that never names the deliverable or the research domain, and it does not distinguish this from sibling job-pollers such as get_report_job, get_customize_study_job, or get_participant_job. Purpose is implied rather than sharply stated.

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 explicit when-to-use or when-not-to-use guidance. The description never links this to queue_research_deliverable (the tool that presumably produces job_id), nor does it contrast with download_research_output or cancel_research_deliverable. The agent must infer the polling workflow entirely from the name and the word "job".

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources