zephyr-scale-mcp-server 0.4.1 → 0.4.2

package/build/tool-handlers.js

@@ -34,7 +34,7 @@ export class ZephyrToolHandlers {
         return this.createTestCaseDC(args);
     }
     async createTestCaseCloud(args) {
-        const { project_key, name, test_script, folder, priority, precondition, objective, estimated_time, labels, custom_fields, } = args;
+        const { project_key, name, test_script, folder, priority, precondition, objective, estimated_time, labels, custom_fields, issue_links, } = args;
         const payload = { projectKey: project_key, name };
         // Cloud v2 uses statusName/priorityName (strings), folderId (integer)
         payload.statusName = 'Draft';
@@ -66,10 +66,27 @@ export class ZephyrToolHandlers {
             if (test_script) {
                 await this.upsertTestScriptCloud(testKey, test_script);
             }
+            // Step 3: link Jira issues via POST /testcases/{key}/links/issues
+            // IssueLinkInput requires a numeric issueId — resolve each key via Jira REST API
+            const linkWarnings = [];
+            if (issue_links && issue_links.length > 0) {
+                for (const issueKey of issue_links) {
+                    try {
+                        const issueId = await this.resolveJiraIssueId(issueKey);
+                        await this.axiosInstance.post(`${this.jiraConfig.apiEndpoints.testcase}/${testKey}/links/issues`, { issueId });
+                    }
+                    catch (e) {
+                        linkWarnings.push(`${issueKey}: ${this.formatError(e)}`);
+                    }
+                }
+            }
+            const warningText = linkWarnings.length > 0
+                ? `\n⚠️ Some issue links failed:\n${linkWarnings.map(w => `  - ${w}`).join('\n')}`
+                : '';
             return {
                 content: [{
                         type: 'text',
-                        text: `✅ Test case created successfully: ${testKey}\n${JSON.stringify({ key: testKey, type: test_script?.type || 'none' }, null, 2)}`,
+                        text: `✅ Test case created successfully: ${testKey}\n${JSON.stringify({ key: testKey, type: test_script?.type || 'none', linkedIssues: (issue_links ?? []).length - linkWarnings.length }, null, 2)}${warningText}`,
                     }],
             };
         }
@@ -751,6 +768,18 @@ export class ZephyrToolHandlers {
             throw new McpError(ErrorCode.InternalError, `Failed to add test cases: ${this.formatError(error)}`);
         }
     }
