Skip to main content
Glama

Report File Transfer Event

terminal_report_file_transfer

Publish file-transfer status events (started, progress, completed, failed) for a caller-owned active transfer lease without writing terminal output, keeping session observers updated.

Instructions

Publish a file-transfer status event only for the caller-owned active file-transfer lease, without writing terminal output.

Input Schema

NameRequiredDescriptionDefault
typeYesFile-transfer event type.
actorNoOptional adapter actor label; defaults to system.
ownerYesOpaque owner capability of the active file-transfer lease.
metadataNoOptional JSON-compatible transfer status metadata.
session_idYesActive Session ID or short reference.
transfer_idYesTransfer ID returned when the file-transfer lease was acquired.

Output Schema

NameRequiredDescriptionDefault
publishedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.2

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare the mutation/non-idempotent/non-destructive profile, and the description adds two things they do not: an authorization precondition (must own the active lease) and the fact that the event is published without emitting terminal output. It does not warn that non-idempotent repeats may duplicate events, which keeps it off a 5.

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?

One front-loaded sentence with no filler; the scope constraint precedes the clarifying negative clause, so the agent reads the essential restriction first.

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

Completeness4/5

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

With an output schema present, a fully described 6-param schema, and annotations covering safety, the description need not explain return values. It is nearly complete, missing only failure behavior when the lease is stale or already released.

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

Parameters3/5

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

Schema description coverage is 100%, so all six parameters including the type enum and nested metadata are documented in the schema. The description adds only the owner/transfer_id linkage ('caller-owned active lease'), so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb+resource ('Publish a file-transfer status event') and narrows scope to 'the caller-owned active file-transfer lease'. The clause 'without writing terminal output' implicitly separates it from terminal_write / terminal_write_leased, though no sibling is named outright.

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

Usage Guidelines3/5

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

The precondition 'caller-owned active file-transfer lease' implies this is only callable mid-transfer, which is useful, but there is no explicit when-to-use vs when-not guidance and no named alternative (e.g. terminal_file_transfer_checkpoint, terminal_wait_file_transfer).

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