Add support for getting the trace of a run in get_run_details

Author: ericallam

apps/webapp/app/routes/api.v1.runs.$runId.trace.ts

@@ -0,0 +1,57 @@
+import { json } from "@remix-run/server-runtime";
+import { BatchId } from "@trigger.dev/core/v3/isomorphic";
+import { z } from "zod";
+import { $replica } from "~/db.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
+import { eventRepository } from "~/v3/eventRepository.server";
+import { getTaskEventStoreTableForRun } from "~/v3/taskEventStore.server";
+
+const ParamsSchema = z.object({
+  runId: z.string(), // This is the run friendly ID
+});
+
+export const loader = createLoaderApiRoute(
+  {
+    params: ParamsSchema,
+    allowJWT: true,
+    corsStrategy: "all",
+    findResource: (params, auth) => {
+      return $replica.taskRun.findFirst({
+        where: {
+          friendlyId: params.runId,
+          runtimeEnvironmentId: auth.environment.id,
+        },
+      });
+    },
+    shouldRetryNotFound: true,
+    authorization: {
+      action: "read",
+      resource: (run) => ({
+        runs: run.friendlyId,
+        tags: run.runTags,
+        batch: run.batchId ? BatchId.toFriendlyId(run.batchId) : undefined,
+        tasks: run.taskIdentifier,
+      }),
+      superScopes: ["read:runs", "read:all", "admin"],
+    },
+  },
+  async ({ resource: run }) => {
+    const traceSummary = await eventRepository.getTraceSummary(
+      getTaskEventStoreTableForRun(run),
+      run.traceId,
+      run.createdAt,
+      run.completedAt ?? undefined
+    );
+
+    if (!traceSummary) {
+      return json({ error: "Trace not found" }, { status: 404 });
+    }
+
+    return json(
+      {
+        trace: traceSummary,
+      },
+      { status: 200 }
+    );
+  }
+);

packages/cli-v3/src/commands/mcp.ts

@@ -1,5 +1,8 @@
+import { intro, outro } from "@clack/prompts";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { VERSION } from "@trigger.dev/core";
+import { tryCatch } from "@trigger.dev/core/utils";
 import { Command } from "commander";
 import { z } from "zod";
 import { CommonCommandOptions, commonOptions, wrapCommandAction } from "../cli/common.js";
@@ -8,22 +11,19 @@ import { McpContext } from "../mcp/context.js";
 import { FileLogger } from "../mcp/logger.js";
 import {
   registerCreateProjectTool,
+  registerDeployTool,
+  registerGetRunDetailsTool,
   registerGetTasksTool,
   registerInitializeProjectTool,
   registerListOrgsTool,
   registerListProjectsTool,
+  registerListRunsTool,
   registerSearchDocsTool,
   registerTriggerTaskTool,
-  registerGetRunDetailsTool,
-  registerDeployTool,
-  registerListRunsTool,
 } from "../mcp/tools.js";
+import { printStandloneInitialBanner } from "../utilities/initialBanner.js";
 import { logger } from "../utilities/logger.js";
-import { intro, outro } from "@clack/prompts";
 import { installMcpServer } from "./install-mcp.js";
-import { tryCatch } from "@trigger.dev/core/utils";
-import { VERSION } from "@trigger.dev/core";
-import { printStandloneInitialBanner } from "../utilities/initialBanner.js";
 
 const McpCommandOptions = CommonCommandOptions.extend({
   projectRef: z.string().optional(),

packages/cli-v3/src/mcp/tools.ts

@@ -536,15 +536,22 @@ export function registerGetRunDetailsTool(context: McpContext) {
           .describe("The branch to trigger the task in, only used for preview environments")
           .optional(),
         runId: z.string().describe("The ID of the run to get the details of, starts with run_"),
+        debugMode: z
+          .boolean()
+          .describe(
+            "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."
+          )
+          .optional(),
       },
     },
-    async ({ projectRef, configPath, environment, branch, runId }) => {
+    async ({ projectRef, configPath, environment, branch, runId, debugMode }) => {
       context.logger?.log("calling get_run_details", {
         projectRef,
         configPath,
         environment,
         branch,
         runId,
+        debugMode,
       });
 
       if (context.options.devOnly && environment !== "dev") {
@@ -582,13 +589,31 @@ export function registerGetRunDetailsTool(context: McpContext) {
         return respondWithError("Failed to create API client with public JWT");
       }
 
-      const result = await apiClient.retrieveRun(runId);
+      if (debugMode) {
+        const [runResult, traceResult] = await Promise.all([
+          apiClient.retrieveRun(runId),
+          apiClient.retrieveRunTrace(runId),
+        ]);
 
-      const runUrl = `${auth.dashboardUrl}/projects/v3/${$projectRef}/runs/${result.id}`;
+        const runUrl = `${auth.dashboardUrl}/projects/v3/${$projectRef}/runs/${runResult.id}`;
 
-      return {
-        content: [{ type: "text", text: JSON.stringify({ ...result, runUrl }, null, 2) }],
-      };
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({ ...runResult, runUrl, trace: traceResult }, null, 2),
+            },
+          ],
+        };
+      } else {
+        const runResult = await apiClient.retrieveRun(runId);
+
+        const runUrl = `${auth.dashboardUrl}/projects/v3/${$projectRef}/runs/${runResult.id}`;
+
+        return {
+          content: [{ type: "text", text: JSON.stringify({ ...runResult, runUrl }, null, 2) }],
+        };
+      }
     }
   );
 }
@@ -1208,3 +1233,28 @@ To view the project dashboard, visit: ${auth.dashboardUrl}/projects/v3/${project
 
 ${text}`;
 }
+
+async function getWritingTasksGuide(prompt: string) {
+  const urls = [
+    "https://trigger.dev/docs/tasks/overview.md",
+    "https://trigger.dev/docs/tasks/schemaTask.md",
+    "https://trigger.dev/docs/tasks/scheduled.md",
+    "https://trigger.dev/docs/triggering.md",
+    "https://trigger.dev/docs/writing-tasks-introduction.md",
+  ];
+
+  const responses = await Promise.all(urls.map((url) => fetch(url)));
+  const texts = await Promise.all(responses.map((response) => response.text()));
+
+  const text = texts.join("\n\n");
+
+  return `
+## Trigger.dev Task Writing Guide:
+
+${text}
+
+## Now please write the tasks based on the following prompt:
+
+${prompt}
+`;
+}

packages/core/src/v3/apiClient/index.ts

@@ -339,6 +339,18 @@ export class ApiClient {
     );
   }
 
+  retrieveRunTrace(runId: string, requestOptions?: ZodFetchOptions) {
+    return zodfetch(
+      z.any(), // TODO: define a proper schema for this
+      `${this.baseUrl}/api/v1/runs/${runId}/trace`,
+      {
+        method: "GET",
+        headers: this.#getHeaders(false),
+      },
+      mergeRequestOptions(this.defaultRequestOptions, requestOptions)
+    );
+  }
+
   listRuns(
     query?: ListRunsQueryParams,
     requestOptions?: ZodFetchOptions