zephyr-scale-mcp-server 0.6.0 → 0.7.0

package/README.md

@@ -107,12 +107,14 @@ The server provides access to various resources through URI schemes:
 
 ### Test Run Management
 - `create_test_run`: Create a new test run.
-- `get_test_run`: Get detailed information about a specific test run.
+- `get_test_run`: Get detailed information about a specific test run, including resolved status name.
+- `update_test_run`: Update an existing test cycle — set owner, name, description, dates, or status. *(Cloud only)*
 - `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. *(Cloud only)*
 
 ### Test Execution & Search
 - `get_test_execution`: Get detailed individual test execution results.
+- `list_executions_by_cycle`: List all test executions for a specific test cycle with status, executor, and date. *(Cloud only)*
 - `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.
 

package/build/index.js

@@ -51,6 +51,8 @@ class ZephyrServer {
                         return await this.toolHandlers.updateTestCaseBdd(args);
                     case 'create_folder':
                         return await this.toolHandlers.createFolder(args);
+                    case 'get_folders':
+                        return await this.toolHandlers.getFolders(args);
                     case 'get_test_run_cases':
                         return await this.toolHandlers.getTestRunCases(args);
                     case 'delete_test_case':

package/build/tool-handlers.js

@@ -743,6 +743,79 @@ export class ZephyrToolHandlers {
             throw new McpError(ErrorCode.InternalError, `Failed to create test run: ${this.formatError(error)}`);
         }
     }
+    async getFolders(args) {
+        const { project_key, folder_type, folder_path, max_results } = args;
+        try {
+            const pageSize = 1000;
+            const allFolders = [];
+            let startAt = 0;
+            let isLast = false;
+            while (!isLast) {
+                const params = { maxResults: pageSize, startAt };
+                if (project_key)
+                    params.projectKey = project_key;
+                if (folder_type)
+                    params.folderType = folder_type;
+                const response = await this.axiosInstance.get('/folders', { params });
+                const page = Array.isArray(response.data)
+                    ? response.data
+                    : response.data?.values ?? [];
+                allFolders.push(...page);
+                isLast = response.data?.isLast === true || page.length < pageSize;
+                startAt += page.length;
+                if (max_results && allFolders.length >= max_results)
+                    break;
+            }
+            let results;
+            if (folder_path) {
+                // Resolve the root folder ID from the path, then collect full subtree via BFS
+                const rootId = await resolveFolderIdByPath(this.axiosInstance, project_key, folder_path, folder_type ?? 'TEST_CASE');
+                if (rootId === null) {
+                    return {
+                        content: [{
+                                type: 'text',
+                                text: `⚠️ Folder not found: "${folder_path}" in project ${project_key}.`,
+                            }],
+                    };
+                }
+                // BFS over the already-fetched flat list — no extra API calls
+                const subtreeIds = new Set([rootId]);
+                const queue = [rootId];
+                while (queue.length > 0) {
+                    const current = queue.shift();
+                    for (const f of allFolders) {
+                        if ((f.parentId ?? null) === current && !subtreeIds.has(f.id)) {
+                            subtreeIds.add(f.id);
+                            queue.push(f.id);
+                        }
+                    }
+                }
+                results = allFolders.filter(f => subtreeIds.has(f.id));
+            }
+            else {
+                results = allFolders;
+            }
+            if (max_results)
+                results = results.slice(0, max_results);
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify({
+                            totalCount: results.length,
+                            folders: results.map((f) => ({
+                                id: f.id,
+                                name: f.name,
+                                parentId: f.parentId ?? null,
+                                folderType: f.folderType,
+                            })),
+                        }, null, 2),
+                    }],
+            };
+        }
+        catch (error) {
+            throw new McpError(ErrorCode.InternalError, `Failed to get folders: ${this.formatError(error)}`);
+        }
+    }
     async resolveStatusName(statusId) {
         try {
             const response = await this.axiosInstance.get(`/statuses/${statusId}`);
@@ -837,12 +910,27 @@ export class ZephyrToolHandlers {
                             }],
                     };
                 }
