research_cancel
Cancel a running research task in a notebook by supplying the notebook and poll task ID; confirm cancellation by checking research status afterward.
Instructions
Cancel an in-flight research run in a notebook.
Accepts a notebook name or ID and the poll_task_id to cancel — the
value from research_start / research_status. run_id is a
deprecated alias (removed in v0.9.0).
Sends the cancel unless the run is already TERMINAL (completed /
failed), which returns cancel_requested: false with the observed
status and no RPC. Otherwise returns cancel_requested: true with
run_status_before; a just-started run reading not_found /
no_research (replication lag) is cancelled too. Fire-and-forget; poll
research_status afterward to confirm.
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": {
"notebook": "<notebook>"
},
"name": "research_cancel"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run_id | No | ||
| notebook | Yes | ||
| poll_task_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||