trigger.dev 0.0.0-re2-20250204143529 → 0.0.0-re2-20250314185304

package/README.md

@@ -19,6 +19,37 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
 | [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles.                                     |
 | [update](https://trigger.dev/docs/cli-update-commands)               | Updates all `@trigger.dev/*` packages to match the CLI version.    |
 
+## MCP Server
+
+The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools
+to agentic LLM clients, like [Claude for Desktop](https://docs.anthropic.com/en/docs/claude-for-desktop/overview), [Cursor](https://www.cursor.com/), [Windsurf](https://windsurf.com/), etc...
+
+The Trigger.dev CLI can expose an MCP server and enable you interact with Trigger.dev in agentic LLM workflows. For example, you can use
+it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc...
+
+### Starting the Trigger.dev MCP Server
+
+To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command:
+
+```bash
+trigger dev --mcp
+```
+
+By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag:
+
+```bash
+trigger dev --mcp --mcp-port 3334
+```
+
+### Configuring your MCP client
+
+This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file
+and should be good to go as long as you use the default MCP server port.
+
+Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details.
+
+Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D
+
 ## Support
 
 If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.

package/dist/esm/apiClient.d.ts

@@ -1,6 +1,8 @@
+import { z } from "zod";
 import { EventSource } from "eventsource";
-import { CreateBackgroundWorkerRequestBody, InitializeDeploymentRequestBody, StartDeploymentIndexingRequestBody, ImportEnvironmentVariablesRequestBody, FailDeploymentRequestBody, FinalizeDeploymentRequestBody, WorkersCreateRequestBody, TriggerTaskRequestBody, DevDequeueRequestBody } from "@trigger.dev/core/v3";
-import { WorkloadDebugLogRequestBody, WorkloadHeartbeatRequestBody, WorkloadRunAttemptCompleteRequestBody, WorkloadWaitForDurationRequestBody } from "@trigger.dev/core/v3/workers";
+import { CreateBackgroundWorkerRequestBody, InitializeDeploymentRequestBody, StartDeploymentIndexingRequestBody, ImportEnvironmentVariablesRequestBody, TaskRunExecution, FailDeploymentRequestBody, FailDeploymentResponseBody, FinalizeDeploymentRequestBody, WorkersCreateRequestBody, TriggerTaskRequestBody, DevConfigResponseBody, DevDequeueRequestBody, DevDequeueResponseBody } from "@trigger.dev/core/v3";
+import { ApiResult } from "@trigger.dev/core/v3/zodfetch";
+import { WorkloadDebugLogRequestBody, WorkloadHeartbeatRequestBody, WorkloadHeartbeatResponseBody, WorkloadRunAttemptCompleteRequestBody, WorkloadRunAttemptCompleteResponseBody, WorkloadRunAttemptStartResponseBody, WorkloadRunLatestSnapshotResponseBody } from "@trigger.dev/core/v3/workers";
 export declare class CliApiClient {
     readonly apiURL: string;
     readonly accessToken?: string | undefined;
@@ -24,100 +26,37 @@ export declare class CliApiClient {
         externals: string[];
     }>>;
     getProject(projectRef: string): Promise<ApiResult<{
-        id: string;
-        externalRef: string;
         name: string;
-        slug: string;
-        createdAt: Date;
+        id: string;
         organization: {
             id: string;
-            slug: string;
             createdAt: Date;
+            slug: string;
             title: string;
         };
+        createdAt: Date;
+        slug: string;
+        externalRef: string;
     }>>;
     getProjects(): Promise<ApiResult<{
-        id: string;
-        externalRef: string;
         name: string;
-        slug: string;
-        createdAt: Date;
+        id: string;
         organization: {
             id: string;
-            slug: string;
             createdAt: Date;
+            slug: string;
             title: string;
         };
+        createdAt: Date;
+        slug: string;
+        externalRef: string;
     }[]>>;
     createBackgroundWorker(projectRef: string, body: CreateBackgroundWorkerRequestBody): Promise<ApiResult<{
-        id: string;
         version: string;
+        id: string;
         contentHash: string;
     }>>;
-    createTaskRunAttempt(runFriendlyId: string): Promise<ApiResult<{
-        organization: {
-            id: string;
-            name: string;
-            slug: string;
-        };
-        queue: {
-            id: string;
-            name: string;
-        };
-        task: {
-            id: string;
-            filePath: string;
-            exportName: string;
-        };
-        attempt: {
-            number: number;
-            status: string;
-            id: string;
-            startedAt: Date;
-            backgroundWorkerId: string;
-            backgroundWorkerTaskId: string;
-        };
-        run: {
-            id: string;
-            createdAt: Date;
-            startedAt: Date;
-            payload: string;
-            payloadType: string;
-            tags: string[];
-            isTest: boolean;
-            durationMs: number;
-            costInCents: number;
-            baseCostInCents: number;
-            version?: string | undefined;
-            maxAttempts?: number | undefined;
-            maxDuration?: number | undefined;
-            metadata?: Record<string, import("@trigger.dev/core/schemas").DeserializedJson> | undefined;
-            idempotencyKey?: string | undefined;
-            context?: any;
-        } & {
-            traceContext?: Record<string, unknown> | undefined;
-        };
-        environment: {
-            type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
-            id: string;
-            slug: string;
-        };
-        project: {
-            id: string;
-            name: string;
-            slug: string;
-            ref: string;
-        };
-        machine?: {
-            name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-            cpu: number;
-            memory: number;
-            centsPerMs: number;
-        } | undefined;
-        batch?: {
-            id: string;
-        } | undefined;
-    }>>;
+    createTaskRunAttempt(runFriendlyId: string): Promise<ApiResult<z.infer<typeof TaskRunExecution>>>;
     getProjectEnv({ projectRef, env }: {
         projectRef: string;
         env: string;
@@ -134,8 +73,8 @@ export declare class CliApiClient {
         success: boolean;
     }>>;
     initializeDeployment(body: InitializeDeploymentRequestBody): Promise<ApiResult<{
-        id: string;
         version: string;
+        id: string;
         contentHash: string;
         shortCode: string;
         imageTag: string;
@@ -147,24 +86,27 @@ export declare class CliApiClient {
         registryHost?: string | undefined;
     }>>;
     createDeploymentBackgroundWorker(deploymentId: string, body: CreateBackgroundWorkerRequestBody): Promise<ApiResult<{
-        id: string;
         version: string;
+        id: string;
         contentHash: string;
     }>>;
     failDeployment(id: string, body: FailDeploymentRequestBody): Promise<ApiResult<{
         id: string;
     }>>;
-    finalizeDeployment(id: string, body: FinalizeDeploymentRequestBody): Promise<ApiResult<{
+    finalizeDeployment(id: string, body: FinalizeDeploymentRequestBody, onLog?: (message: string) => void): Promise<ApiResult<FailDeploymentResponseBody>>;
+    promoteDeployment(version: string): Promise<ApiResult<{
+        version: string;
         id: string;
+        shortCode: string;
     }>>;
     startDeploymentIndexing(deploymentId: string, body: StartDeploymentIndexingRequestBody): Promise<ApiResult<{
         id: string;
         contentHash: string;
     }>>;
     getDeployment(deploymentId: string): Promise<ApiResult<{
-        status: "PENDING" | "BUILDING" | "DEPLOYING" | "DEPLOYED" | "FAILED" | "CANCELED" | "TIMED_OUT";
-        id: string;
+        status: "PENDING" | "CANCELED" | "TIMED_OUT" | "BUILDING" | "DEPLOYING" | "DEPLOYED" | "FAILED";
         version: string;
+        id: string;
         contentHash: string;
         shortCode: string;
         imageReference?: string | null | undefined;
@@ -175,13 +117,13 @@ export declare class CliApiClient {
             stderr?: string | undefined;
         } | null | undefined;
         worker?: {
-            id: string;
             version: string;
+            id: string;
             tasks: {
                 id: string;
-                slug: string;
                 filePath: string;
                 exportName: string;
+                slug: string;
             }[];
         } | undefined;
     }>>;
@@ -190,262 +132,14 @@ export declare class CliApiClient {
         isCached?: boolean | undefined;
     }>>;
     get dev(): {
-        config: () => Promise<ApiResult<{
-            environmentId: string;
-            dequeueIntervalWithRun: number;
-            dequeueIntervalWithoutRun: number;
-        }>>;
-        presenceConnection: () => Promise<EventSource>;
-        dequeue: (body: DevDequeueRequestBody) => Promise<ApiResult<{
-            dequeuedMessages: {
-                organization: {
-                    id: string;
-                };
-                version: "1";
-                run: {
-                    id: string;
-                    machine: {
-                        name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-                        cpu: number;
-                        memory: number;
-                        centsPerMs: number;
-                    };
-                    isTest: boolean;
-                    traceContext: Record<string, unknown>;
-                    friendlyId: string;
-                    attemptNumber: number;
-                    masterQueue: string;
-                };
-                environment: {
-                    type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
-                    id: string;
-                };
-                project: {
-                    id: string;
-                };
-                snapshot: {
-                    id: string;
-                    description: string;
-                    friendlyId: string;
-                    executionStatus: import("@trigger.dev/core/v3").TaskRunExecutionStatus;
-                };
-                completedWaitpoints: {
-                    type: import("@trigger.dev/core/v3").WaitpointType;
-                    id: string;
-                    friendlyId: string;
-                    completedAt: Date;
-                    outputIsError: boolean;
-                    idempotencyKey?: string | undefined;
-                    output?: string | undefined;
-                    outputType?: string | undefined;
-                    index?: number | undefined;
-                    completedByTaskRun?: {
-                        id: string;
-                        friendlyId: string;
-                        batch?: {
-                            id: string;
-                            friendlyId: string;
-                        } | undefined;
-                    } | undefined;
-                    completedAfter?: Date | undefined;
-                    completedByBatch?: {
-                        id: string;
-                        friendlyId: string;
-                    } | undefined;
-                }[];
-                backgroundWorker: {
-                    id: string;
-                    version: string;
-                    friendlyId: string;
-                };
-                deployment: {
-                    id?: string | undefined;
-                    friendlyId?: string | undefined;
-                };
-                image?: string | undefined;
-                checkpoint?: {
-                    type: string;
-                    id: string;
-                    location: string;
-                    reason?: string | null | undefined;
-                } | undefined;
-            }[];
-        }>>;
-        sendDebugLog: (runId: string, body: WorkloadDebugLogRequestBody) => Promise<ApiResult<unknown>>;
-        getRunExecutionData: (runId: string) => Promise<ApiResult<{
-            execution: {
-                version: "1";
-                run: {
-                    status: import("@trigger.dev/core/v3").TaskRunStatus;
-                    id: string;
-                    friendlyId: string;
-                    attemptNumber?: number | null | undefined;
-                };
-                snapshot: {
-                    id: string;
-                    description: string;
-                    friendlyId: string;
-                    executionStatus: import("@trigger.dev/core/v3").TaskRunExecutionStatus;
-                };
-                completedWaitpoints: {
-                    type: import("@trigger.dev/core/v3").WaitpointType;
-                    id: string;
-                    friendlyId: string;
-                    completedAt: Date;
-                    outputIsError: boolean;
-                    idempotencyKey?: string | undefined;
-                    output?: string | undefined;
-                    outputType?: string | undefined;
-                    index?: number | undefined;
-                    completedByTaskRun?: {
-                        id: string;
-                        friendlyId: string;
-                        batch?: {
-                            id: string;
-                            friendlyId: string;
-                        } | undefined;
-                    } | undefined;
-                    completedAfter?: Date | undefined;
-                    completedByBatch?: {
-                        id: string;
-                        friendlyId: string;
-                    } | undefined;
-                }[];
-                batch?: {
-                    id: string;
-                    friendlyId: string;
-                } | undefined;
-                checkpoint?: {
-                    type: import("@trigger.dev/core/v3").CheckpointTypeEnum;
-                    id: string;
-                    friendlyId: string;
-                    location: string;
-                    imageRef: string;
-                    reason?: string | null | undefined;
-                } | undefined;
-            };
-        }>>;
-        heartbeatRun: (runId: string, snapshotId: string, body: WorkloadHeartbeatRequestBody) => Promise<ApiResult<{
-            ok: true;
-        }>>;
-        startRunAttempt: (runId: string, snapshotId: string) => Promise<ApiResult<{
-            run: {
-                status: import("@trigger.dev/core/v3").TaskRunStatus;
-                id: string;
-                friendlyId: string;
-                attemptNumber?: number | null | undefined;
-            };
-            snapshot: {
-                id: string;
-                description: string;
-                friendlyId: string;
-                executionStatus: import("@trigger.dev/core/v3").TaskRunExecutionStatus;
-            };
-        } & {
-            execution: {
-                organization: {
-                    id: string;
-                    name: string;
-                    slug: string;
-                };
-                queue: {
-                    id: string;
-                    name: string;
-                };
-                task: {
-                    id: string;
-                    filePath: string;
-                    exportName: string;
-                };
-                attempt: {
-                    number: number;
-                    status: string;
-                    id: string;
-                    startedAt: Date;
-                    backgroundWorkerId: string;
-                    backgroundWorkerTaskId: string;
-                };
-                run: {
-                    id: string;
-                    createdAt: Date;
-                    startedAt: Date;
-                    payload: string;
-                    payloadType: string;
-                    tags: string[];
-                    isTest: boolean;
-                    durationMs: number;
-                    costInCents: number;
-                    baseCostInCents: number;
-                    version?: string | undefined;
-                    maxAttempts?: number | undefined;
-                    maxDuration?: number | undefined;
-                    metadata?: Record<string, import("@trigger.dev/core/schemas").DeserializedJson> | undefined;
-                    idempotencyKey?: string | undefined;
-                    context?: any;
-                } & {
-                    traceContext?: Record<string, unknown> | undefined;
-                };
-                environment: {
-                    type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
-                    id: string;
-                    slug: string;
-                };
-                project: {
-                    id: string;
-                    name: string;
-                    slug: string;
-                    ref: string;
-                };
-                machine?: {
-                    name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-                    cpu: number;
-                    memory: number;
-                    centsPerMs: number;
-                } | undefined;
-                batch?: {
-                    id: string;
-                } | undefined;
-            };
-        } & {
-            envVars: Record<string, string>;
-        }>>;
-        completeRunAttempt: (runId: string, snapshotId: string, body: WorkloadRunAttemptCompleteRequestBody) => Promise<ApiResult<{
-            result: {
-                attemptStatus: "RUN_FINISHED" | "RUN_PENDING_CANCEL" | "RETRY_QUEUED" | "RETRY_IMMEDIATELY";
-            } & {
-                run: {
-                    status: import("@trigger.dev/core/v3").TaskRunStatus;
-                    id: string;
-                    friendlyId: string;
-                    attemptNumber?: number | null | undefined;
-                };
-                snapshot: {
-                    id: string;
-                    description: string;
-                    friendlyId: string;
-                    executionStatus: import("@trigger.dev/core/v3").TaskRunExecutionStatus;
-                };
-            };
-        }>>;
-        waitForDuration: (runId: string, snapshotId: string, body: WorkloadWaitForDurationRequestBody) => Promise<ApiResult<{
-            waitUntil: Date;
-            waitpoint: {
-                id: string;
-            };
-        } & {
-            run: {
-                status: import("@trigger.dev/core/v3").TaskRunStatus;
-                id: string;
-                friendlyId: string;
-                attemptNumber?: number | null | undefined;
-            };
-            snapshot: {
-                id: string;
-                description: string;
-                friendlyId: string;
-                executionStatus: import("@trigger.dev/core/v3").TaskRunExecutionStatus;
-            };
-        }>>;
+        readonly config: () => Promise<ApiResult<DevConfigResponseBody>>;
+        readonly presenceConnection: () => Promise<EventSource>;
+        readonly dequeue: (body: DevDequeueRequestBody) => Promise<ApiResult<DevDequeueResponseBody>>;
+        readonly sendDebugLog: (runId: string, body: WorkloadDebugLogRequestBody) => Promise<ApiResult<unknown>>;
+        readonly getRunExecutionData: (runId: string) => Promise<ApiResult<WorkloadRunLatestSnapshotResponseBody>>;
+        readonly heartbeatRun: (runId: string, snapshotId: string, body: WorkloadHeartbeatRequestBody) => Promise<ApiResult<WorkloadHeartbeatResponseBody>>;
+        readonly startRunAttempt: (runId: string, snapshotId: string) => Promise<ApiResult<WorkloadRunAttemptStartResponseBody>>;
+        readonly completeRunAttempt: (runId: string, snapshotId: string, body: WorkloadRunAttemptCompleteRequestBody) => Promise<ApiResult<WorkloadRunAttemptCompleteResponseBody>>;
     };
     get workers(): {
         list: () => Promise<ApiResult<{
@@ -458,21 +152,21 @@ export declare class CliApiClient {
             lastHeartbeatAt?: string | null | undefined;
         }[]>>;
         create: (options: WorkersCreateRequestBody) => Promise<ApiResult<{
-            token: {
-                plaintext: string;
-            };
             workerGroup: {
                 name: string;
                 description?: string | null | undefined;
             };
+            token: {
+                plaintext: string;
+            };
         }>>;
     };
     get deployments(): {
         unmanaged: {
             latest: () => Promise<ApiResult<{
-                status: "PENDING" | "BUILDING" | "DEPLOYING" | "DEPLOYED" | "FAILED" | "CANCELED" | "TIMED_OUT";
-                id: string;
+                status: "PENDING" | "CANCELED" | "TIMED_OUT" | "BUILDING" | "DEPLOYING" | "DEPLOYED" | "FAILED";
                 version: string;
+                id: string;
                 contentHash: string;
                 shortCode: string;
                 imageReference?: string | null | undefined;
@@ -496,13 +190,4 @@ export declare class CliApiClient {
     private devHeartbeatRun;
     private devStartRunAttempt;
     private devCompleteRunAttempt;
-    private devWaitForDuration;
 }
-type ApiResult<TSuccessResult> = {
-    success: true;
-    data: TSuccessResult;
-} | {
-    success: false;
-    error: string;
-};
-export {};