@smartbear/mcp 0.14.1 → 0.16.0

package/dist/zephyr/tool/folder/create-folder.js

@@ -0,0 +1,55 @@
+import { Tool } from "../../../common/tools.js";
+import { CreateFolder201Response, CreateFolderBody } from "../../common/rest-api-schemas.js";
+class CreateFolder extends Tool {
+  specification = {
+    title: "Create Folder",
+    summary: "Create a folder called 'Axial Pump Tests' in the project SA for organizing test cases",
+    readOnly: false,
+    idempotent: false,
+    inputSchema: CreateFolderBody,
+    outputSchema: CreateFolder201Response,
+    examples: [
+      {
+        description: "Create a root Folder in project SA for organizing test cases",
+        parameters: {
+          parentId: null,
+          name: "Axial Pump Tests",
+          projectKey: "SA",
+          folderType: "TEST_CASE"
+        },
+        expectedOutput: "The newly created Folder with its ID and self link"
+      },
+      {
+        description: "Create a sub-folder under folder ID 5 in the project MM2 for test plans related to pumps",
+        parameters: {
+          parentId: 5,
+          name: "Pump-related Test Plans",
+          projectKey: "MM2",
+          folderType: "TEST_PLAN"
+        },
+        expectedOutput: "The newly created Folder with its ID and self link"
+      },
+      {
+        description: "Create a Folder called 'Regression Cycles' in project TIS for organizing test cycles",
+        parameters: {
+          parentId: null,
+          name: "Regression Cycles",
+          projectKey: "TIS",
+          folderType: "TEST_CYCLE"
+        },
+        expectedOutput: "The newly created Folder with its ID and self link"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const body = CreateFolderBody.parse(args);
+    const response = await this.client.getApiClient().post(`/folders`, body);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  CreateFolder
+};

package/dist/zephyr/tool/issue-link/get-test-cases.js

@@ -0,0 +1,33 @@
+import { Tool } from "../../../common/tools.js";
+import { GetIssueLinkTestCases200Response, GetIssueLinkTestCasesParams } from "../../common/rest-api-schemas.js";
+class GetTestCases extends Tool {
+  specification = {
+    title: "Get Issue Link Test Cases",
+    summary: "Get test cases linked to a Jira issue in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetIssueLinkTestCasesParams,
+    outputSchema: GetIssueLinkTestCases200Response,
+    examples: [
+      {
+        description: "Check which test cases are linked to Jira issue PROJ-123",
+        parameters: {
+          issueKey: "PROJ-123"
+        },
+        expectedOutput: "The List of test cases linked to Jira issue PROJ-123 with their keys and versions"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const { issueKey } = GetIssueLinkTestCasesParams.parse(args);
+    const response = await this.client.getApiClient().get(`/issuelinks/${issueKey}/testcases`);
+    return {
+      // requires structuredContent to be a record, not an array.
+      structuredContent: { testCases: response },
+      content: []
+    };
+  };
+}
+export {
+  GetTestCases
+};

package/dist/zephyr/tool/issue-link/get-test-cycles.js

@@ -0,0 +1,32 @@
+import { Tool } from "../../../common/tools.js";
+import { GetIssueLinkTestCycles200Response, GetIssueLinkTestCyclesParams } from "../../common/rest-api-schemas.js";
+class GetTestCycles extends Tool {
+  specification = {
+    title: "Get Test Cycles linked to a Jira issue",
+    summary: "Get test cycles linked to a Jira issue in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetIssueLinkTestCyclesParams,
+    outputSchema: GetIssueLinkTestCycles200Response,
+    examples: [
+      {
+        description: "Check which test cycles are linked to Jira issue PROJ-123",
+        parameters: {
+          issueKey: "PROJ-123"
+        },
+        expectedOutput: "The List of test cycles linked to Jira issue PROJ-123 with their IDs"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const { issueKey } = GetIssueLinkTestCyclesParams.parse(args);
+    const response = await this.client.getApiClient().get(`/issuelinks/${issueKey}/testcycles`);
+    return {
+      structuredContent: { testCycles: response },
+      content: []
+    };
+  };
+}
+export {
+  GetTestCycles
+};

package/dist/zephyr/tool/issue-link/get-test-executions.js

@@ -0,0 +1,32 @@
+import { Tool } from "../../../common/tools.js";
+import { GetIssueLinkTestExecutions200Response, GetIssueLinkTestExecutionsParams } from "../../common/rest-api-schemas.js";
+class GetTestExecutions extends Tool {
+  specification = {
+    title: "Get test executions linked to a Jira issue",
+    summary: "Get test executions linked to a Jira issue in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetIssueLinkTestExecutionsParams,
+    outputSchema: GetIssueLinkTestExecutions200Response,
+    examples: [
+      {
+        description: "Check which test executions are linked to Jira issue PROJ-123",
+        parameters: {
+          issueKey: "PROJ-123"
+        },
+        expectedOutput: "The List of test executions linked to Jira issue PROJ-123 with their keys and versions"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const { issueKey } = GetIssueLinkTestExecutionsParams.parse(args);
+    const response = await this.client.getApiClient().get(`/issuelinks/${issueKey}/executions`);
+    return {
+      structuredContent: { testExecutions: response },
+      content: []
+    };
+  };
+}
+export {
+  GetTestExecutions
+};

package/dist/zephyr/tool/test-case/create-issue-link.js

@@ -0,0 +1,38 @@
+import { Tool } from "../../../common/tools.js";
+import { CreateTestCaseIssueLink201Response, CreateTestCaseIssueLinkParams, CreateTestCaseIssueLinkBody } from "../../common/rest-api-schemas.js";
+class CreateTestCaseIssueLink extends Tool {
+  specification = {
+    title: "Create Test Case Issue Link",
+    summary: "Create a new link between an issue in Jira and a Test Case in Zephyr",
+    readOnly: false,
+    idempotent: false,
+    inputSchema: CreateTestCaseIssueLinkParams.and(
+      CreateTestCaseIssueLinkBody.partial()
+    ),
+    outputSchema: CreateTestCaseIssueLink201Response,
+    examples: [
+      {
+        description: "Create a link between the test case SA-T1 and the Jira Issue ID 10100",
+        parameters: {
+          testCaseKey: "SA-T1",
+          issueId: "10100"
+        },
+        expectedOutput: "The newly created Issue Link with its ID and self link"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const parsed = CreateTestCaseIssueLinkParams.and(
+      CreateTestCaseIssueLinkBody
+    ).parse(args);
+    const { testCaseKey, ...body } = parsed;
+    const response = await this.client.getApiClient().post(`/testcases/${testCaseKey}/links/issues`, body);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  CreateTestCaseIssueLink
+};

package/dist/zephyr/tool/test-case/create-test-script.js

@@ -0,0 +1,57 @@
+import { Tool } from "../../../common/tools.js";
+import { CreateTestCaseTestScript201Response, CreateTestCaseTestScriptParams, CreateTestCaseTestScriptBody } from "../../common/rest-api-schemas.js";
+class CreateTestScript extends Tool {
+  specification = {
+    title: "Create Test Script",
+    summary: "Create a new Test Script of the types Plain Text or BDD in a Zephyr Test Case.",
+    readOnly: false,
+    idempotent: false,
+    inputSchema: CreateTestCaseTestScriptParams.and(
+      CreateTestCaseTestScriptBody.partial()
+    ),
+    outputSchema: CreateTestCaseTestScript201Response,
+    examples: [
+      {
+        description: "Create a plain text test script for test case SA-T1 to verify that the axial pump can be enabled",
+        parameters: {
+          testCaseKey: "SA-T1",
+          type: "plain",
+          text: "1. Navigate to Pump Settings</br>2. Enable Axial Pump</br>3. Verify pump status is 'Active'"
+        },
+        expectedOutput: "The created test script metadata including its id and self link"
+      },
+      {
+        description: "Create a BDD test script for test case MM2-T15 to validate axial pump activation",
+        parameters: {
+          testCaseKey: "MM2-T15",
+          type: "bdd",
+          text: "Given the axial pump is installed\nWhen the user enables the axial pump\nThen the pump status should be Active"
+        },
+        expectedOutput: "The created test script metadata including its id and self link"
+      },
+      {
+        description: "Create a BDD test script for test case QA-T100 for axial pump performance validation",
+        parameters: {
+          testCaseKey: "QA-T100",
+          type: "bdd",
+          text: "Given the system is running\nWhen the axial pump operates under load\nThen performance metrics should remain within thresholds"
+        },
+        expectedOutput: "The created test script metadata including its id and self link"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const parsed = CreateTestCaseTestScriptParams.and(
+      CreateTestCaseTestScriptBody
+    ).parse(args);
+    const { testCaseKey, ...body } = parsed;
+    const response = await this.client.getApiClient().post(`/testcases/${testCaseKey}/testscript`, body);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  CreateTestScript
+};

package/dist/zephyr/tool/test-case/create-test-steps.js

@@ -0,0 +1,91 @@
+import { Tool } from "../../../common/tools.js";
+import { CreateTestCaseTestSteps201Response, CreateTestCaseTestStepsParams, CreateTestCaseTestStepsBody } from "../../common/rest-api-schemas.js";
+class CreateTestSteps extends Tool {
+  specification = {
+    title: "Create Test Case Steps",
+    summary: "Create steps for a Test Case in Zephyr. Supports inline step definitions or delegating execution to another test case (also known as 'call to test' via UI).",
+    readOnly: false,
+    idempotent: false,
+    inputSchema: CreateTestCaseTestStepsParams.and(
+      CreateTestCaseTestStepsBody.partial()
+    ),
+    outputSchema: CreateTestCaseTestSteps201Response,
+    examples: [
+      {
+        description: "To the Test Case SA-T1, add steps that will test a login page.",
+        parameters: {
+          testCaseKey: "SA-T1",
+          mode: "APPEND",
+          items: [
+            {
+              inline: {
+                description: "Navigate to the login page",
+                expectedResult: "Login page is displayed"
+              }
+            },
+            {
+              inline: {
+                description: "Enter valid credentials and click Submit",
+                expectedResult: "User is redirected to the dashboard"
+              }
+            }
+          ]
+        },
+        expectedOutput: "The ID of the Test Steps resource and the API self URL to fetch it"
+      },
+      {
+        description: "To the Test Case MM2-T15, replace all existing steps with new ones that test the settings page for an Admin user.",
+        parameters: {
+          testCaseKey: "MM2-T15",
+          mode: "OVERWRITE",
+          items: [
+            {
+              inline: {
+                description: "Open the settings page",
+                testData: "User role: Admin",
+                expectedResult: "Settings page is accessible"
+              }
+            },
+            {
+              inline: {
+                description: "Change the notification preference",
+                testData: "Preference: Email only",
+                expectedResult: "Notification preference is updated successfully"
+              }
+            }
+          ]
+        },
+        expectedOutput: "The ID of the Test Steps resource and the API self URL to fetch it"
+      },
+      {
+        description: "To the Test Case SA-T1, add a step that reuses the steps from the Test Case PRJ-T42",
+        parameters: {
+          testCaseKey: "SA-T1",
+          mode: "APPEND",
+          items: [
+            {
+              testCase: {
+                testCaseKey: "PRJ-T42"
+              }
+            }
+          ]
+        },
+        expectedOutput: "The ID of the Test Steps resource and the API self URL to fetch it"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const parsed = CreateTestCaseTestStepsParams.and(
+      CreateTestCaseTestStepsBody
+    ).parse(args);
+    const { testCaseKey, ...body } = parsed;
+    const response = await this.client.getApiClient().post(`/testcases/${testCaseKey}/teststeps`, body);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  CreateTestSteps
+};

package/dist/zephyr/tool/test-case/create-web-link.js

@@ -32,8 +32,11 @@ class CreateTestCaseWebLink extends Tool {
     ]
   };
   handle = async (args) => {
-    const { testCaseKey } = CreateTestCaseWebLinkParams.parse(args);
-    const body = CreateTestCaseWebLinkBody.parse(args);
+    const fullInputSchema = CreateTestCaseWebLinkBody.extend({
+      testCaseKey: CreateTestCaseWebLinkParams.shape.testCaseKey
+    });
+    const parsed = fullInputSchema.parse(args);
+    const { testCaseKey, ...body } = parsed;
     const response = await this.client.getApiClient().post(`/testcases/${testCaseKey}/links/weblinks`, body);
     return {
       structuredContent: response,

package/dist/zephyr/tool/test-case/get-links.js

@@ -0,0 +1,32 @@
+import { Tool } from "../../../common/tools.js";
+import { GetTestCaseLinks200Response, GetTestCaseLinksParams } from "../../common/rest-api-schemas.js";
+class GetTestCaseLinks extends Tool {
+  specification = {
+    title: "Get Test Case Links",
+    summary: "Get all links (issue links and web links) associated with a test case in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetTestCaseLinksParams,
+    outputSchema: GetTestCaseLinks200Response,
+    examples: [
+      {
+        description: "Get all links associated with the test case with key 'SA-T10'",
+        parameters: {
+          testCaseKey: "SA-T10"
+        },
+        expectedOutput: "The links (issue links and web links) associated with the test case"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const { testCaseKey } = GetTestCaseLinksParams.parse(args);
+    const response = await this.client.getApiClient().get(`/testcases/${testCaseKey}/links`);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  GetTestCaseLinks
+};

package/dist/zephyr/tool/test-case/get-test-script.js

@@ -0,0 +1,46 @@
+import { Tool } from "../../../common/tools.js";
+import { GetTestCaseTestScript200Response, GetTestCaseTestScriptParams } from "../../common/rest-api-schemas.js";
+class GetTestScript extends Tool {
+  specification = {
+    title: "Get Test Script",
+    summary: "Get the Test Script (Plain Text or BDD) for a given Test Case in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetTestCaseTestScriptParams,
+    outputSchema: GetTestCaseTestScript200Response,
+    examples: [
+      {
+        description: "Get the test script for test case with key 'SA-T1'",
+        parameters: {
+          testCaseKey: "SA-T1"
+        },
+        expectedOutput: "The test script with its type (plain or bdd), text content, and id"
+      },
+      {
+        description: "Retrieve the BDD test script content for test case with key 'MM2-T15'",
+        parameters: {
+          testCaseKey: "MM2-T15"
+        },
+        expectedOutput: "The test script with its type (plain or bdd), text content, and id"
+      },
+      {
+        description: "Get the test script for test case with key 'QA-T100' to review the test instructions",
+        parameters: {
+          testCaseKey: "QA-T100"
+        },
+        expectedOutput: "The test script with its type (plain or bdd), text content, and id"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const { testCaseKey } = GetTestCaseTestScriptParams.parse(args);
+    const response = await this.client.getApiClient().get(`/testcases/${testCaseKey}/testscript`);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  GetTestScript
+};

package/dist/zephyr/tool/test-case/get-test-steps.js

@@ -0,0 +1,56 @@
+import { Tool } from "../../../common/tools.js";
+import { GetTestCaseTestSteps200Response, GetTestCaseTestStepsParams, GetTestCaseTestStepsQueryParams } from "../../common/rest-api-schemas.js";
+class GetTestCaseSteps extends Tool {
+  specification = {
+    title: "Get Test Case Steps",
+    summary: "Get details of test case steps in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetTestCaseTestStepsParams.and(
+      GetTestCaseTestStepsQueryParams.partial()
+    ),
+    outputSchema: GetTestCaseTestSteps200Response,
+    examples: [
+      {
+        description: "Get the first 10 test case steps for test case with key 'SA-T1'",
+        parameters: {
+          testCaseKey: "SA-T1",
+          maxResults: 10,
+          startAt: 0
+        },
+        expectedOutput: "The first 10 test case steps with their details"
+      },
+      {
+        description: "Get any test case step for test case with key 'SA-T1'",
+        parameters: {
+          testCaseKey: "SA-T1",
+          maxResults: 1
+        },
+        expectedOutput: "One test case step with its details"
+      },
+      {
+        description: "Get five test case steps starting from the 7th test case step of the list for test case with key 'SA-T1'",
+        parameters: {
+          testCaseKey: "SA-T1",
+          maxResults: 5,
+          startAt: 6
+        },
+        expectedOutput: "The 7th to the 11th test case steps with their details"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const parsed = GetTestCaseTestStepsParams.and(
+      GetTestCaseTestStepsQueryParams
+    ).parse(args);
+    const { testCaseKey, ...parsedArgs } = parsed;
+    const response = await this.client.getApiClient().get(`/testcases/${testCaseKey}/teststeps`, parsedArgs);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  GetTestCaseSteps
+};

package/dist/zephyr/tool/test-cycle/create-issue-link.js

@@ -0,0 +1,45 @@
+import { Tool } from "../../../common/tools.js";
+import { CreateTestCycleIssueLinkParams, CreateTestCycleIssueLinkBody } from "../../common/rest-api-schemas.js";
+class CreateTestCycleIssueLink extends Tool {
+  specification = {
+    title: "Create Test Cycle Issue Link",
+    summary: "Create a new link between an issue in Jira and a Test Cycle in Zephyr",
+    readOnly: false,
+    idempotent: false,
+    inputSchema: CreateTestCycleIssueLinkParams.and(
+      CreateTestCycleIssueLinkBody
+    ),
+    examples: [
+      {
+        description: "Create a link between the test cycle with key SA-R1 and the Jira Issue ID 10100",
+        parameters: {
+          testCycleIdOrKey: "SA-R1",
+          issueId: 10100
+        },
+        expectedOutput: "The link between Test Cycle and Jira issue should be created, but no output is expected."
+      },
+      {
+        description: "Create a link between the test cycle with ID 1001 and the Jira issue ID 20200",
+        parameters: {
+          testCycleIdOrKey: "1001",
+          issueId: 20200
+        },
+        expectedOutput: "The link between Test Cycle and Jira issue should be created, but no output is expected."
+      }
+    ]
+  };
+  handle = async (args) => {
+    const parsed = CreateTestCycleIssueLinkParams.and(
+      CreateTestCycleIssueLinkBody
+    ).parse(args);
+    const { testCycleIdOrKey, ...body } = parsed;
+    await this.client.getApiClient().post(`/testcycles/${testCycleIdOrKey}/links/issues`, body);
+    return {
+      structuredContent: {},
+      content: []
+    };
+  };
+}
+export {
+  CreateTestCycleIssueLink
+};

package/dist/zephyr/tool/test-cycle/create-web-link.js

@@ -0,0 +1,56 @@
+import { Tool } from "../../../common/tools.js";
+import { CreateTestCycleWebLinkParams, CreateTestCycleWebLinkBody } from "../../common/rest-api-schemas.js";
+class CreateTestCycleWebLink extends Tool {
+  specification = {
+    title: "Create Test Cycle Web Link",
+    summary: "Create a new Web Link for a Test Cycle in Zephyr",
+    readOnly: false,
+    idempotent: false,
+    inputSchema: CreateTestCycleWebLinkParams.and(
+      CreateTestCycleWebLinkBody.partial()
+    ),
+    examples: [
+      {
+        description: "Create a link between the specified test cycle by Id '100001' and generic URL 'https://www.atlassian.com' with description 'Atlassian homepage'",
+        parameters: {
+          testCycleIdOrKey: "100001",
+          url: "https://www.atlassian.com",
+          description: "Atlassian homepage"
+        },
+        expectedOutput: "The newly created Web Link with its ID and self link"
+      },
+      {
+        description: "Create a web link for test cycle 'SA-R15' pointing to url: 'https://atlassian.com' with description 'Atlassian homepage'",
+        parameters: {
+          testCycleIdOrKey: "SA-R15",
+          url: "https://atlassian.com",
+          description: "Documentation for pump specifications"
+        },
+        expectedOutput: "The newly created Web Link with its ID and self link"
+      },
+      {
+        description: "Attach a documentation link 'https://docs.atlassian.com'  to test cycle MM2-R15 for pump specifications",
+        parameters: {
+          testCycleIdOrKey: "10001",
+          url: "https://docs.atlassian.com",
+          description: "Documentation for pump specifications"
+        },
+        expectedOutput: "The newly created Web Link with its ID and self link"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const parsed = CreateTestCycleWebLinkParams.and(
+      CreateTestCycleWebLinkBody
+    ).parse(args);
+    const { testCycleIdOrKey, ...body } = parsed;
+    const response = await this.client.getApiClient().post(`/testcycles/${testCycleIdOrKey}/links/weblinks`, body);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  CreateTestCycleWebLink
+};

package/dist/zephyr/tool/test-cycle/get-links.js

@@ -0,0 +1,39 @@
+import { Tool } from "../../../common/tools.js";
+import { GetTestCycleLinks200Response, GetTestCycleLinksParams } from "../../common/rest-api-schemas.js";
+class GetTestCycleLinks extends Tool {
+  specification = {
+    title: "Get Test Cycle Links",
+    summary: "Get all links (issues, web links, and test plans) associated with a test cycle in Zephyr",
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetTestCycleLinksParams,
+    outputSchema: GetTestCycleLinks200Response,
+    examples: [
+      {
+        description: "Get all links for test cycle with id 1",
+        parameters: {
+          testCycleIdOrKey: "1"
+        },
+        expectedOutput: "All links (issues, web links, test plans) for the test cycle"
+      },
+      {
+        description: "Get all links for test cycle with key 'SA-R40'",
+        parameters: {
+          testCycleIdOrKey: "SA-R40"
+        },
+        expectedOutput: "All links (issues, web links, test plans) for the test cycle with key SA-R40"
+      }
+    ]
+  };
+  handle = async (args) => {
+    const { testCycleIdOrKey } = GetTestCycleLinksParams.parse(args);
+    const response = await this.client.getApiClient().get(`/testcycles/${testCycleIdOrKey}/links`);
+    return {
+      structuredContent: response,
+      content: []
+    };
+  };
+}
+export {
+  GetTestCycleLinks
+};