cancel_task
Ask a long-running tool call that returned a task handle to stop (index_vault on a large vault does). Pass the task_id from the handle. Cancellation is cooperative: the task keeps working until it reaches a checkpoint, so the returned status may still be working; call get_task_status to see it end as cancelled. A task that already finished is returned unchanged. Only the caller that started the task can cancel it. Domain: admin.
| Domain | admin |
| Scopes | none |
| Access | read |
| Tags | writes, domain:admin |
| Profile | core, full |
Annotations
Section titled “Annotations”| Annotation | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Accepts an idempotency key | no |
Idempotent is the advisory MCP idempotentHint. Destructive is also yes for a tool that
asks for confirmation only on some calls.
Confirmation (human in the loop)
Section titled “Confirmation (human in the loop)”No human confirmation is required to call this tool.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id |
string |
yes | — | length 1–200 |
Output
Section titled “Output”| Field | Type | Always present | Description |
|---|---|---|---|
task_id |
string |
yes | — |
status |
enum |
yes | One of: "working", "input_required", "completed", "failed", "cancelled" |
created_at |
string |
yes | — |
last_updated_at |
string |
yes | — |
progress |
object |
— | |
progress.done |
number |
with parent | — |
progress.total |
number |
— | |
progress.message |
string |
— | |
retry_after_seconds |
number |
— | |
result |
Record<string, any> |
— | |
error |
object |
— | |
error.code |
number |
with parent | — |
error.message |
string |
with parent | — |
error.data |
Record<string, any> |
— | |
status_message |
string |
— |
Related tools
Section titled “Related tools”Other tools in the admin domain: get_index_status, get_metrics, get_server_config, get_task_status, inspect_acl, inspect_visibility, server_health, session_rerun.
Back to the tool catalog.