list_testcase

Instructions

Implementation Reference

• src/tools/testcases/list-testcase.ts:178-298 (handler)

  The main handler function for list_testcase tool. Builds query params from args, makes API request to the list-testcase endpoint, and returns the JSON response.

  export async function handleListTestCases(args?: ListTestCasesArgs) {
    // 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."
      );
    }
  
    // Validate that at least one identifier is provided
    // Test run filters that don't require testrun_id or counter:
    // by_branch, by_commit, by_author, by_environment, by_time_interval, by_pages, page, limit, get_all
    const hasTestRunId = !!args?.by_testrun_id;
    const hasCounter = args?.counter !== undefined;
    const hasTestRunFilters = !!(
      args?.by_branch ||
      args?.by_commit ||
      args?.by_author ||
      args?.by_environment ||
      args?.by_time_interval ||
      args?.by_pages !== undefined ||
      args?.page !== undefined ||
      args?.limit !== undefined ||
      args?.get_all !== undefined
    );
  
    if (!hasTestRunId && !hasCounter && !hasTestRunFilters) {
      throw new Error(
        "At least one of the following must be provided: by_testrun_id, counter, or any test run filter (by_branch, by_commit, by_author, by_environment, by_time_interval, by_pages, page, limit, get_all)"
      );
    }
  
    try {
      const params: ListTestCasesParams = {
        projectId: String(args.projectId),
      };
  
      if (args?.by_testrun_id) {
        params.by_testrun_id = String(args.by_testrun_id);
      }
      if (args?.counter !== undefined) {
        params.counter = Number(args.counter);
      }
      if (args?.by_status) {
        params.by_status = String(args.by_status);
      }
      if (args?.by_spec_file_name) {
        params.by_spec_file_name = String(args.by_spec_file_name);
      }
      if (args?.by_error_category) {
        params.by_error_category = String(args.by_error_category);
      }
      if (args?.by_browser_name) {
        params.by_browser_name = String(args.by_browser_name);
      }
      if (args?.by_tag) {
        params.by_tag = String(args.by_tag);
      }
      if (args?.by_total_runtime) {
        params.by_total_runtime = String(args.by_total_runtime);
      }
      if (args?.by_artifacts !== undefined) {
        params.by_artifacts = String(args.by_artifacts);
      }
      if (args?.by_error_message) {
        params.by_error_message = String(args.by_error_message);
      }
      if (args?.by_attempt_number !== undefined) {
        params.by_attempt_number = Number(args.by_attempt_number);
      }
      if (args?.by_pages !== undefined) {
        params.by_pages = Number(args.by_pages);
      }
      if (args?.by_branch) {
        params.by_branch = String(args.by_branch);
      }
      if (args?.by_time_interval) {
        params.by_time_interval = String(args.by_time_interval);
      }
      if (args?.limit !== undefined) {
        params.limit = Number(args.limit);
      }
      if (args?.by_environment) {
        params.by_environment = String(args.by_environment);
      }
      if (args?.by_author) {
        params.by_author = String(args.by_author);
      }
      if (args?.by_commit) {
        params.by_commit = String(args.by_commit);
      }
      if (args?.page !== undefined) {
        params.page = Number(args.page);
      }
      if (args?.get_all !== undefined) {
        params.get_all = String(args.get_all);
      }
  
      const listTestCasesUrl = endpoints.listTestCases(params);
  
      const response = await apiRequestJson<unknown>(listTestCasesUrl, {
        headers: {
          Authorization: `Bearer ${token}`,
        },
      });
  
      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 list test cases: ${errorMessage}`);
    }
  }

• src/tools/testcases/list-testcase.ts:55-57 (schema)

  Tool definition object with name 'list_testcase', description, and full inputSchema defining all filter parameters (projectId, by_testrun_id, counter, by_status, by_spec_file_name, by_error_category, by_browser_name, by_tag, by_total_runtime, by_artifacts, by_error_message, by_attempt_number, by_pages, by_branch, by_time_interval, limit, by_environment, by_author, by_commit, page, get_all). Only projectId is required.

  }
  
  export const listTestCasesTool = {

• src/tools/testcases/list-testcase.ts:33-55 (schema)

  Internal ListTestCasesParams interface used to construct the API query parameters.

  interface ListTestCasesParams {
    projectId: string;
    by_testrun_id?: string;
    counter?: number;
    by_status?: string;
    by_spec_file_name?: string;
    by_error_category?: string;
    by_browser_name?: string;
    by_tag?: string;
    by_total_runtime?: string;
    by_artifacts?: string;
    by_error_message?: string;
    by_attempt_number?: number;
    by_pages?: number;
    by_branch?: string;
    by_time_interval?: string;
    limit?: number;
    by_environment?: string;
    by_author?: string;
    by_commit?: string;
    page?: number;
    get_all?: string;
  }

• src/tools/testcases/list-testcase.ts:9-31 (schema)

  ListTestCasesArgs interface defining the accepted input argument types for the handler.

  interface ListTestCasesArgs {
    projectId: string;
    by_testrun_id?: string;
    counter?: number;
    by_status?: "passed" | "failed" | "skipped" | "flaky";
    by_spec_file_name?: string;
    by_error_category?: string;
    by_browser_name?: string;
    by_tag?: string;
    by_total_runtime?: string;
    by_artifacts?: boolean;
    by_error_message?: string;
    by_attempt_number?: number;
    by_pages?: number;
    by_branch?: string;
    by_time_interval?: string;
    limit?: number;
    by_environment?: string;
    by_author?: string;
    by_commit?: string;
    page?: number;
    get_all?: boolean;
  }

• src/index.ts:213-217 (registration)

  Registration of 'list_testcase' in the CallToolRequestSchema handler, routing the tool name to handleListTestCases.

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