zephyr-scale-mcp-server 0.2.9 → 0.3.1

package/README.md

@@ -68,7 +68,7 @@ The server automatically detects your Jira environment and uses the appropriate
 - **Jira Cloud**: Uses Zephyr Scale API v2.
 - **Jira Data Center**: Uses Zephyr Scale API v1.
 
-This may result in slightly different behavior for some tools, such as `add_test_cases_to_run`.
+Some tools are platform-specific. For example, `add_test_cases_to_run` is only available on Cloud, as the Data Center API (v1) does not support modifying test runs after creation.
 
 ### Resource System
 The server provides access to various resources through URI schemes:
@@ -88,11 +88,12 @@ The server provides access to various resources through URI schemes:
 - `create_test_run`: Create a new test run.
 - `get_test_run`: Get detailed information about a specific test run.
 - `get_test_run_cases`: Get test case keys from a test run.
-- `add_test_cases_to_run`: Add test cases to an existing test run.
+- `add_test_cases_to_run`: Add test cases to an existing test run. *(Cloud only)*
 
 ### Test Execution & Search
 - `get_test_execution`: Get detailed individual test execution results.
 - `search_test_cases_by_folder`: Search for test cases in a specific folder.
+- `search_test_runs`: Search for test runs by project key and/or folder path.
 
 ### Organization
 - `create_folder`: Create a new folder in Zephyr Scale.

package/build/index.js

