Wait for File Transfer Result
terminal_wait_file_transferWaits for a specific file transfer to complete, cancel, or fail and confirms its lease is released, returning the resolved saved file path for file-transfer outcomes.
Instructions
Wait for one transfer_id after an event cursor until the transfer completes, is cancelled, or fails and its file-transfer lease has been released. Completed transfers include source_path, requested_path, resolved_path, renamed, and optional sha256; use resolved_path as the saved file path. Use this instead of terminal_wait for file-transfer outcomes.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"session_id": "<session_id>",
"transfer_id": "<transfer_id>",
"cursor": "<cursor>"
},
"name": "terminal_wait_file_transfer"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | Yes | Next Session event cursor captured before or during the transfer. | |
| max_events | No | Maximum number of Session events inspected per read. | |
| session_id | Yes | Active Session ID or short reference. | |
| timeout_ms | No | Optional total wait timeout in milliseconds; maximum 86400000. | |
| transfer_id | Yes | Transfer ID published by FILE_TRANSFER_STARTED and the file-transfer lease events. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | ||
| event | Yes | ||
| state | Yes | ||
| sha256 | No | ||
| dropped | Yes | ||
| renamed | No | ||
| source_path | No | ||
| transfer_id | Yes | ||
| resolved_path | No | ||
| lease_released | Yes | ||
| requested_path | No |