+    async resolveJiraIssueId(issueKey) {
+        // The Zephyr API key is a Jira-issued token — it works against the Jira REST API too.
+        // We call GET {jiraBaseUrl}/rest/api/3/issue/{key}?fields=id to get the numeric issue ID
+        // required by POST /testcases/{key}/links/issues { issueId: <integer> }.
+        const url = `${this.jiraConfig.jiraBaseUrl}/rest/api/3/issue/${issueKey}?fields=id`;
+        const response = await this.axiosInstance.get(url, { baseURL: '' });
+        const id = parseInt(response.data.id, 10);
+        if (!id || isNaN(id)) {
+            throw new Error(`Could not resolve numeric ID for Jira issue "${issueKey}"`);
+        }
+        return id;
+    }
     formatError(error) {
         if (error instanceof Error && 'response' in error) {
             const axiosError = error;

package/build/tool-schemas.js

@@ -110,7 +110,7 @@ export const toolSchemas = [
                 },
                 issue_links: {
                     type: 'array',
-                    description: 'Array of issue links (optional) - will be mapped to issueLinks in API',
+                    description: 'Array of Jira issue keys to link to this test case (e.g. ["PROJ-123", "PROJ-456"]). On Cloud, each key is resolved to a numeric Jira issue ID via the Jira REST API, then linked via POST /testcases/{key}/links/issues — failures are reported as warnings but do not fail the tool call. On Data Center, sent directly in the create payload.',
                     items: { type: 'string' }
                 },
                 custom_fields: {

package/build/utils.js

@@ -145,6 +145,7 @@ export function createJiraConfig() {
     return {
         type,
         baseUrl,
+        jiraBaseUrl,
         authHeaders,
         apiEndpoints,
     };

package/package.json

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

@@ -46,7 +46,7 @@ export class ZephyrToolHandlers {
   private async createTestCaseCloud(args: TestCaseArgs) {
     const {
       project_key, name, test_script, folder, priority, precondition,
-      objective, estimated_time, labels, custom_fields,
+      objective, estimated_time, labels, custom_fields, issue_links,
     } = args;
 
     const payload: any = { projectKey: project_key, name };
@@ -79,10 +79,31 @@ export class ZephyrToolHandlers {
         await this.upsertTestScriptCloud(testKey, test_script);
       }
 
+      // Step 3: link Jira issues via POST /testcases/{key}/links/issues
+      // IssueLinkInput requires a numeric issueId — resolve each key via Jira REST API
+      const linkWarnings: string[] = [];
+      if (issue_links && issue_links.length > 0) {
+        for (const issueKey of issue_links) {
+          try {
+            const issueId = await this.resolveJiraIssueId(issueKey);
+            await this.axiosInstance.post(
+              `${this.jiraConfig.apiEndpoints.testcase}/${testKey}/links/issues`,
+              { issueId }
+            );
+          } catch (e) {
+            linkWarnings.push(`${issueKey}: ${this.formatError(e)}`);
+          }
+        }
+      }
+
+      const warningText = linkWarnings.length > 0
+        ? `\n⚠️ Some issue links failed:\n${linkWarnings.map(w => `  - ${w}`).join('\n')}`
+        : '';
+
       return {
         content: [{
           type: 'text',
-          text: `✅ Test case created successfully: ${testKey}\n${JSON.stringify({ key: testKey, type: test_script?.type || 'none' }, null, 2)}`,
+          text: `✅ Test case created successfully: ${testKey}\n${JSON.stringify({ key: testKey, type: test_script?.type || 'none', linkedIssues: (issue_links ?? []).length - linkWarnings.length }, null, 2)}${warningText}`,
         }],
       };
     } catch (error) {
@@ -824,6 +845,19 @@ export class ZephyrToolHandlers {
     }
   }
 
+  private async resolveJiraIssueId(issueKey: string): Promise<number> {
+    // The Zephyr API key is a Jira-issued token — it works against the Jira REST API too.
+    // We call GET {jiraBaseUrl}/rest/api/3/issue/{key}?fields=id to get the numeric issue ID
+    // required by POST /testcases/{key}/links/issues { issueId: <integer> }.
+    const url = `${this.jiraConfig.jiraBaseUrl}/rest/api/3/issue/${issueKey}?fields=id`;
+    const response = await this.axiosInstance.get(url, { baseURL: '' });
+    const id = parseInt(response.data.id, 10);
+    if (!id || isNaN(id)) {
+      throw new Error(`Could not resolve numeric ID for Jira issue "${issueKey}"`);
+    }
+    return id;
+  }
+
   private formatError(error: unknown): string {
     if (error instanceof Error && 'response' in error) {
       const axiosError = error as any;

package/src/tool-schemas.ts

@@ -110,7 +110,7 @@ export const toolSchemas = [
         },
         issue_links: {
           type: 'array',
-          description: 'Array of issue links (optional) - will be mapped to issueLinks in API',
+          description: 'Array of Jira issue keys to link to this test case (e.g. ["PROJ-123", "PROJ-456"]). On Cloud, each key is resolved to a numeric Jira issue ID via the Jira REST API, then linked via POST /testcases/{key}/links/issues — failures are reported as warnings but do not fail the tool call. On Data Center, sent directly in the create payload.',
           items: { type: 'string' }
         },
         custom_fields: {

package/src/types.ts

@@ -104,6 +104,7 @@ export interface ApiEndpoints {
 export interface JiraConfig {
   type: JiraType;
   baseUrl: string;
+  jiraBaseUrl: string;
   authHeaders: Record<string, string>;
   apiEndpoints: ApiEndpoints;
 }

package/src/utils.ts

@@ -170,6 +170,7 @@ export function createJiraConfig() {
   return {
     type,
     baseUrl,
+    jiraBaseUrl,
     authHeaders,
     apiEndpoints,
   };