@@ -14,7 +14,7 @@ class ZephyrServer {
         const jiraConfig = createJiraConfig();
         this.server = new Server({
             name: 'zephyr-server',
-            version: '0.2.9',
+            version: '0.3.1',
         }, {
             capabilities: {
                 tools: {},
@@ -63,6 +63,8 @@ class ZephyrServer {
                         return await this.toolHandlers.getTestExecution(args);
                     case 'search_test_cases_by_folder':
                         return await this.toolHandlers.searchTestCasesByFolder(args);
+                    case 'search_test_runs':
+                        return await this.toolHandlers.searchTestRuns(args);
                     case 'add_test_cases_to_run':
                         return await this.toolHandlers.addTestCasesToRun(args);
                     default:

package/build/tool-handlers.js

@@ -490,50 +490,85 @@ export class ZephyrToolHandlers {
             throw new McpError(ErrorCode.InternalError, `Failed to search test cases by folder: ${errorMessage}`);
         }
     }
-    async addTestCasesToRun(args) {
-        const { test_run_key, test_case_keys } = args;
+    async searchTestRuns(args) {
+        const { project_key, folder, max_results = 200, fields } = args;
+        // Build query string per Zephyr Scale API docs
+        const queryParts = [];
+        if (project_key)
+            queryParts.push(`projectKey = "${project_key}"`);
+        if (folder)
+            queryParts.push(`folder = "${folder}"`);
+        if (queryParts.length === 0) {
+            throw new McpError(ErrorCode.InvalidParams, 'At least one of project_key or folder must be provided.');
+        }
+        const query = queryParts.join(' AND ');
+        const params = { query, maxResults: max_results };
+        if (fields)
+            params.fields = fields;
+        const searchEndpoint = this.jiraConfig.type === 'cloud'
+            ? '/testruns/search'
+            : '/rest/atm/1.0/testrun/search';
         try {
-            // For Data Center, we need to get the current items and then update
-            if (this.jiraConfig.type === 'datacenter') {
-                const getResponse = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`);
-                const existingItems = getResponse.data.items || [];
-                const existingKeys = new Set(existingItems.map((item) => item.testCaseKey));
-                const newItems = test_case_keys
-                    .filter(key => !existingKeys.has(key))
-                    .map(key => ({ testCaseKey: key, testResultStatus: 'Not Executed' }));
-                if (newItems.length > 0) {
-                    let response;
-                    if (this.jiraConfig.type === 'datacenter') {
-                        const minimalPayload = {
-                            items: [...existingItems, ...newItems]
-                        };
-                        response = await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`, minimalPayload);
-                    }
-                    else {
-                        const postPayload = { items: newItems.map(item => item.testCaseKey) };
-                        response = await this.axiosInstance.post(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}/testcases`, postPayload);
-                    }
-                    if (response.status === 200 || response.status === 201 || response.status === 204) {
-                        return {
-                            content: [{ type: 'text', text: `Added ${newItems.length} new test cases to test run ${test_run_key}.` }],
-                        };
-                    }
-                }
-                else {
-                    return {
-                        content: [{ type: 'text', text: 'All specified test cases are already in the test run.' }],
-                    };
-                }
+            const response = await this.axiosInstance.get(searchEndpoint, { params });
+            let testRuns = [];
+            if (Array.isArray(response.data)) {
+                testRuns = response.data;
+            }
+            else if (response.data.values && Array.isArray(response.data.values)) {
+                testRuns = response.data.values;
+            }
+            else if (response.data.results && Array.isArray(response.data.results)) {
+                testRuns = response.data.results;
+            }
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `✅ Found ${testRuns.length} test run(s) matching query "${query}":\n${JSON.stringify({
+                            query,
+                            totalCount: testRuns.length,
+                            testRuns: testRuns.map((tr) => ({
+                                key: tr.key,
+                                name: tr.name,
+                                status: tr.status,
+                                folder: tr.folder,
+                                testCaseCount: tr.testCaseCount,
+                                issueKey: tr.issueKey,
+                            }))
+                        }, null, 2)}`,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            let errorMessage = 'Unknown error';
+            if (error instanceof Error && 'response' in error) {
+                const axiosError = error;
+                errorMessage = `Status: ${axiosError.response?.status}, Data: ${JSON.stringify(axiosError.response?.data)}`;
+            }
+            else if (error instanceof Error) {
+                errorMessage = error.message;
             }
             else {
-                // For Cloud, we can just post the new test case keys
-                const fullPayload = { items: test_case_keys };
-                const response = await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`, fullPayload);
-                if (response.status === 200 || response.status === 204) {
-                    return {
-                        content: [{ type: 'text', text: `Successfully updated test cases for test run ${test_run_key}.` }],
-                    };
-                }
+                errorMessage = String(error);
+            }
+            throw new McpError(ErrorCode.InternalError, `Failed to search test runs: ${errorMessage}`);
+        }
+    }
+    async addTestCasesToRun(args) {
+        const { test_run_key, test_case_keys } = args;
+        if (this.jiraConfig.type === 'datacenter') {
+            throw new McpError(ErrorCode.InvalidRequest, 'add_test_cases_to_run is only supported on Zephyr Scale Cloud. The Data Center API (v1) does not provide an endpoint to modify test runs after creation.');
+        }
+        try {
+            const payload = {
+                items: test_case_keys.map(key => ({ testCaseKey: key }))
+            };
+            const response = await this.axiosInstance.post(`/testcycles/${test_run_key}/testcases`, payload);
+            if (response.status === 200 || response.status === 201 || response.status === 204) {
+                return {
+                    content: [{ type: 'text', text: `Added ${test_case_keys.length} test case(s) to test run ${test_run_key}.` }],
+                };
             }
         }
         catch (error) {

package/build/tool-schemas.js

@@ -347,9 +347,35 @@ export const toolSchemas = [
             required: ['project_key', 'folder_path'],
         },
     },
+    {
+        name: 'search_test_runs',
+        description: 'Search for test runs using a query. Supports filtering by projectKey and/or folder path.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                project_key: {
+                    type: 'string',
+                    description: 'Project key to filter by (e.g., "PROJ"). Can be a single key or omitted if using folder only.',
+                },
+                folder: {
+                    type: 'string',
+                    description: 'Folder path to filter test runs by (e.g., "/MyFolder/SubFolder")',
+                },
+                max_results: {
+                    type: 'number',
+                    description: 'Maximum number of results to return (optional, default 200)',
+                    default: 200,
+                },
+                fields: {
+                    type: 'string',
+                    description: 'Comma-separated list of fields to include in the response (optional, e.g., "key,name,status,folder"). If not set, all fields are returned.',
+                },
+            },
+        },
+    },
     {
         name: 'add_test_cases_to_run',
-        description: 'Add test cases to an existing test run',
+        description: 'Add test cases to an existing test run (Cloud only — not supported on Data Center)',
         inputSchema: {
             type: 'object',
             properties: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-scale-mcp-server",
-  "version": "0.2.9",
+  "version": "0.3.1",
   "description": "Model Context Protocol (MCP) server for Zephyr Scale test case management with comprehensive STEP_BY_STEP, PLAIN_TEXT, and BDD support",
   "type": "module",
   "main": "./build/index.js",
@@ -22,6 +22,7 @@
     "test": "node test/run-tests.cjs",
     "test:unit": "node test/zephyr-server.test.cjs",
     "test:integration": "node test/integration.test.cjs",
+    "report:weekly": "node scripts/weekly-report.cjs",
     "prepublishOnly": "npm run build"
   },
   "keywords": [

package/src/index.ts

@@ -25,7 +25,7 @@ class ZephyrServer {
     this.server = new Server(
       {
         name: 'zephyr-server',
-        version: '0.2.9',
+        version: '0.3.1',
       },
       {
         capabilities: {
@@ -83,6 +83,8 @@ class ZephyrServer {
             return await this.toolHandlers.getTestExecution(args);
           case 'search_test_cases_by_folder':
             return await this.toolHandlers.searchTestCasesByFolder(args as any);
+          case 'search_test_runs':
+            return await this.toolHandlers.searchTestRuns(args as any);
           case 'add_test_cases_to_run':
             return await this.toolHandlers.addTestCasesToRun(args as any);
           default:

package/src/tool-handlers.ts

@@ -7,6 +7,7 @@ import {
   TestRunArgs,
   SearchTestCasesArgs,
   AddTestCasesToRunArgs,
+  SearchTestRunsArgs,
   JiraConfig
 } from './types.js';
 import { convertToGherkin, customPriorityMapping, priorityMapping } from './utils.js';
@@ -542,52 +543,91 @@ export class ZephyrToolHandlers {
     }
   }
 
+  async searchTestRuns(args: SearchTestRunsArgs) {
+    const { project_key, folder, max_results = 200, fields } = args;
+
+    // Build query string per Zephyr Scale API docs
+    const queryParts: string[] = [];
+    if (project_key) queryParts.push(`projectKey = "${project_key}"`);
+    if (folder) queryParts.push(`folder = "${folder}"`);
+
+    if (queryParts.length === 0) {
+      throw new McpError(ErrorCode.InvalidParams, 'At least one of project_key or folder must be provided.');
+    }
+
+    const query = queryParts.join(' AND ');
+    const params: Record<string, any> = { query, maxResults: max_results };
+    if (fields) params.fields = fields;
+
+    const searchEndpoint = this.jiraConfig.type === 'cloud'
+      ? '/testruns/search'
+      : '/rest/atm/1.0/testrun/search';
+
+    try {
+      const response = await this.axiosInstance.get(searchEndpoint, { params });
+
+      let testRuns: any[] = [];
+      if (Array.isArray(response.data)) {
+        testRuns = response.data;
+      } else if (response.data.values && Array.isArray(response.data.values)) {
+        testRuns = response.data.values;
+      } else if (response.data.results && Array.isArray(response.data.results)) {
+        testRuns = response.data.results;
+      }
+
+      return {
+        content: [
+          {
+            type: 'text',
+            text: `✅ Found ${testRuns.length} test run(s) matching query "${query}":\n${JSON.stringify({
+              query,
+              totalCount: testRuns.length,
+              testRuns: testRuns.map((tr: any) => ({
+                key: tr.key,
+                name: tr.name,
+                status: tr.status,
+                folder: tr.folder,
+                testCaseCount: tr.testCaseCount,
+                issueKey: tr.issueKey,
+              }))
+            }, null, 2)}`,
+          },
+        ],
+      };
+    } catch (error) {
+      let errorMessage = 'Unknown error';
+      if (error instanceof Error && 'response' in error) {
+        const axiosError = error as any;
+        errorMessage = `Status: ${axiosError.response?.status}, Data: ${JSON.stringify(axiosError.response?.data)}`;
+      } else if (error instanceof Error) {
+        errorMessage = error.message;
+      } else {
+        errorMessage = String(error);
+      }
+      throw new McpError(ErrorCode.InternalError, `Failed to search test runs: ${errorMessage}`);
+    }
+  }
+
   async addTestCasesToRun(args: AddTestCasesToRunArgs) {
     const { test_run_key, test_case_keys } = args;
 
+    if (this.jiraConfig.type === 'datacenter') {
+      throw new McpError(
+        ErrorCode.InvalidRequest,
+        'add_test_cases_to_run is only supported on Zephyr Scale Cloud. The Data Center API (v1) does not provide an endpoint to modify test runs after creation.'
+      );
+    }
+
     try {
-      // For Data Center, we need to get the current items and then update
-      if (this.jiraConfig.type === 'datacenter') {
-        const getResponse = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`);
-        const existingItems = getResponse.data.items || [];
-        const existingKeys = new Set(existingItems.map((item: any) => item.testCaseKey));
-
-        const newItems = test_case_keys
-          .filter(key => !existingKeys.has(key))
-          .map(key => ({ testCaseKey: key, testResultStatus: 'Not Executed' }));
-
-        if (newItems.length > 0) {
-          let response;
-          if (this.jiraConfig.type === 'datacenter') {
-            const minimalPayload = {
-              items: [...existingItems, ...newItems]
-            };
-            response = await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`, minimalPayload);
-          } else {
-            const postPayload = { items: newItems.map(item => item.testCaseKey) };
-            response = await this.axiosInstance.post(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}/testcases`, postPayload);
-          }
+      const payload = {
+        items: test_case_keys.map(key => ({ testCaseKey: key }))
+      };
+      const response = await this.axiosInstance.post(`/testcycles/${test_run_key}/testcases`, payload);
 
-          if (response.status === 200 || response.status === 201 || response.status === 204) {
-            return {
-              content: [{ type: 'text', text: `Added ${newItems.length} new test cases to test run ${test_run_key}.` }],
-            };
-          }
-        } else {
-          return {
-            content: [{ type: 'text', text: 'All specified test cases are already in the test run.' }],
-          };
-        }
-      } else {
-        // For Cloud, we can just post the new test case keys
-        const fullPayload = { items: test_case_keys };
-        const response = await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`, fullPayload);
-
-        if (response.status === 200 || response.status === 204) {
-          return {
-            content: [{ type: 'text', text: `Successfully updated test cases for test run ${test_run_key}.` }],
-          };
-        }
+      if (response.status === 200 || response.status === 201 || response.status === 204) {
+        return {
+          content: [{ type: 'text', text: `Added ${test_case_keys.length} test case(s) to test run ${test_run_key}.` }],
+        };
       }
     } catch (error) {
       throw new McpError(ErrorCode.InternalError, `Failed to add test cases: ${error instanceof Error ? error.message : String(error)}`);

package/src/tool-schemas.ts

@@ -347,9 +347,35 @@ export const toolSchemas = [
       required: ['project_key', 'folder_path'],
     },
   },
+  {
+    name: 'search_test_runs',
+    description: 'Search for test runs using a query. Supports filtering by projectKey and/or folder path.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        project_key: {
+          type: 'string',
+          description: 'Project key to filter by (e.g., "PROJ"). Can be a single key or omitted if using folder only.',
+        },
+        folder: {
+          type: 'string',
+          description: 'Folder path to filter test runs by (e.g., "/MyFolder/SubFolder")',
+        },
+        max_results: {
+          type: 'number',
+          description: 'Maximum number of results to return (optional, default 200)',
+          default: 200,
+        },
+        fields: {
+          type: 'string',
+          description: 'Comma-separated list of fields to include in the response (optional, e.g., "key,name,status,folder"). If not set, all fields are returned.',
+        },
+      },
+    },
+  },
   {
     name: 'add_test_cases_to_run',
-    description: 'Add test cases to an existing test run',
+    description: 'Add test cases to an existing test run (Cloud only — not supported on Data Center)',
     inputSchema: {
       type: 'object',
       properties: {

package/src/types.ts

@@ -79,6 +79,13 @@ export interface AddTestCasesToRunArgs {
   test_case_keys: string[];
 }
 
+export interface SearchTestRunsArgs {
+  project_key?: string;
+  folder?: string;
+  max_results?: number;
+  fields?: string;
+}
+
 export type JiraType = 'cloud' | 'datacenter';
 
 export interface ApiEndpoints {