Skip to content

Commit 7329ac4

Browse files
committed
Add list deployments tools
1 parent a94bbd4 commit 7329ac4

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

docs/mcp-tools.mdx

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,66 @@ Deploy a project to staging or production environments.
436436
```
437437
</CodeGroup>
438438

439+
### list_deployments
440+
441+
List deployments for a project with comprehensive filtering options.
442+
443+
<ParamField query="projectRef" type="string" optional>
444+
The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the
445+
project ref if running inside a directory that includes a trigger.config.ts file.
446+
</ParamField>
447+
448+
<ParamField query="configPath" type="string" optional>
449+
The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the
450+
root dir (like in a monorepo setup).
451+
</ParamField>
452+
453+
<ParamField query="environment" type="string" default="prod">
454+
The environment to list deployments for. Options: `staging`, `prod`, `preview`
455+
</ParamField>
456+
457+
<ParamField query="branch" type="string" optional>
458+
The branch to list deployments from, only used for preview environments
459+
</ParamField>
460+
461+
<ParamField query="cursor" type="string" optional>
462+
The deployment ID to start the search from, to get the next page
463+
</ParamField>
464+
465+
<ParamField query="limit" type="number" optional>
466+
The number of deployments to return, defaults to 20 (max 100)
467+
</ParamField>
468+
469+
<ParamField query="status" type="string" optional>
470+
Filter deployments that are in this status. Options: `PENDING`, `BUILDING`, `DEPLOYING`, `DEPLOYED`, `FAILED`, `CANCELED`, `TIMED_OUT`
471+
</ParamField>
472+
473+
<ParamField query="from" type="string" optional>
474+
The date to start the search from, in ISO 8601 format
475+
</ParamField>
476+
477+
<ParamField query="to" type="string" optional>
478+
The date to end the search, in ISO 8601 format
479+
</ParamField>
480+
481+
<ParamField query="period" type="string" optional>
482+
The period to search within. Examples: `1d`, `7d`, `3h`
483+
</ParamField>
484+
485+
<CodeGroup>
486+
```json Example Usage
487+
{
488+
"tool": "list_deployments",
489+
"arguments": {
490+
"projectRef": "proj_abc123",
491+
"environment": "prod",
492+
"status": "DEPLOYED",
493+
"limit": 10
494+
}
495+
}
496+
```
497+
</CodeGroup>
498+
439499
<Callout type="warning">
440500
The deploy tool is not available when the MCP server is running with the `--dev-only` flag.
441501
</Callout>

0 commit comments

Comments
 (0)