get_run_details

Instructions

Implementation Reference

• src/tools/testruns/get-run-details.ts:46-97 (handler)

  The main handler function `handleGetRunDetails` that executes the tool logic. It reads the API key from env, validates projectId, builds query params, calls the API endpoint, and returns the response as text content.

  export async function handleGetRunDetails(args?: GetRunDetailsArgs) {
    // Read PAT from environment variable (set in mcp.json) or from args
    const token = getApiKey(args);
  
    if (!token) {
      throw new Error(
        "Missing TESTDINO_PAT environment variable. " +
          "Please configure it in your .cursor/mcp.json file under the 'env' section."
      );
    }
  
    if (!args?.projectId) {
      throw new Error("projectId is required");
    }
  
    try {
      // Build query parameters
      const params: GetRunDetailsParams = {
        projectId: String(args.projectId),
      };
  
      if (args.testrun_id) {
        params.testrun_id = String(args.testrun_id);
      }
  
      if (args.counter !== undefined) {
        params.counter = Number(args.counter);
      }
  
      const runDetailsUrl = endpoints.getRunDetails(params);
  
      const response = await apiRequestJson<unknown>(runDetailsUrl, {
        headers: {
          Authorization: `Bearer ${token}`,
        },
      });
  
      // Always return output directly as text content, never write to file
      // This ensures the output is displayed directly regardless of size
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response, null, 2),
          },
        ],
      };
    } catch (error) {
      const errorMessage = error instanceof Error ? error.message : String(error);
      throw new Error(`Failed to retrieve test run details: ${errorMessage}`);
    }
  }

• src/tools/testruns/get-run-details.ts:9-44 (schema)

  The tool definition `getRunDetailsTool` including input schema (projectId required, testrun_id optional, counter optional) and types `GetRunDetailsArgs` and `GetRunDetailsParams`.

  interface GetRunDetailsArgs {
    projectId: string;
    testrun_id?: string;
    counter?: number;
  }
  
  interface GetRunDetailsParams {
    projectId: string;
    testrun_id?: string;
    counter?: number;
  }
  
  export const getRunDetailsTool = {
    name: "get_run_details",
    description:
      "Get detailed information about test runs. Shows test statistics (passed, failed, skipped, flaky), all test suites and cases, git metadata, and error details. Supports batch operations (comma-separated IDs, max 20). Use this to analyze test execution health or debug specific failures.",
    inputSchema: {
      type: "object",
      properties: {
        projectId: {
          type: "string",
          description: "Project ID (Required). The TestDino project identifier.",
        },
        testrun_id: {
          type: "string",
          description:
            "Test run ID(s). Single ID or comma-separated for batch (max 20). Example: 'test_run_123' or 'run1,run2,run3'.",
        },
        counter: {
          type: "number",
          description: "Filter by test run counter (sequential number).",
        },
      },
      required: ["projectId"],
    },
  };

• src/index.ts:23-24 (registration)

  Import of `getRunDetailsTool` and `handleGetRunDetails` from the tools module in the main server entry point.

  getRunDetailsTool,
  handleGetRunDetails,

• src/index.ts:102-102 (registration)

  Tool registration: `getRunDetailsTool` is added to the tools array that gets exposed to MCP clients.

  getRunDetailsTool,

• src/index.ts:207-211 (registration)

  Tool routing: when the tool call name is 'get_run_details', it dispatches to `handleGetRunDetails` in the CallToolRequestSchema handler.

  if (name === "get_run_details") {
    return await handleGetRunDetails(
      args as Parameters<typeof handleGetRunDetails>[0]
    );
  }