-                const response = await this.axiosInstance.get(this.jiraConfig.apiEndpoints.testcase, {
-                    params: { projectKey: project_key, folderId, maxResults: max_results },
-                });
-                const testCases = Array.isArray(response.data)
-                    ? response.data
-                    : response.data?.values ?? [];
+                // Paginate through all results — the API returns up to 1000 per page
+                const pageSize = Math.min(max_results, 1000);
+                const allTestCases = [];
+                let startAt = 0;
+                let isLast = false;
+                while (!isLast && allTestCases.length < max_results) {
+                    const response = await this.axiosInstance.get(this.jiraConfig.apiEndpoints.testcase, {
+                        params: { projectKey: project_key, folderId, maxResults: pageSize, startAt },
+                    });
+                    const page = Array.isArray(response.data)
+                        ? response.data
+                        : response.data?.values ?? [];
+                    allTestCases.push(...page);
+                    // Stop if the API signals last page, or we got fewer results than requested
+                    isLast = response.data?.isLast === true || page.length < pageSize;
+                    startAt += page.length;
+                    // Safety: never exceed max_results
+                    if (allTestCases.length >= max_results)
+                        break;
+                }
+                const testCases = allTestCases.slice(0, max_results);
                 return {
                     content: [{
                             type: 'text',

package/build/tool-schemas.js

@@ -196,6 +196,32 @@ export const toolSchemas = [
             required: ['project_key', 'name'],
         },
     },
+    {
+        name: 'get_folders',
+        description: 'Get folders from Zephyr Scale. All parameters are optional. If folder_path is provided, returns the full subtree (the folder and all its descendants at every depth) under that path. Otherwise returns all folders matching the filters.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                project_key: {
+                    type: 'string',
+                    description: 'Jira project key filter (e.g., "PROJ"). Optional.',
+                },
+                folder_type: {
+                    type: 'string',
+                    description: 'Folder type filter (optional)',
+                    enum: ['TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE'],
+                },
+                folder_path: {
+                    type: 'string',
+                    description: 'Folder path to filter by (e.g., "/CRM on Wechat"). Returns the matching folder and all folders nested beneath it at any depth. Requires project_key and folder_type to resolve the path.',
+                },
+                max_results: {
+                    type: 'number',
+                    description: 'Maximum total number of folders to return (optional). Defaults to all folders.',
+                },
+            },
+        },
+    },
     {
         name: 'get_test_run_cases',
         description: 'Get test case keys from a test run',

package/build/utils.js

@@ -4,18 +4,27 @@ export async function resolveFolderIdByPath(axiosInstance, projectKey, folderPat
     if (segments.length === 0)
         return null;
     try {
-        // Fetch all folders for the project + type (up to 1000)
-        const response = await axiosInstance.get('/folders', {
-            params: { projectKey, folderType, maxResults: 1000 },
-        });
-        const folders = Array.isArray(response.data)
-            ? response.data
-            : response.data?.values ?? [];
+        // Paginate through all folders for the project + type
+        const pageSize = 1000;
+        const allFolders = [];
+        let startAt = 0;
+        let isLast = false;
+        while (!isLast) {
+            const response = await axiosInstance.get('/folders', {
+                params: { projectKey, folderType, maxResults: pageSize, startAt },
+            });
+            const page = Array.isArray(response.data)
+                ? response.data
+                : response.data?.values ?? [];
+            allFolders.push(...page);
+            isLast = response.data?.isLast === true || page.length < pageSize;
+            startAt += page.length;
+        }
         // Walk segments top-down, matching by name under the correct parent
         let parentId = null;
         let matchedId = null;
         for (const segment of segments) {
-            const match = folders.find((f) => f.name === segment && (f.parentId ?? null) === parentId);
+            const match = allFolders.find((f) => f.name === segment && (f.parentId ?? null) === parentId);
             if (!match)
                 return null;
             matchedId = match.id;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-scale-mcp-server",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "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",

package/src/index.ts

@@ -71,6 +71,8 @@ class ZephyrServer {
             return await this.toolHandlers.updateTestCaseBdd(args as any);
           case 'create_folder':
             return await this.toolHandlers.createFolder(args as any);
+          case 'get_folders':
+            return await this.toolHandlers.getFolders(args as any);
           case 'get_test_run_cases':
             return await this.toolHandlers.getTestRunCases(args);
           case 'delete_test_case':

package/src/tool-handlers.ts

@@ -800,6 +800,90 @@ export class ZephyrToolHandlers {
     }
   }
 
+  async getFolders(args: any) {
+    const { project_key, folder_type, folder_path, max_results } = args;
+
+    try {
+      const pageSize = 1000;
+      const allFolders: any[] = [];
+      let startAt = 0;
+      let isLast = false;
+
+      while (!isLast) {
+        const params: Record<string, any> = { maxResults: pageSize, startAt };
+        if (project_key) params.projectKey = project_key;
+        if (folder_type) params.folderType = folder_type;
+
+        const response = await this.axiosInstance.get('/folders', { params });
+
+        const page: any[] = Array.isArray(response.data)
+          ? response.data
+          : response.data?.values ?? [];
+
+        allFolders.push(...page);
+
+        isLast = response.data?.isLast === true || page.length < pageSize;
+        startAt += page.length;
+
+        if (max_results && allFolders.length >= max_results) break;
+      }
+
+      let results: any[];
+
+      if (folder_path) {
+        // Resolve the root folder ID from the path, then collect full subtree via BFS
+        const rootId = await resolveFolderIdByPath(
+          this.axiosInstance, project_key, folder_path, folder_type ?? 'TEST_CASE'
+        );
+
+        if (rootId === null) {
+          return {
+            content: [{
+              type: 'text',
+              text: `⚠️ Folder not found: "${folder_path}" in project ${project_key}.`,
+            }],
+          };
+        }
+
+        // BFS over the already-fetched flat list — no extra API calls
+        const subtreeIds = new Set<number>([rootId]);
+        const queue = [rootId];
+        while (queue.length > 0) {
+          const current = queue.shift()!;
+          for (const f of allFolders) {
+            if ((f.parentId ?? null) === current && !subtreeIds.has(f.id)) {
+              subtreeIds.add(f.id);
+              queue.push(f.id);
+            }
+          }
+        }
+
+        results = allFolders.filter(f => subtreeIds.has(f.id));
+      } else {
+        results = allFolders;
+      }
+
+      if (max_results) results = results.slice(0, max_results);
+
+      return {
+        content: [{
+          type: 'text',
+          text: JSON.stringify({
+            totalCount: results.length,
+            folders: results.map((f: any) => ({
+              id: f.id,
+              name: f.name,
+              parentId: f.parentId ?? null,
+              folderType: f.folderType,
+            })),
+          }, null, 2),
+        }],
+      };
+    } catch (error) {
+      throw new McpError(ErrorCode.InternalError, `Failed to get folders: ${this.formatError(error)}`);
+    }
+  }
+
   private async resolveStatusName(statusId: number): Promise<string | null> {
     try {
       const response = await this.axiosInstance.get(`/statuses/${statusId}`);
@@ -908,13 +992,32 @@ export class ZephyrToolHandlers {
           };
         }
 
-        const response = await this.axiosInstance.get(this.jiraConfig.apiEndpoints.testcase, {
-          params: { projectKey: project_key, folderId, maxResults: max_results },
-        });
+        // Paginate through all results — the API returns up to 1000 per page
+        const pageSize = Math.min(max_results, 1000);
+        const allTestCases: any[] = [];
+        let startAt = 0;
+        let isLast = false;
 
-        const testCases = Array.isArray(response.data)
-          ? response.data
-          : response.data?.values ?? [];
+        while (!isLast && allTestCases.length < max_results) {
+          const response = await this.axiosInstance.get(this.jiraConfig.apiEndpoints.testcase, {
+            params: { projectKey: project_key, folderId, maxResults: pageSize, startAt },
+          });
+
+          const page = Array.isArray(response.data)
+            ? response.data
+            : response.data?.values ?? [];
+
+          allTestCases.push(...page);
+
+          // Stop if the API signals last page, or we got fewer results than requested
+          isLast = response.data?.isLast === true || page.length < pageSize;
+          startAt += page.length;
+
+          // Safety: never exceed max_results
+          if (allTestCases.length >= max_results) break;
+        }
+
+        const testCases = allTestCases.slice(0, max_results);
 
         return {
           content: [{

package/src/tool-schemas.ts

@@ -196,6 +196,32 @@ export const toolSchemas = [
       required: ['project_key', 'name'],
     },
   },
+  {
+    name: 'get_folders',
+    description: 'Get folders from Zephyr Scale. All parameters are optional. If folder_path is provided, returns the full subtree (the folder and all its descendants at every depth) under that path. Otherwise returns all folders matching the filters.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        project_key: {
+          type: 'string',
+          description: 'Jira project key filter (e.g., "PROJ"). Optional.',
+        },
+        folder_type: {
+          type: 'string',
+          description: 'Folder type filter (optional)',
+          enum: ['TEST_CASE', 'TEST_PLAN', 'TEST_CYCLE'],
+        },
+        folder_path: {
+          type: 'string',
+          description: 'Folder path to filter by (e.g., "/CRM on Wechat"). Returns the matching folder and all folders nested beneath it at any depth. Requires project_key and folder_type to resolve the path.',
+        },
+        max_results: {
+          type: 'number',
+          description: 'Maximum total number of folders to return (optional). Defaults to all folders.',
+        },
+      },
+    },
+  },
   {
     name: 'get_test_run_cases',
     description: 'Get test case keys from a test run',

package/src/utils.ts

@@ -11,22 +11,34 @@ export async function resolveFolderIdByPath(
   if (segments.length === 0) return null;
 
   try {
-    // Fetch all folders for the project + type (up to 1000)
-    const response = await axiosInstance.get('/folders', {
-      params: { projectKey, folderType, maxResults: 1000 },
-    });
-
-    const folders: Array<{ id: number; parentId: number | null; name: string }> =
-      Array.isArray(response.data)
-        ? response.data
-        : response.data?.values ?? [];
+    // Paginate through all folders for the project + type
+    const pageSize = 1000;
+    const allFolders: Array<{ id: number; parentId: number | null; name: string }> = [];
+    let startAt = 0;
+    let isLast = false;
+
+    while (!isLast) {
+      const response = await axiosInstance.get('/folders', {
+        params: { projectKey, folderType, maxResults: pageSize, startAt },
+      });
+
+      const page: Array<{ id: number; parentId: number | null; name: string }> =
+        Array.isArray(response.data)
+          ? response.data
+          : response.data?.values ?? [];
+
+      allFolders.push(...page);
+
+      isLast = response.data?.isLast === true || page.length < pageSize;
+      startAt += page.length;
+    }
 
     // Walk segments top-down, matching by name under the correct parent
     let parentId: number | null = null;
     let matchedId: number | null = null;
 
     for (const segment of segments) {
-      const match = folders.find(
+      const match = allFolders.find(
         (f) => f.name === segment && (f.parentId ?? null) === parentId
       );
       if (!match) return null;