zephyr-scale-mcp-server 0.4.6 → 0.5.0

package/build/tool-handlers.js

@@ -250,6 +250,18 @@ export class ZephyrToolHandlers {
                 if (!tc) {
                     throw scriptUpdateError; // no test case data to build PUT payload, surface original error
                 }
+                // Fetch the existing test script to get its ID — required for the PUT to update in place
+                let existingScriptId;
+                try {
+                    const scriptRes = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testcase}/${test_case_key}/testscript`);
+                    existingScriptId = scriptRes.data?.id;
+                }
+                catch {
+                    // no existing script — proceed without id
+                }
+                const testScriptPayload = { type: 'bdd', text: finalText };
+                if (existingScriptId)
+                    testScriptPayload.id = existingScriptId;
                 const putPayload = {
                     id: tc.id,
                     key: test_case_key,
@@ -257,7 +269,7 @@ export class ZephyrToolHandlers {
                     status: tc.status,
                     priority: tc.priority,
                     project: tc.project,
-                    testScript: { type: 'bdd', text: finalText },
+                    testScript: testScriptPayload,
                 };
                 for (const field of ['objective', 'precondition', 'estimatedTime', 'component', 'owner', 'folder']) {
                     if (tc[field] !== undefined && tc[field] !== null)
@@ -268,12 +280,15 @@ export class ZephyrToolHandlers {
                 if (tc.customFields && Object.keys(tc.customFields).length > 0)
                     putPayload.customFields = tc.customFields;
                 await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testcase}/${test_case_key}`, putPayload);
