zephyr-scale-mcp-server 0.5.1 → 0.6.0

package/build/index.js

@@ -55,6 +55,8 @@ class ZephyrServer {
                         return await this.toolHandlers.getTestRunCases(args);
                     case 'delete_test_case':
                         return await this.toolHandlers.deleteTestCase(args);
+                    case 'update_test_run':
+                        return await this.toolHandlers.updateTestRun(args);
                     case 'delete_test_run':
                         return await this.toolHandlers.deleteTestRun(args);
                     case 'create_test_run':

package/build/tool-handlers.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { McpError, ErrorCode } from '@modelcontextprotocol/sdk/types.js';
-import { convertToGherkin, resolveFolderIdByPath } from './utils.js';
+import { convertToGherkin, resolveFolderIdByPath, getAccountIdFromApiKey } from './utils.js';
 export class ZephyrToolHandlers {
     axiosInstance;
     jiraConfig;
@@ -61,9 +61,10 @@ export class ZephyrToolHandlers {
             payload.labels = labels;
         if (custom_fields)
             payload.customFields = custom_fields;
-        // Cloud v2 uses ownerId (Jira Account ID) and componentId (integer)
-        if (owner_id)
-            payload.ownerId = owner_id;
+        // Default ownerId to the account ID embedded in the Zephyr API key JWT
+        const resolvedOwner = owner_id ?? getAccountIdFromApiKey();
+        if (resolvedOwner)
+            payload.ownerId = resolvedOwner;
         if (component_id)
             payload.componentId = component_id;
         // Resolve folder path → folderId
@@ -500,6 +501,69 @@ export class ZephyrToolHandlers {
             throw new McpError(ErrorCode.InternalError, `Failed to get test run cases: ${this.formatError(error)}`);
         }
     }
+    async updateTestRun(args) {
+        const { test_run_key, owner, name, description, planned_start_date, planned_end_date, status_id } = args;
+        if (this.jiraConfig.type !== 'cloud') {
+            throw new McpError(ErrorCode.InvalidRequest, 'update_test_run is only supported on Zephyr Scale Cloud.');
+        }
+        try {
+            // Fetch current cycle to preserve required fields
+            const getResponse = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`);
+            const current = getResponse.data;
+            const payload = {
+                id: current.id,
+                key: test_run_key,
+                name: name ?? current.name,
+                project: current.project,
+                status: status_id ? { id: status_id } : current.status,
+            };
+            if (description !== undefined)
+                payload.description = description;
+            else if (current.description)
+                payload.description = current.description;
+            if (planned_start_date !== undefined)
+                payload.plannedStartDate = planned_start_date;
+            else if (current.plannedStartDate)
+                payload.plannedStartDate = current.plannedStartDate;
+            if (planned_end_date !== undefined)
+                payload.plannedEndDate = planned_end_date;
+            else if (current.plannedEndDate)
+                payload.plannedEndDate = current.plannedEndDate;
+            if (owner !== undefined)
+                payload.owner = { accountId: owner };
+            else if (current.owner)
+                payload.owner = current.owner;
+            if (current.jiraProjectVersion)
+                payload.jiraProjectVersion = current.jiraProjectVersion;
+            if (current.folder)
+                payload.folder = current.folder;
+            if (current.customFields && Object.keys(current.customFields).length > 0) {
+                payload.customFields = current.customFields;
+            }
+            await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`, payload);
+            // Resolve status name for the response
+            const projectKey = test_run_key.replace(/-R\d+$/, '');
+            const statusName = payload.status?.id
+                ? await this.resolveStatusName(payload.status.id)
+                : null;
+            return {
+                content: [{
+                        type: 'text',
+                        text: `✅ Updated test cycle ${test_run_key} successfully.\n${JSON.stringify({
+                            key: test_run_key,
+                            name: payload.name,
+                            owner: payload.owner ?? null,
+                            status: statusName ? { id: payload.status?.id, name: statusName } : payload.status,
+                        }, null, 2)}`,
+                    }],
+            };
+        }
+        catch (error) {
+            if (error instanceof McpError)
+                throw error;
+            throw new McpError(ErrorCode.InternalError, `Failed to update test run: ${this.formatError(error)}`);
+        }
+    }
     async deleteTestCase(args) {
         if (this.jiraConfig.type === 'cloud') {
             throw new McpError(ErrorCode.InvalidRequest, 'delete_test_case is not supported by the Zephyr Scale Cloud v2 API.');
@@ -558,9 +622,10 @@ export class ZephyrToolHandlers {
             payload.plannedEndDate = planned_end_date;
         if (custom_fields)
             payload.customFields = custom_fields;
-        // Cloud v2 TestCycleInput supports ownerId (Jira Account ID)
-        if (owner)
-            payload.ownerId = owner;
+        // Default ownerId to the account ID embedded in the Zephyr API key JWT
+        const resolvedOwner = owner ?? getAccountIdFromApiKey();
+        if (resolvedOwner)
+            payload.ownerId = resolvedOwner;
         // Link to a Jira project version/release (integer ID)
         if (jira_project_version)
             payload.jiraProjectVersion = jira_project_version;
@@ -678,14 +743,28 @@ export class ZephyrToolHandlers {
             throw new McpError(ErrorCode.InternalError, `Failed to create test run: ${this.formatError(error)}`);
         }
     }
+    async resolveStatusName(statusId) {
+        try {
+            const response = await this.axiosInstance.get(`/statuses/${statusId}`);
+            return response.data?.name ?? null;
+        }
+        catch {
+            return null;
+        }
+    }
     async getTestRun(args) {
         const { test_run_key } = args;
-        // Both Cloud (/testcycles/{key}) and DC (/rest/atm/1.0/testrun/{key}) handled
-        // via apiEndpoints.testrun which now correctly maps to /testcycles for Cloud
         try {
             const response = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`);
+            const data = response.data;
+            // Resolve status name — extract project key from the cycle key (e.g. DDCN-R377 → DDCN)
+            if (data?.status?.id) {
+                const statusName = await this.resolveStatusName(data.status.id);
+                if (statusName)
+                    data.status.name = statusName;
+            }
             return {
-                content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
+                content: [{ type: 'text', text: JSON.stringify(data, null, 2) }],
             };
         }
         catch (error) {

package/build/tool-schemas.js

@@ -402,6 +402,44 @@ export const toolSchemas = [
             required: ['test_cycle_key', 'project_key'],
         },
     },
+    {
+        name: 'update_test_run',
+        description: 'Update an existing test cycle — set owner, name, description, dates, or status. Unspecified fields are preserved. Cloud only.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                test_run_key: {
+                    type: 'string',
+                    description: 'Test cycle key to update (e.g., PROJ-R123)',
+                },
+                owner: {
+                    type: 'string',
+                    description: 'Jira Account ID of the new owner (e.g., "6269ee89494f17007056d8f0")',
+                },
+                name: {
+                    type: 'string',
+                    description: 'New name for the test cycle (optional)',
+                },
+                description: {
+                    type: 'string',
+                    description: 'New description (optional)',
+                },
+                planned_start_date: {
+                    type: 'string',
+                    description: 'Planned start date in ISO format (optional)',
+                },
+                planned_end_date: {
+                    type: 'string',
+                    description: 'Planned end date in ISO format (optional)',
+                },
+                status_id: {
+                    type: 'number',
+                    description: 'Numeric status ID to set (optional)',
+                },
+            },
+            required: ['test_run_key'],
+        },
+    },
     {
         name: 'delete_test_run',
         description: 'Delete a specific test run (Data Center only — not supported on Cloud v2)',

package/build/utils.js

@@ -83,6 +83,29 @@ export const priorityMapping = {
     'Medium': 'High',
     'Low': 'High'
 };
+/**
+ * Decodes the Atlassian Account ID from the Zephyr JWT API key.
+ * The JWT payload contains context.user.accountId — no extra API call needed.
+ * Returns null if the token is missing or malformed.
+ */
+export function getAccountIdFromApiKey(apiKey) {
+    try {
+        const token = apiKey ?? process.env.ZEPHYR_API_KEY;
+        if (!token)
+            return null;
+        const parts = token.split('.');
+        if (parts.length < 2)
+            return null;
+        // Base64url decode the payload (add padding as needed)
+        const payload = parts[1].replace(/-/g, '+').replace(/_/g, '/');
+        const padded = payload + '='.repeat((4 - payload.length % 4) % 4);
+        const decoded = JSON.parse(Buffer.from(padded, 'base64').toString('utf8'));
+        return decoded?.context?.user?.accountId ?? null;
+    }
+    catch {
+        return null;
+    }
+}
 /**
  * Detects whether the Jira instance is Cloud or Data Center based on the base URL.
  */

package/package.json

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

@@ -75,6 +75,8 @@ class ZephyrServer {
             return await this.toolHandlers.getTestRunCases(args);
           case 'delete_test_case':
             return await this.toolHandlers.deleteTestCase(args);
+          case 'update_test_run':
+            return await this.toolHandlers.updateTestRun(args);
           case 'delete_test_run':
             return await this.toolHandlers.deleteTestRun(args);
           case 'create_test_run':

package/src/tool-handlers.ts

@@ -13,7 +13,7 @@ import {
   ListExecutionsByCycleArgs,
   JiraConfig
 } from './types.js';
-import { convertToGherkin, resolveFolderIdByPath } from './utils.js';
+import { convertToGherkin, resolveFolderIdByPath, getAccountIdFromApiKey } from './utils.js';
 
 export class ZephyrToolHandlers {
   constructor(
@@ -74,8 +74,9 @@ export class ZephyrToolHandlers {
     if (estimated_time) payload.estimatedTime = estimated_time;
     if (labels && labels.length > 0) payload.labels = labels;
     if (custom_fields) payload.customFields = custom_fields;
-    // Cloud v2 uses ownerId (Jira Account ID) and componentId (integer)
-    if (owner_id) payload.ownerId = owner_id;
+    // Default ownerId to the account ID embedded in the Zephyr API key JWT
+    const resolvedOwner = owner_id ?? getAccountIdFromApiKey();
+    if (resolvedOwner) payload.ownerId = resolvedOwner;
     if (component_id) payload.componentId = component_id;
 
     // Resolve folder path → folderId
@@ -544,6 +545,69 @@ export class ZephyrToolHandlers {
     }
   }
 
+  async updateTestRun(args: any) {
+    const { test_run_key, owner, name, description, planned_start_date, planned_end_date, status_id } = args;
+
+    if (this.jiraConfig.type !== 'cloud') {
+      throw new McpError(ErrorCode.InvalidRequest, 'update_test_run is only supported on Zephyr Scale Cloud.');
+    }
+
+    try {
+      // Fetch current cycle to preserve required fields
+      const getResponse = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`);
+      const current = getResponse.data;
+
+      const payload: any = {
+        id: current.id,
+        key: test_run_key,
+        name: name ?? current.name,
+        project: current.project,
+        status: status_id ? { id: status_id } : current.status,
+      };
+
+      if (description !== undefined) payload.description = description;
+      else if (current.description) payload.description = current.description;
+
+      if (planned_start_date !== undefined) payload.plannedStartDate = planned_start_date;
+      else if (current.plannedStartDate) payload.plannedStartDate = current.plannedStartDate;
+
+      if (planned_end_date !== undefined) payload.plannedEndDate = planned_end_date;
+      else if (current.plannedEndDate) payload.plannedEndDate = current.plannedEndDate;
+
+      if (owner !== undefined) payload.owner = { accountId: owner };
+      else if (current.owner) payload.owner = current.owner;
+
+      if (current.jiraProjectVersion) payload.jiraProjectVersion = current.jiraProjectVersion;
+      if (current.folder) payload.folder = current.folder;
+      if (current.customFields && Object.keys(current.customFields).length > 0) {
+        payload.customFields = current.customFields;
+      }
+
+      await this.axiosInstance.put(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`, payload);
+
+      // Resolve status name for the response
+      const projectKey = test_run_key.replace(/-R\d+$/, '');
+      const statusName = payload.status?.id
+        ? await this.resolveStatusName(payload.status.id)
+        : null;
+
+      return {
+        content: [{
+          type: 'text',
+          text: `✅ Updated test cycle ${test_run_key} successfully.\n${JSON.stringify({
+            key: test_run_key,
+            name: payload.name,
+            owner: payload.owner ?? null,
+            status: statusName ? { id: payload.status?.id, name: statusName } : payload.status,
+          }, null, 2)}`,
+        }],
+      };
+    } catch (error) {
+      if (error instanceof McpError) throw error;
+      throw new McpError(ErrorCode.InternalError, `Failed to update test run: ${this.formatError(error)}`);
+    }
+  }
+
   async deleteTestCase(args: any) {
     if (this.jiraConfig.type === 'cloud') {
       throw new McpError(
@@ -614,8 +678,9 @@ export class ZephyrToolHandlers {
     if (planned_start_date) payload.plannedStartDate = planned_start_date;
     if (planned_end_date) payload.plannedEndDate = planned_end_date;
     if (custom_fields) payload.customFields = custom_fields;
-    // Cloud v2 TestCycleInput supports ownerId (Jira Account ID)
-    if (owner) payload.ownerId = owner;
+    // Default ownerId to the account ID embedded in the Zephyr API key JWT
+    const resolvedOwner = owner ?? getAccountIdFromApiKey();
+    if (resolvedOwner) payload.ownerId = resolvedOwner;
     // Link to a Jira project version/release (integer ID)
     if (jira_project_version) payload.jiraProjectVersion = jira_project_version;
     if (folder) {
@@ -735,14 +800,29 @@ export class ZephyrToolHandlers {
     }
   }
 
+  private async resolveStatusName(statusId: number): Promise<string | null> {
+    try {
+      const response = await this.axiosInstance.get(`/statuses/${statusId}`);
+      return response.data?.name ?? null;
+    } catch {
+      return null;
+    }
+  }
+
   async getTestRun(args: any) {
     const { test_run_key } = args;
-    // Both Cloud (/testcycles/{key}) and DC (/rest/atm/1.0/testrun/{key}) handled
-    // via apiEndpoints.testrun which now correctly maps to /testcycles for Cloud
     try {
       const response = await this.axiosInstance.get(`${this.jiraConfig.apiEndpoints.testrun}/${test_run_key}`);
+      const data = response.data;
+
+      // Resolve status name — extract project key from the cycle key (e.g. DDCN-R377 → DDCN)
+      if (data?.status?.id) {
+        const statusName = await this.resolveStatusName(data.status.id);
+        if (statusName) data.status.name = statusName;
+      }
+
       return {
-        content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
+        content: [{ type: 'text', text: JSON.stringify(data, null, 2) }],
       };
     } catch (error) {
       throw new McpError(ErrorCode.InternalError, `Failed to get test run: ${this.formatError(error)}`);

package/src/tool-schemas.ts

@@ -402,6 +402,44 @@ export const toolSchemas = [
       required: ['test_cycle_key', 'project_key'],
     },
   },
+  {
+    name: 'update_test_run',
+    description: 'Update an existing test cycle — set owner, name, description, dates, or status. Unspecified fields are preserved. Cloud only.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        test_run_key: {
+          type: 'string',
+          description: 'Test cycle key to update (e.g., PROJ-R123)',
+        },
+        owner: {
+          type: 'string',
+          description: 'Jira Account ID of the new owner (e.g., "6269ee89494f17007056d8f0")',
+        },
+        name: {
+          type: 'string',
+          description: 'New name for the test cycle (optional)',
+        },
+        description: {
+          type: 'string',
+          description: 'New description (optional)',
+        },
+        planned_start_date: {
+          type: 'string',
+          description: 'Planned start date in ISO format (optional)',
+        },
+        planned_end_date: {
+          type: 'string',
+          description: 'Planned end date in ISO format (optional)',
+        },
+        status_id: {
+          type: 'number',
+          description: 'Numeric status ID to set (optional)',
+        },
+      },
+      required: ['test_run_key'],
+    },
+  },
   {
     name: 'delete_test_run',
     description: 'Delete a specific test run (Data Center only — not supported on Cloud v2)',

package/src/utils.ts

@@ -102,6 +102,27 @@ export const priorityMapping: { [key: string]: string } = {
   'Low': 'High'
 };
 
+/**
+ * Decodes the Atlassian Account ID from the Zephyr JWT API key.
+ * The JWT payload contains context.user.accountId — no extra API call needed.
+ * Returns null if the token is missing or malformed.
+ */
+export function getAccountIdFromApiKey(apiKey?: string): string | null {
+  try {
+    const token = apiKey ?? process.env.ZEPHYR_API_KEY;
+    if (!token) return null;
+    const parts = token.split('.');
+    if (parts.length < 2) return null;
+    // Base64url decode the payload (add padding as needed)
+    const payload = parts[1].replace(/-/g, '+').replace(/_/g, '/');
+    const padded = payload + '='.repeat((4 - payload.length % 4) % 4);
+    const decoded = JSON.parse(Buffer.from(padded, 'base64').toString('utf8'));
+    return decoded?.context?.user?.accountId ?? null;
+  } catch {
+    return null;
+  }
+}
+
 /**
  * Detects whether the Jira instance is Cloud or Data Center based on the base URL.
  */