@smartbear/mcp 0.10.0 → 0.11.0

package/dist/zephyr/common/rest-api-schemas.js

@@ -142,16 +142,16 @@ export const listTestCasesResponse = zod
             .describe("Data and time test case was created. Format: yyyy-MM-dd'T'HH:mm:ss'Z'. This field is read-only, cannot be updated.\n"),
         objective: zod
             .string()
-            .optional()
+            .nullish()
             .describe("A description of the objective."),
         precondition: zod
             .string()
-            .optional()
+            .nullish()
             .describe("Any conditions that need to be met."),
         estimatedTime: zod
             .number()
             .min(listTestCasesResponseValuesItemEstimatedTimeMin)
-            .optional()
+            .nullish()
             .describe("Estimated duration in milliseconds."),
         labels: zod
             .array(zod.string())
@@ -169,7 +169,7 @@ export const listTestCasesResponse = zod
                 .optional()
                 .describe("The REST API endpoint to get more resource details."),
         }))
-            .optional(),
+            .nullish(),
         priority: zod
             .object({
             id: zod.number().min(1),
@@ -212,6 +212,7 @@ export const listTestCasesResponse = zod
             accountId: zod
                 .string()
                 .regex(listTestCasesResponseValuesItemOwnerAccountIdRegExp)
+                .nullable()
                 .describe("Atlassian Account ID of the Jira user."),
             self: zod
                 .string()
@@ -320,13 +321,10 @@ export const createTestCaseBody = zod.object({
         .regex(createTestCaseBodyProjectKeyRegExp)
         .describe("Jira project key."),
     name: zod.string().regex(createTestCaseBodyNameRegExp),
-    objective: zod
-        .string()
-        .optional()
-        .describe("A description of the objective."),
+    objective: zod.string().nullish().describe("A description of the objective."),
     precondition: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Any conditions that need to be met."),
     estimatedTime: zod
         .number()
@@ -358,7 +356,7 @@ export const createTestCaseBody = zod.object({
     ownerId: zod
         .string()
         .regex(createTestCaseBodyOwnerIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     labels: zod
         .array(zod.string())
@@ -452,16 +450,16 @@ export const listTestCasesCursorPaginatedResponse = zod
             .describe("Data and time test case was created. Format: yyyy-MM-dd'T'HH:mm:ss'Z'. This field is read-only, cannot be updated.\n"),
         objective: zod
             .string()
-            .optional()
+            .nullish()
             .describe("A description of the objective."),
         precondition: zod
             .string()
-            .optional()
+            .nullish()
             .describe("Any conditions that need to be met."),
         estimatedTime: zod
             .number()
             .min(listTestCasesCursorPaginatedResponseValuesItemEstimatedTimeMin)
-            .optional()
+            .nullish()
             .describe("Estimated duration in milliseconds."),
         labels: zod
             .array(zod.string())
@@ -479,7 +477,7 @@ export const listTestCasesCursorPaginatedResponse = zod
                 .optional()
                 .describe("The REST API endpoint to get more resource details."),
         }))
-            .optional(),
+            .nullish(),
         priority: zod
             .object({
             id: zod.number().min(1),
@@ -522,6 +520,7 @@ export const listTestCasesCursorPaginatedResponse = zod
             accountId: zod
                 .string()
                 .regex(listTestCasesCursorPaginatedResponseValuesItemOwnerAccountIdRegExp)
+                .nullable()
                 .describe("Atlassian Account ID of the Jira user."),
             self: zod
                 .string()
@@ -652,18 +651,15 @@ export const getTestCaseResponse = zod.object({
         .datetime({})
         .optional()
         .describe("Data and time test case was created. Format: yyyy-MM-dd'T'HH:mm:ss'Z'. This field is read-only, cannot be updated.\n"),
-    objective: zod
-        .string()
-        .optional()
-        .describe("A description of the objective."),
+    objective: zod.string().nullish().describe("A description of the objective."),
     precondition: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Any conditions that need to be met."),
     estimatedTime: zod
         .number()
         .min(getTestCaseResponseEstimatedTimeMin)
-        .optional()
+        .nullish()
         .describe("Estimated duration in milliseconds."),
     labels: zod
         .array(zod.string())
@@ -681,7 +677,7 @@ export const getTestCaseResponse = zod.object({
             .optional()
             .describe("The REST API endpoint to get more resource details."),
     }))
-        .optional(),
+        .nullish(),
     priority: zod
         .object({
         id: zod.number().min(1),
@@ -724,6 +720,7 @@ export const getTestCaseResponse = zod.object({
         accountId: zod
             .string()
             .regex(getTestCaseResponseOwnerAccountIdRegExp)
+            .nullable()
             .describe("Atlassian Account ID of the Jira user."),
         self: zod
             .string()
@@ -850,18 +847,15 @@ export const updateTestCaseBody = zod.object({
         .datetime({})
         .optional()
         .describe("Data and time test case was created. Format: yyyy-MM-dd'T'HH:mm:ss'Z'. This field is read-only, cannot be updated.\n"),
-    objective: zod
-        .string()
-        .optional()
-        .describe("A description of the objective."),
+    objective: zod.string().nullish().describe("A description of the objective."),
     precondition: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Any conditions that need to be met."),
     estimatedTime: zod
         .number()
         .min(updateTestCaseBodyEstimatedTimeMin)
-        .optional()
+        .nullish()
         .describe("Estimated duration in milliseconds."),
     labels: zod
         .array(zod.string())
@@ -879,7 +873,7 @@ export const updateTestCaseBody = zod.object({
             .optional()
             .describe("The REST API endpoint to get more resource details."),
     }))
-        .optional(),
+        .nullish(),
     priority: zod
         .object({
         id: zod.number().min(1),
@@ -922,6 +916,7 @@ export const updateTestCaseBody = zod.object({
         accountId: zod
             .string()
             .regex(updateTestCaseBodyOwnerAccountIdRegExp)
+            .nullable()
             .describe("Atlassian Account ID of the Jira user."),
         self: zod
             .string()
@@ -1221,18 +1216,15 @@ export const getTestCaseVersionResponse = zod.object({
         .datetime({})
         .optional()
         .describe("Data and time test case was created. Format: yyyy-MM-dd'T'HH:mm:ss'Z'. This field is read-only, cannot be updated.\n"),
-    objective: zod
-        .string()
-        .optional()
-        .describe("A description of the objective."),
+    objective: zod.string().nullish().describe("A description of the objective."),
     precondition: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Any conditions that need to be met."),
     estimatedTime: zod
         .number()
         .min(getTestCaseVersionResponseEstimatedTimeMin)
-        .optional()
+        .nullish()
         .describe("Estimated duration in milliseconds."),
     labels: zod
         .array(zod.string())
@@ -1250,7 +1242,7 @@ export const getTestCaseVersionResponse = zod.object({
             .optional()
             .describe("The REST API endpoint to get more resource details."),
     }))
-        .optional(),
+        .nullish(),
     priority: zod
         .object({
         id: zod.number().min(1),
@@ -1293,6 +1285,7 @@ export const getTestCaseVersionResponse = zod.object({
         accountId: zod
             .string()
             .regex(getTestCaseVersionResponseOwnerAccountIdRegExp)
+            .nullable()
             .describe("Atlassian Account ID of the Jira user."),
         self: zod
             .string()
@@ -1773,6 +1766,7 @@ export const listTestCyclesResponse = zod
             accountId: zod
                 .string()
                 .regex(listTestCyclesResponseValuesItemOwnerAccountIdRegExp)
+                .nullable()
                 .describe("Atlassian Account ID of the Jira user."),
             self: zod
                 .string()
@@ -1933,7 +1927,7 @@ export const createTestCycleBody = zod.object({
     ownerId: zod
         .string()
         .regex(createTestCycleBodyOwnerIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     customFields: zod
         .record(zod.string(), zod.unknown())
@@ -2036,6 +2030,7 @@ export const getTestCycleResponse = zod
         accountId: zod
             .string()
             .regex(getTestCycleResponseOwnerAccountIdRegExp)
+            .nullable()
             .describe("Atlassian Account ID of the Jira user."),
         self: zod
             .string()
@@ -2238,6 +2233,7 @@ export const updateTestCycleBody = zod
         accountId: zod
             .string()
             .regex(updateTestCycleBodyOwnerAccountIdRegExp)
+            .nullable()
             .describe("Atlassian Account ID of the Jira user."),
         self: zod
             .string()
@@ -2541,7 +2537,7 @@ export const listTestPlansResponse = zod
         name: zod.string().regex(listTestPlansResponseValuesItemNameRegExp),
         objective: zod
             .string()
-            .optional()
+            .nullish()
             .describe("A description of the objective."),
         project: zod
             .object({
@@ -2586,6 +2582,7 @@ export const listTestPlansResponse = zod
             accountId: zod
                 .string()
                 .regex(listTestPlansResponseValuesItemOwnerAccountIdRegExp)
+                .nullable()
                 .describe("Atlassian Account ID of the Jira user."),
             self: zod
                 .string()
@@ -2703,10 +2700,7 @@ export const createTestPlanBody = zod.object({
         .regex(createTestPlanBodyProjectKeyRegExp)
         .describe("Jira project key."),
     name: zod.string().regex(createTestPlanBodyNameRegExp),
-    objective: zod
-        .string()
-        .optional()
-        .describe("A description of the objective."),
+    objective: zod.string().nullish().describe("A description of the objective."),
     folderId: zod
         .number()
         .min(1)
@@ -2721,7 +2715,7 @@ export const createTestPlanBody = zod.object({
     ownerId: zod
         .string()
         .regex(createTestPlanBodyOwnerIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     labels: zod
         .array(zod.string())
@@ -2753,10 +2747,7 @@ export const getTestPlanResponse = zod.object({
         .regex(getTestPlanResponseKeyRegExp)
         .describe("Key of the test plan"),
     name: zod.string().regex(getTestPlanResponseNameRegExp),
-    objective: zod
-        .string()
-        .optional()
-        .describe("A description of the objective."),
+    objective: zod.string().nullish().describe("A description of the objective."),
     project: zod
         .object({
         id: zod.number().min(1),
@@ -2800,6 +2791,7 @@ export const getTestPlanResponse = zod.object({
         accountId: zod
             .string()
             .regex(getTestPlanResponseOwnerAccountIdRegExp)
+            .nullable()
             .describe("Atlassian Account ID of the Jira user."),
         self: zod
             .string()
@@ -3088,7 +3080,7 @@ export const listTestExecutionsResponse = zod
                 .optional()
                 .describe("The REST API endpoint to get more resource details."),
         }))
-            .optional(),
+            .nullish(),
         jiraProjectVersion: zod
             .object({
             id: zod.number().min(1),
@@ -3123,26 +3115,26 @@ export const listTestExecutionsResponse = zod
         estimatedTime: zod
             .number()
             .min(listTestExecutionsResponseValuesItemEstimatedTimeMin)
-            .optional()
+            .nullish()
             .describe("Estimated duration in milliseconds."),
         executionTime: zod
             .number()
             .min(listTestExecutionsResponseValuesItemExecutionTimeMin)
-            .optional()
+            .nullish()
             .describe("Actual test execution time in milliseconds."),
         executedById: zod
             .string()
             .regex(listTestExecutionsResponseValuesItemExecutedByIdRegExp)
-            .optional()
+            .nullish()
             .describe("Atlassian Account ID of the Jira user."),
         assignedToId: zod
             .string()
             .regex(listTestExecutionsResponseValuesItemAssignedToIdRegExp)
-            .optional()
+            .nullish()
             .describe("Atlassian Account ID of the Jira user."),
         comment: zod
             .string()
-            .optional()
+            .nullish()
             .describe("Comment added against overall test case execution."),
         automated: zod
             .boolean()
@@ -3159,7 +3151,7 @@ export const listTestExecutionsResponse = zod
             .and(zod.object({
             id: zod.number().min(1).optional(),
         }))
-            .optional(),
+            .nullish(),
         customFields: zod
             .record(zod.string(), zod.unknown())
             .optional()
@@ -3274,16 +3266,16 @@ export const createTestExecutionBody = zod.object({
     executedById: zod
         .string()
         .regex(createTestExecutionBodyExecutedByIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     assignedToId: zod
         .string()
         .regex(createTestExecutionBodyAssignedToIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     comment: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Comment added against overall test case execution."),
     customFields: zod
         .record(zod.string(), zod.unknown())
@@ -3424,7 +3416,7 @@ export const listTestExecutionsNextgenResponse = zod
                 .optional()
                 .describe("The REST API endpoint to get more resource details."),
         }))
-            .optional(),
+            .nullish(),
         jiraProjectVersion: zod
             .object({
             id: zod.number().min(1),
@@ -3459,26 +3451,26 @@ export const listTestExecutionsNextgenResponse = zod
         estimatedTime: zod
             .number()
             .min(listTestExecutionsNextgenResponseValuesItemEstimatedTimeMin)
-            .optional()
+            .nullish()
             .describe("Estimated duration in milliseconds."),
         executionTime: zod
             .number()
             .min(listTestExecutionsNextgenResponseValuesItemExecutionTimeMin)
-            .optional()
+            .nullish()
             .describe("Actual test execution time in milliseconds."),
         executedById: zod
             .string()
             .regex(listTestExecutionsNextgenResponseValuesItemExecutedByIdRegExp)
-            .optional()
+            .nullish()
             .describe("Atlassian Account ID of the Jira user."),
         assignedToId: zod
             .string()
             .regex(listTestExecutionsNextgenResponseValuesItemAssignedToIdRegExp)
-            .optional()
+            .nullish()
             .describe("Atlassian Account ID of the Jira user."),
         comment: zod
             .string()
-            .optional()
+            .nullish()
             .describe("Comment added against overall test case execution."),
         automated: zod
             .boolean()
@@ -3495,7 +3487,7 @@ export const listTestExecutionsNextgenResponse = zod
             .and(zod.object({
             id: zod.number().min(1).optional(),
         }))
-            .optional(),
+            .nullish(),
         customFields: zod
             .record(zod.string(), zod.unknown())
             .optional()
@@ -3611,7 +3603,7 @@ export const getTestExecutionResponse = zod.object({
             .optional()
             .describe("The REST API endpoint to get more resource details."),
     }))
-        .optional(),
+        .nullish(),
     jiraProjectVersion: zod
         .object({
         id: zod.number().min(1),
@@ -3646,26 +3638,26 @@ export const getTestExecutionResponse = zod.object({
     estimatedTime: zod
         .number()
         .min(getTestExecutionResponseEstimatedTimeMin)
-        .optional()
+        .nullish()
         .describe("Estimated duration in milliseconds."),
     executionTime: zod
         .number()
         .min(getTestExecutionResponseExecutionTimeMin)
-        .optional()
+        .nullish()
         .describe("Actual test execution time in milliseconds."),
     executedById: zod
         .string()
         .regex(getTestExecutionResponseExecutedByIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     assignedToId: zod
         .string()
         .regex(getTestExecutionResponseAssignedToIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     comment: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Comment added against overall test case execution."),
     automated: zod
         .boolean()
@@ -3682,7 +3674,7 @@ export const getTestExecutionResponse = zod.object({
         .and(zod.object({
         id: zod.number().min(1).optional(),
     }))
-        .optional(),
+        .nullish(),
     customFields: zod
         .record(zod.string(), zod.unknown())
         .optional()
@@ -3766,16 +3758,16 @@ export const updateTestExecutionBody = zod.object({
     executedById: zod
         .string()
         .regex(updateTestExecutionBodyExecutedByIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     assignedToId: zod
         .string()
         .regex(updateTestExecutionBodyAssignedToIdRegExp)
-        .optional()
+        .nullish()
         .describe("Atlassian Account ID of the Jira user."),
     comment: zod
         .string()
-        .optional()
+        .nullish()
         .describe("Comment added against overall test case execution."),
 });
 /**
@@ -4460,7 +4452,10 @@ export const listStatusesQueryParams = zod.object({
         .regex(listStatusesQueryProjectKeyRegExp)
         .optional()
         .describe("Jira project key filter"),
-    statusType: zod.string().optional(),
+    statusType: zod
+        .enum(["TEST_CASE", "TEST_PLAN", "TEST_CYCLE", "TEST_EXECUTION"])
+        .optional()
+        .describe("Determines which type of entity the status belongs to."),
 });
 export const listStatusesResponseStartAtMin = 0;
 export const listStatusesResponseTotalMin = 0;
@@ -4522,7 +4517,10 @@ export const listStatusesResponse = zod
     })
         .and(zod.object({
         color: zod.string().optional(),
-        archived: zod.boolean().optional(),
+        archived: zod
+            .boolean()
+            .optional()
+            .describe("Determines whether the status is archived. Archived statuses are read-only and cannot be assigned to entities."),
         default: zod.boolean().optional(),
     })))
         .optional(),
@@ -4546,8 +4544,8 @@ export const createStatusBody = zod.object({
         .max(createStatusBodyNameMax)
         .describe("The status name."),
     type: zod
-        .string()
-        .describe('Valid values: `"TEST_CASE"`, `"TEST_PLAN"`, `"TEST_CYCLE"`, `"TEST_EXECUTION"`'),
+        .enum(["TEST_CASE", "TEST_PLAN", "TEST_CYCLE", "TEST_EXECUTION"])
+        .describe("Determines which type of entity the status belongs to."),
     description: zod
         .string()
         .min(1)
@@ -4596,7 +4594,10 @@ export const getStatusResponse = zod
 })
     .and(zod.object({
     color: zod.string().optional(),
-    archived: zod.boolean().optional(),
+    archived: zod
+        .boolean()
+        .optional()
+        .describe("Determines whether the status is archived. Archived statuses are read-only and cannot be assigned to entities."),
     default: zod.boolean().optional(),
 }));
 /**

package/dist/zephyr/tool/priority/get-priorities.js

@@ -0,0 +1,43 @@
+import { listPrioritiesQueryParams, listPrioritiesResponse, } from "../../common/rest-api-schemas.js";
+export class GetPriorities {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get priorities",
+        summary: "Get Zephyr Test Case priorities with optional filters",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listPrioritiesQueryParams,
+        outputSchema: listPrioritiesResponse,
+        examples: [
+            {
+                description: "Get the first 10 priorities",
+                parameters: {
+                    maxResults: 10,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 10 priorities with their details",
+            },
+            {
+                description: "Get priorities for a specific project",
+                parameters: { projectKey: "PROJ" },
+                expectedOutput: "The priorities for project PROJ",
+            },
+            {
+                description: "Get all priorities",
+                parameters: {},
+                expectedOutput: "All priorities",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const getPrioritiesInput = listPrioritiesQueryParams.parse(args);
+        const response = await this.apiClient.get("/priorities", getPrioritiesInput);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

package/dist/zephyr/tool/status/get-statuses.js

@@ -0,0 +1,49 @@
+import { listStatusesQueryParams, listStatusesResponse, } from "../../common/rest-api-schemas.js";
+export class GetStatuses {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Statuses",
+        summary: "Get statuses of different types of test artifacts in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: listStatusesQueryParams,
+        outputSchema: listStatusesResponse,
+        examples: [
+            {
+                description: "Get the first 10 statuses",
+                parameters: {
+                    maxResults: 10,
+                    startAt: 0,
+                },
+                expectedOutput: "The first 10 statuses with their details from different projects and test artifact types",
+            },
+            {
+                description: "Get 10 test case statuses",
+                parameters: {
+                    maxResults: 10,
+                    statusType: "TEST_CASE",
+                },
+                expectedOutput: "A list of statuses related to test cases with their details",
+            },
+            {
+                description: "Get five statuses from the project PROJ",
+                parameters: {
+                    maxResults: 5,
+                    projectKey: "PROJ",
+                },
+                expectedOutput: "The first five statuses from the project PROJ with their details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const getStatusesInput = listStatusesQueryParams.parse(args);
+        const response = await this.apiClient.get("/statuses", getStatusesInput);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}

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

@@ -0,0 +1,39 @@
+import { getTestCaseParams, getTestCaseResponse, } from "../../common/rest-api-schemas.js";
+export class GetTestCase {
+    apiClient;
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    specification = {
+        title: "Get Test Case",
+        summary: "Get details of test case specified by key in Zephyr",
+        readOnly: true,
+        idempotent: true,
+        inputSchema: getTestCaseParams,
+        outputSchema: getTestCaseResponse,
+        examples: [
+            {
+                description: "Get the test case with key 'SA-T10'",
+                parameters: {
+                    testCaseKey: "SA-T10",
+                },
+                expectedOutput: "The test case with its details",
+            },
+            {
+                description: "Get the test case with key 'MM2-T1'",
+                parameters: {
+                    testCaseKey: "MM2-T1",
+                },
+                expectedOutput: "The test case with its details",
+            },
+        ],
+    };
+    handle = async (args) => {
+        const { testCaseKey } = getTestCaseParams.parse(args);
+        const response = await this.apiClient.get(`/testcases/${testCaseKey}`);
+        return {
+            structuredContent: response,
+            content: [],
+        };
+    };
+}