-                return {
-                    content: [{
-                            type: 'text',
-                            text: `✅ Updated ${test_case_key} with BDD content successfully (Cloud v2, via PUT fallback for migrated project)`,
-                        }],
-                };
+                // Note: the Zephyr Scale Cloud API's UpdateTestCaseInput does not include a testScript field,
+                // so the testScript embedded in the PUT payload is silently ignored.
+                // The only endpoint that updates script content (POST /testscript) requires the project to be active.
+                // For test cases migrated from Data Center to Cloud, the original project key may be deactivated,
+                // blocking script updates at the API level. Contact your Zephyr Scale admin to re-enable the project.
+                throw new McpError(ErrorCode.InternalError, `Cannot update test script for ${test_case_key}: the project "${test_case_key.replace(/-T\d+$/, '')}" is deactivated in Zephyr Scale Cloud. ` +
+                    `This test case was likely migrated from Data Center and retains its original project key prefix. ` +
+                    `POST /testcases/{key}/testscript requires an active project. ` +
+                    `Please ask your Zephyr Scale admin to re-enable the project, or recreate this test case under an active Cloud project.`);
             }
             // Primary path succeeded — optionally rename
             if (typeof name === 'string' && name.trim().length > 0) {
@@ -793,9 +808,9 @@ export class ZephyrToolHandlers {
         }
     }
     async searchTestRuns(args) {
-        const { project_key, folder, max_results = 200, fields } = args;
-        if (!project_key && !folder) {
-            throw new McpError(ErrorCode.InvalidParams, 'At least one of project_key or folder must be provided.');
+        const { project_key, folder, folder_id, max_results = 200, fields } = args;
+        if (!project_key && !folder && !folder_id) {
+            throw new McpError(ErrorCode.InvalidParams, 'At least one of project_key, folder, or folder_id must be provided.');
         }
         if (this.jiraConfig.type === 'cloud') {
             try {
@@ -803,7 +818,11 @@ export class ZephyrToolHandlers {
                 const params = { maxResults: max_results };
                 if (project_key)
                     params.projectKey = project_key;
-                if (folder && project_key) {
+                // folder_id takes precedence over folder path
+                if (folder_id) {
+                    params.folderId = folder_id;
+                }
+                else if (folder && project_key) {
                     const folderId = await resolveFolderIdByPath(this.axiosInstance, project_key, folder, 'TEST_CYCLE');
                     if (folderId !== null)
                         params.folderId = folderId;

package/build/tool-schemas.js

@@ -351,7 +351,7 @@ export const toolSchemas = [
     },
     {
         name: 'search_test_runs',
-        description: 'Search for test runs using a query. Supports filtering by projectKey and/or folder path.',
+        description: 'Search for test runs using a query. Supports filtering by projectKey and/or folder path. On Cloud, only returns cycles in the exact folder (not sub-folders). Use folder_id for direct numeric ID lookup (skips path resolution).',
         inputSchema: {
             type: 'object',
             properties: {
@@ -361,7 +361,11 @@ export const toolSchemas = [
                 },
                 folder: {
                     type: 'string',
-                    description: 'Folder path to filter test runs by (e.g., "/MyFolder/SubFolder")',
+                    description: 'Folder path to filter test runs by (e.g., "/MyFolder/SubFolder"). Resolved to a numeric folderId on Cloud.',
+                },
+                folder_id: {
+                    type: 'number',
+                    description: 'Numeric folder ID to filter test runs by (optional). If provided, takes precedence over folder path and skips path resolution. Use this when you already know the folder ID.',
                 },
                 max_results: {
                     type: 'number',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-scale-mcp-server",
-  "version": "0.4.6",
+  "version": "0.5.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/tool-handlers.ts

@@ -273,6 +273,21 @@ export class ZephyrToolHandlers {
         if (!tc) {
           throw scriptUpdateError; // no test case data to build PUT payload, surface original error
         }
+
+        // Fetch the existing test script to get its ID — required for the PUT to update in place
+        let existingScriptId: number | undefined;
+        try {
+          const scriptRes = await this.axiosInstance.get(
+            `${this.jiraConfig.apiEndpoints.testcase}/${test_case_key}/testscript`
+          );
+          existingScriptId = scriptRes.data?.id;
+        } catch {
+          // no existing script — proceed without id
+        }
+
+        const testScriptPayload: any = { type: 'bdd', text: finalText };
+        if (existingScriptId) testScriptPayload.id = existingScriptId;
+
         const putPayload: any = {
           id: tc.id,
           key: test_case_key,
@@ -280,7 +295,7 @@ export class ZephyrToolHandlers {
           status: tc.status,
           priority: tc.priority,
           project: tc.project,
-          testScript: { type: 'bdd', text: finalText },
+          testScript: testScriptPayload,
         };
         for (const field of ['objective', 'precondition', 'estimatedTime', 'component', 'owner', 'folder']) {
           if (tc[field] !== undefined && tc[field] !== null) putPayload[field] = tc[field];
@@ -290,12 +305,18 @@ export class ZephyrToolHandlers {
 
         await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testcase}/${test_case_key}`, putPayload);
 
-        return {
-          content: [{
-            type: 'text',
-            text: `✅ Updated ${test_case_key} with BDD content successfully (Cloud v2, via PUT fallback for migrated project)`,
-          }],
-        };
+        // Note: the Zephyr Scale Cloud API's UpdateTestCaseInput does not include a testScript field,
+        // so the testScript embedded in the PUT payload is silently ignored.
+        // The only endpoint that updates script content (POST /testscript) requires the project to be active.
+        // For test cases migrated from Data Center to Cloud, the original project key may be deactivated,
+        // blocking script updates at the API level. Contact your Zephyr Scale admin to re-enable the project.
+        throw new McpError(
+          ErrorCode.InternalError,
+          `Cannot update test script for ${test_case_key}: the project "${test_case_key.replace(/-T\d+$/, '')}" is deactivated in Zephyr Scale Cloud. ` +
+          `This test case was likely migrated from Data Center and retains its original project key prefix. ` +
+          `POST /testcases/{key}/testscript requires an active project. ` +
+          `Please ask your Zephyr Scale admin to re-enable the project, or recreate this test case under an active Cloud project.`
+        );
       }
 
       // Primary path succeeded — optionally rename
@@ -858,10 +879,10 @@ export class ZephyrToolHandlers {
   }
 
   async searchTestRuns(args: SearchTestRunsArgs) {
-    const { project_key, folder, max_results = 200, fields } = args;
+    const { project_key, folder, folder_id, max_results = 200, fields } = args;
 
-    if (!project_key && !folder) {
-      throw new McpError(ErrorCode.InvalidParams, 'At least one of project_key or folder must be provided.');
+    if (!project_key && !folder && !folder_id) {
+      throw new McpError(ErrorCode.InvalidParams, 'At least one of project_key, folder, or folder_id must be provided.');
     }
 
     if (this.jiraConfig.type === 'cloud') {
@@ -870,7 +891,10 @@ export class ZephyrToolHandlers {
         const params: Record<string, any> = { maxResults: max_results };
         if (project_key) params.projectKey = project_key;
 
-        if (folder && project_key) {
+        // folder_id takes precedence over folder path
+        if (folder_id) {
+          params.folderId = folder_id;
+        } else if (folder && project_key) {
           const folderId = await resolveFolderIdByPath(
             this.axiosInstance, project_key, folder, 'TEST_CYCLE'
           );

package/src/tool-schemas.ts

@@ -351,7 +351,7 @@ export const toolSchemas = [
   },
   {
     name: 'search_test_runs',
-    description: 'Search for test runs using a query. Supports filtering by projectKey and/or folder path.',
+    description: 'Search for test runs using a query. Supports filtering by projectKey and/or folder path. On Cloud, only returns cycles in the exact folder (not sub-folders). Use folder_id for direct numeric ID lookup (skips path resolution).',
     inputSchema: {
       type: 'object',
       properties: {
@@ -361,7 +361,11 @@ export const toolSchemas = [
         },
         folder: {
           type: 'string',
-          description: 'Folder path to filter test runs by (e.g., "/MyFolder/SubFolder")',
+          description: 'Folder path to filter test runs by (e.g., "/MyFolder/SubFolder"). Resolved to a numeric folderId on Cloud.',
+        },
+        folder_id: {
+          type: 'number',
+          description: 'Numeric folder ID to filter test runs by (optional). If provided, takes precedence over folder path and skips path resolution. Use this when you already know the folder ID.',
         },
         max_results: {
           type: 'number',

package/src/types.ts

@@ -91,6 +91,7 @@ export interface GetTestExecutionArgs {
 export interface SearchTestRunsArgs {
   project_key?: string;
   folder?: string;
+  folder_id?: number;
   max_results?: number;
   fields?: string;
 }