|
| 1 | +--- |
| 2 | +title: Dagster |
| 3 | +description: Orchestrate data pipelines and manage job runs on Dagster+ |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="dagster" |
| 10 | + color="#191A23" |
| 11 | +/> |
| 12 | + |
| 13 | +## Usage Instructions |
| 14 | + |
| 15 | +Connect to Dagster+ to launch job runs, monitor run status, list available jobs across repositories, and terminate in-progress runs. Requires a Dagster Cloud API token. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Tools |
| 20 | + |
| 21 | +### `dagster_launch_run` |
| 22 | + |
| 23 | +Launch a Dagster job run in your Dagster+ deployment. |
| 24 | + |
| 25 | +#### Input |
| 26 | + |
| 27 | +| Parameter | Type | Required | Description | |
| 28 | +| --------- | ---- | -------- | ----------- | |
| 29 | +| `organizationName` | string | Yes | Dagster+ organization name \(subdomain, e.g., "myorg"\) | |
| 30 | +| `deploymentName` | string | Yes | Dagster+ deployment name \(e.g., "prod"\) | |
| 31 | +| `apiKey` | string | Yes | Dagster Cloud API token | |
| 32 | +| `repositoryLocationName` | string | Yes | Repository location \(code location\) name | |
| 33 | +| `repositoryName` | string | Yes | Repository name within the code location | |
| 34 | +| `jobName` | string | Yes | Name of the job to launch | |
| 35 | +| `runConfigJson` | string | No | Run configuration as a JSON object \(optional\) | |
| 36 | +| `tags` | string | No | Tags as a JSON array of \{key, value\} objects \(optional\) | |
| 37 | + |
| 38 | +#### Output |
| 39 | + |
| 40 | +| Parameter | Type | Description | |
| 41 | +| --------- | ---- | ----------- | |
| 42 | +| `runId` | string | The globally unique ID of the launched run | |
| 43 | + |
| 44 | +### `dagster_get_run` |
| 45 | + |
| 46 | +Get the status and details of a Dagster run by its ID. |
| 47 | + |
| 48 | +#### Input |
| 49 | + |
| 50 | +| Parameter | Type | Required | Description | |
| 51 | +| --------- | ---- | -------- | ----------- | |
| 52 | +| `organizationName` | string | Yes | Dagster+ organization name \(subdomain\) | |
| 53 | +| `deploymentName` | string | Yes | Dagster+ deployment name \(e.g., "prod"\) | |
| 54 | +| `apiKey` | string | Yes | Dagster Cloud API token | |
| 55 | +| `runId` | string | Yes | The ID of the run to retrieve | |
| 56 | + |
| 57 | +#### Output |
| 58 | + |
| 59 | +| Parameter | Type | Description | |
| 60 | +| --------- | ---- | ----------- | |
| 61 | +| `runId` | string | Run ID | |
| 62 | +| `jobName` | string | Name of the job this run belongs to | |
| 63 | +| `status` | string | Run status \(QUEUED, NOT_STARTED, STARTING, MANAGED, STARTED, SUCCESS, FAILURE, CANCELING, CANCELED\) | |
| 64 | +| `startTime` | number | Run start time as Unix timestamp | |
| 65 | +| `endTime` | number | Run end time as Unix timestamp | |
| 66 | +| `runConfigYaml` | string | Run configuration as YAML | |
| 67 | +| `tags` | json | Run tags as array of \{key, value\} objects | |
| 68 | + |
| 69 | +### `dagster_list_runs` |
| 70 | + |
| 71 | +List recent Dagster runs, optionally filtered by job name. |
| 72 | + |
| 73 | +#### Input |
| 74 | + |
| 75 | +| Parameter | Type | Required | Description | |
| 76 | +| --------- | ---- | -------- | ----------- | |
| 77 | +| `organizationName` | string | Yes | Dagster+ organization name \(subdomain\) | |
| 78 | +| `deploymentName` | string | Yes | Dagster+ deployment name \(e.g., "prod"\) | |
| 79 | +| `apiKey` | string | Yes | Dagster Cloud API token | |
| 80 | +| `jobName` | string | No | Filter runs by job name \(optional\) | |
| 81 | +| `limit` | number | No | Maximum number of runs to return \(default 20\) | |
| 82 | +| `cursor` | string | No | Pagination cursor from a previous list_runs response | |
| 83 | + |
| 84 | +#### Output |
| 85 | + |
| 86 | +| Parameter | Type | Description | |
| 87 | +| --------- | ---- | ----------- | |
| 88 | +| `runs` | json | Array of runs with runId, jobName, status, startTime, endTime | |
| 89 | +| ↳ `runId` | string | Run ID | |
| 90 | +| ↳ `jobName` | string | Job name | |
| 91 | +| ↳ `status` | string | Run status | |
| 92 | +| ↳ `startTime` | number | Start time as Unix timestamp | |
| 93 | +| ↳ `endTime` | number | End time as Unix timestamp | |
| 94 | +| `cursor` | string | Pagination cursor to retrieve the next page | |
| 95 | +| `hasMore` | boolean | Whether more runs are available | |
| 96 | + |
| 97 | +### `dagster_list_jobs` |
| 98 | + |
| 99 | +List all jobs across repositories in a Dagster+ deployment. |
| 100 | + |
| 101 | +#### Input |
| 102 | + |
| 103 | +| Parameter | Type | Required | Description | |
| 104 | +| --------- | ---- | -------- | ----------- | |
| 105 | +| `organizationName` | string | Yes | Dagster+ organization name \(subdomain\) | |
| 106 | +| `deploymentName` | string | Yes | Dagster+ deployment name \(e.g., "prod"\) | |
| 107 | +| `apiKey` | string | Yes | Dagster Cloud API token | |
| 108 | +| `repositoryLocationName` | string | No | Filter by repository location name \(optional\) | |
| 109 | + |
| 110 | +#### Output |
| 111 | + |
| 112 | +| Parameter | Type | Description | |
| 113 | +| --------- | ---- | ----------- | |
| 114 | +| `jobs` | json | Array of jobs with name, repositoryName, repositoryLocationName, and description | |
| 115 | +| ↳ `name` | string | Job name | |
| 116 | +| ↳ `repositoryName` | string | Repository name | |
| 117 | +| ↳ `repositoryLocationName` | string | Repository location name | |
| 118 | +| ↳ `description` | string | Job description | |
| 119 | + |
| 120 | +### `dagster_terminate_run` |
| 121 | + |
| 122 | +Terminate an in-progress Dagster run. |
| 123 | + |
| 124 | +#### Input |
| 125 | + |
| 126 | +| Parameter | Type | Required | Description | |
| 127 | +| --------- | ---- | -------- | ----------- | |
| 128 | +| `organizationName` | string | Yes | Dagster+ organization name \(subdomain\) | |
| 129 | +| `deploymentName` | string | Yes | Dagster+ deployment name \(e.g., "prod"\) | |
| 130 | +| `apiKey` | string | Yes | Dagster Cloud API token | |
| 131 | +| `runId` | string | Yes | The ID of the run to terminate | |
| 132 | + |
| 133 | +#### Output |
| 134 | + |
| 135 | +| Parameter | Type | Description | |
| 136 | +| --------- | ---- | ----------- | |
| 137 | +| `success` | boolean | Whether the run was successfully terminated | |
| 138 | +| `runId` | string | The ID of the terminated run | |
| 139 | +| `message` | string | Error or status message if termination failed | |
| 140 | + |
| 141 | + |
0 commit comments