Skip to content

Commit a94bbd4

Browse files
committed
add cancel_run
1 parent a1155de commit a94bbd4

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

docs/mcp-tools.mdx

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,47 @@ Get the details of a specific task run.
267267
</ParamField>
268268

269269
<ParamField query="debugMode" type="boolean" optional>
270-
If true, the run trace will be returned in the response which can be helpful for debugging.
271-
Defaults to false.
270+
Enable debug mode to get more detailed information about the run, including the entire trace (all logs and spans for the run and any child run). Set this to true if prompted to debug a run.
272271
</ParamField>
273272

273+
### cancel_run
274+
275+
Cancel a running task.
276+
277+
<ParamField query="runId" type="string" required>
278+
The ID of the run to cancel, starts with `run_`
279+
</ParamField>
280+
281+
<ParamField query="projectRef" type="string" optional>
282+
The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the
283+
project ref if running inside a directory that includes a trigger.config.ts file.
284+
</ParamField>
285+
286+
<ParamField query="configPath" type="string" optional>
287+
The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the
288+
root dir (like in a monorepo setup).
289+
</ParamField>
290+
291+
<ParamField query="environment" type="string" default="dev">
292+
The environment to cancel the run in. Options: `dev`, `staging`, `prod`, `preview`
293+
</ParamField>
294+
295+
<ParamField query="branch" type="string" optional>
296+
The branch to cancel the run in, only used for preview environments
297+
</ParamField>
298+
299+
<CodeGroup>
300+
```json Example Usage
301+
{
302+
"tool": "cancel_run",
303+
"arguments": {
304+
"runId": "run_abc123",
305+
"projectRef": "proj_abc123"
306+
}
307+
}
308+
```
309+
</CodeGroup>
310+
274311
### list_runs
275312

276313
List all runs for a project with comprehensive filtering options.

0 commit comments

Comments
 (0)