zephyr-scale-mcp-server/src/types.ts

Model Context Protocol (MCP) server for Zephyr Scale test case management with comprehensive STEP_BY_STEP, PLAIN_TEXT, and BDD support

export interface TestStep {
  description?: string;
  testData?: string;
  expectedResult?: string;
  testCaseKey?: string;
}

export interface TestScript {
  type: 'STEP_BY_STEP' | 'PLAIN_TEXT' | 'BDD';
  steps?: TestStep[];
  text?: string;
}

export interface TestParameter {
  name: string;
  type: 'FREE_TEXT' | 'DATA_SET';
  dataSet?: string;
}

export interface TestParameters {
  variables: TestParameter[];
  entries: Record<string, any>[];
}

export interface TestCaseArgs {
  project_key: string;
  name: string;
  test_script?: TestScript;
  folder?: string;
  status?: 'Draft' | 'Approved' | 'Deprecated';
  priority?: 'High' | 'Normal' | 'Low';
  precondition?: string;
  objective?: string;
  component?: string;
  owner?: string;
  estimated_time?: number;
  labels?: string[];
  issue_links?: string[];
  custom_fields?: Record<string, any>;
  parameters?: TestParameters;
}


export interface UpdateBddArgs {
  test_case_key: string;
  bdd_content: string;
}

export interface FolderArgs {
  project_key: string;
  name: string;
  parent_folder_path?: string;
  folder_type?: 'TEST_CASE' | 'TEST_PLAN' | 'TEST_RUN';
}

export interface TestRunArgs {
  project_key: string;
  name: string;
  test_case_keys?: string[];
  test_plan_key?: string;
  folder?: string;
  planned_start_date?: string;
  planned_end_date?: string;
  description?: string;
  owner?: string;
  environment?: string;
  custom_fields?: Record<string, any>;
}

export interface SearchTestCasesArgs {
  project_key: string;
  folder_path: string;
  max_results?: number;
}

export interface AddTestCasesToRunArgs {
  test_run_key: string;
  test_case_keys: string[];
}