@smartbear/mcp 0.20.0 → 0.22.0

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

@@ -0,0 +1,111 @@
+import { Tool, ToolError } from "../../../common/tools.js";
+import { TOOL_NAMES, RESPONSE_FIELDS, ENDPOINTS } from "../../config/constants.js";
+import { ResolverKeys } from "../../config/field-resolution.types.js";
+import { GetTestStepsResponse, GetTestStepsBody } from "../../schema/get-test-steps.schema.js";
+class GetTestSteps extends Tool {
+  specification = {
+    title: TOOL_NAMES.GET_TEST_STEPS.TITLE,
+    summary: TOOL_NAMES.GET_TEST_STEPS.SUMMARY,
+    readOnly: true,
+    idempotent: true,
+    inputSchema: GetTestStepsBody,
+    outputSchema: GetTestStepsResponse,
+    purpose: "Retrieve the test steps for a specific test case version using the human-readable test case key. The key is automatically resolved to the internal test case UID via a dedicated batch API — no separate lookup required. Test steps describe the step-by-step actions (stepDetails), input data (testData), and expected results (expectedResult) for executing a test case. Steps may also reference shared (reusable) test cases, surfaced via the 'shareable' field. PREREQUISITE: set_project_context must be called before this tool.",
+    useCases: [
+      "View all steps of a test case before executing it",
+      "Review steps for a specific test case version",
+      "Filter steps by action text, test data, or expected result",
+      "Get steps for a test case found via search_test_cases",
+      "Inspect shared (reusable) steps embedded in a test case",
+      "Sort steps by sequence number to view them in execution order",
+      "Paginate through test cases that have a large number of steps"
+    ],
+    examples: [
+      {
+        description: "Get all steps for a test case (latest version)",
+        parameters: { key: "SCRUM-TC-145" },
+        expectedOutput: "All steps for SCRUM-TC-145 with stepDetails, testData, expectedResult, and any shared step blocks"
+      },
+      {
+        description: "Get steps for a specific version",
+        parameters: { key: "SCRUM-TC-145", versionNo: 2 },
+        expectedOutput: "Steps for version 2 of SCRUM-TC-145"
+      },
+      {
+        description: "Get steps in execution order",
+        parameters: { key: "SCRUM-TC-85", sort: "seqNo:asc" },
+        expectedOutput: "All steps sorted by sequence number ascending"
+      },
+      {
+        description: "Filter steps by action text",
+        parameters: {
+          key: "SCRUM-TC-32",
+          filter: { stepDetails: "Open the application" }
+        },
+        expectedOutput: "Steps whose stepDetails contain 'Open the application'"
+      },
+      {
+        description: "Filter steps by expected result",
+        parameters: {
+          key: "SCRUM-TC-65",
+          filter: { expectedResult: "logged in successfully" }
+        },
+        expectedOutput: "Steps whose expectedResult contains 'logged in successfully'"
+      },
+      {
+        description: "Filter steps by test data",
+        parameters: {
+          key: "SCRUM-TC-125",
+          filter: { testData: "Username: user1" }
+        },
+        expectedOutput: "Steps with testData containing 'Username: user1'"
+      },
+      {
+        description: "Paginate through many steps",
+        parameters: {
+          key: "SCRUM-TC-105",
+          startAt: 0,
+          maxResults: 10,
+          sort: "seqNo:asc"
+        },
+        expectedOutput: "First 10 steps in sequence order"
+      }
+    ],
+    hints: [
+      "PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project.",
+      "KEY FORMAT: '{PROJECT_KEY}-TC-{number}' — e.g. 'SCRUM-TC-145'. PROJECT_KEY is the Jira project key; the number is the test case counter within that project (auto-incremented, not the same as seqNo).",
+      "VERSION: versionNo defaults to the latest version. Get the version number from search_test_cases response: version.versionNo.",
+      "Use search_test_cases to discover test case keys before calling this tool.",
+      "SHAREABLE STEPS: Steps with a non-null 'shareable' field are references to shared/reusable test cases. The 'shareable.shareableTestSteps' array contains the embedded sub-steps with decimal seqNo values (e.g. '1.1', '1.2').",
+      "FILTER: Each filter field is a substring match (case-insensitive). Multiple fields combine with AND.",
+      "SORT: 'seqNo:asc' shows steps in their natural execution order. Allowed sort fields: stepDetails, testData, seqNo, expectedResult.",
+      "PAGINATION: startAt and maxResults are URL query params. Default page size is 50, maximum is 100."
+    ],
+    outputDescription: "JSON object with total (total matching steps), startAt, maxResults, and data (array of step objects). Each step has: id, seqNo, stepDetails, testData, expectedResult, attachmentCount. Shared steps also have a 'shareable' object containing shareableTestcaseUID and shareableTestSteps array."
+  };
+  handle = async (rawArgs) => {
+    const args = GetTestStepsBody.parse(rawArgs);
+    const fieldResolver = this.client.getResolverRegistry();
+    const context = fieldResolver.requireProjectContext();
+    const resolved = await fieldResolver.getResolver(ResolverKeys.SearchableField.TEST_CASE_KEY_TO_UID).resolveAndReturn(context.projectId, [args.key]);
+    const entry = resolved[args.key];
+    if (!entry) {
+      throw new ToolError(
+        `Test case '${args.key}' not found in project '${context.projectKey}'. Verify the key using the search_test_cases tool.`
+      );
+    }
+    const versionNo = args.versionNo ?? entry.latestVersion;
+    const params = new URLSearchParams();
+    params.set(RESPONSE_FIELDS.START_AT, String(args.startAt));
+    params.set(RESPONSE_FIELDS.MAX_RESULTS, String(args.maxResults));
+    if (args.sort) params.set(RESPONSE_FIELDS.SORT, args.sort);
+    const endpoint = `${ENDPOINTS.TEST_STEPS(entry.uid, versionNo)}?${params.toString()}`;
+    const filterBody = args.filter && Object.keys(args.filter).length > 0 ? { filter: args.filter } : {};
+    const response = await this.client.getApiClient().post(endpoint, filterBody);
+    const validated = GetTestStepsResponse.parse(response);
+    return { structuredContent: validated, content: [] };
+  };
+}
+export {
+  GetTestSteps
+};

package/dist/qtm4j/tool/test-case/update-test-case.js

@@ -0,0 +1,158 @@
+import { Tool, ToolError } from "../../../common/tools.js";
+import { TOOL_NAMES, ENDPOINTS } from "../../config/constants.js";
+import { ResolverKeys, InputField } from "../../config/field-resolution.types.js";
+import { UpdateTestCaseResponse, UpdateTestCaseBody } from "../../schema/update-test-case.schema.js";
+const SIMPLE_FIELD_CONFIG = {
+  [InputField.PRIORITY]: ResolverKeys.CommonAttribute.PRIORITY,
+  [InputField.STATUS]: ResolverKeys.CommonAttribute.TESTCASE_STATUS
+};
+const ADD_DELETE_FIELD_CONFIG = {
+  [InputField.LABELS]: ResolverKeys.SearchableField.LABEL,
+  [InputField.COMPONENTS]: ResolverKeys.SearchableField.COMPONENTS
+};
+async function resolveAddDelete(resolver, inputField, resolverKey, field, context, warnings) {
+  const result = {};
+  for (const op of ["add", "delete"]) {
+    const names = field[op];
+    if (!names?.length) continue;
+    const tempBody = { [inputField]: names };
+    await resolver.resolve(
+      inputField,
+      resolverKey,
+      tempBody,
+      context,
+      warnings
+    );
+    const val = tempBody[inputField];
+    if (Array.isArray(val) && val.length > 0 && typeof val[0] === "number") {
+      result[op] = val;
+    }
+  }
+  return result;
+}
+class UpdateTestCase extends Tool {
+  specification = {
+    title: TOOL_NAMES.UPDATE_TEST_CASE.TITLE,
+    summary: TOOL_NAMES.UPDATE_TEST_CASE.SUMMARY,
+    readOnly: false,
+    idempotent: true,
+    inputSchema: UpdateTestCaseBody,
+    outputSchema: UpdateTestCaseResponse,
+    purpose: "Update an existing test case in QTM4J using its human-readable key (e.g. 'SCRUM-TC-145'). The key is automatically resolved to the internal UID and latest version — no manual ID lookup needed. Only the fields you provide are changed — omitted fields are left as-is. For priority and status, supply the human-readable name and it is auto-resolved to the internal ID. For labels and components, use the add/delete object to atomically add or remove entries by name. PREREQUISITE: set_project_context must be called before this tool.",
+    useCases: [
+      "Change the priority of a test case (e.g., escalate to 'High')",
+      "Update the status of a test case after review",
+      "Add new labels or remove outdated ones without affecting other labels",
+      "Add or remove components from a test case",
+      "Update summary, description, or precondition text",
+      "Reassign a test case to a different team member",
+      "Set or update the estimated time for a test case",
+      "Batch-update metadata as part of sprint planning"
+    ],
+    examples: [
+      {
+        description: "Change the priority of a test case",
+        parameters: { key: "SCRUM-TC-145", priority: "High" },
+        expectedOutput: "Test case updated with new priority"
+      },
+      {
+        description: "Add a label and remove an old one",
+        parameters: {
+          key: "SCRUM-TC-145",
+          labels: { add: ["Release_2"], delete: ["Release_1"] }
+        },
+        expectedOutput: "Test case updated — Release_2 added, Release_1 removed"
+      },
+      {
+        description: "Update summary, status, and add a component",
+        parameters: {
+          key: "SCRUM-TC-32",
+          summary: "Verify login with MFA enabled",
+          status: "In Progress",
+          components: { add: ["Auth"] }
+        },
+        expectedOutput: "Test case summary and status updated, Auth component added"
+      },
+      {
+        description: "Update a specific version",
+        parameters: {
+          key: "SCRUM-TC-85",
+          versionNo: 2,
+          assignee: "5b10a2844c20165700ede21f",
+          estimatedTime: "01:30:00"
+        },
+        expectedOutput: "Version 2 of test case updated with new assignee and estimated time"
+      }
+    ],
+    hints: [
+      "PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project.",
+      "KEY FORMAT: '{PROJECT_KEY}-TC-{number}' — e.g. 'SCRUM-TC-145'.",
+      "Priority and status values come from set_project_context. Use NLP to map user intent to available names.",
+      "If priority or status name is not found, the field is skipped with a warning and other fields are still updated.",
+      "Labels and components use add/delete — you can add and delete in a single call. Names are auto-resolved.",
+      "To delete ALL current entries of any add/delete field: first call search_test_cases with filter.searchText set to the test case key and include the relevant field in the fields list, extract all current names from the response, then pass them in the delete array of this tool.",
+      "Only provide the fields you want to change. Omitted fields remain unchanged on the server.",
+      "estimatedTime must be in HH:MM:SS format (e.g., '02:30:00').",
+      "versionNo defaults to the latest version. Use search_test_cases to find available versions if needed."
+    ],
+    outputDescription: "Confirmation object with the test case key, versionNo updated, and updated: true. Warnings are included if any field names could not be resolved."
+  };
+  handle = async (rawArgs) => {
+    const args = UpdateTestCaseBody.parse(rawArgs);
+    const fieldResolver = this.client.getResolverRegistry();
+    const context = fieldResolver.requireProjectContext();
+    const warnings = [];
+    const uidMap = await fieldResolver.getResolver(ResolverKeys.SearchableField.TEST_CASE_KEY_TO_UID).resolveAndReturn(context.projectId, [args.key]);
+    const entry = uidMap[args.key];
+    if (!entry) {
+      throw new ToolError(
+        `Test case '${args.key}' not found in project '${context.projectKey}'. Verify the key using the search_test_cases tool.`
+      );
+    }
+    const versionNo = args.versionNo ?? entry.latestVersion;
+    const {
+      key: _key,
+      versionNo: _vno,
+      labels,
+      components,
+      ...scalarArgs
+    } = args;
+    const body = { ...scalarArgs };
+    await Promise.all(
+      Object.entries(SIMPLE_FIELD_CONFIG).map(
+        ([inputField, resolverKey]) => fieldResolver.getResolver(resolverKey).resolve(inputField, resolverKey, body, context, warnings)
+      )
+    );
+    for (const field of Object.keys(SIMPLE_FIELD_CONFIG)) {
+      if (typeof body[field] === "string") delete body[field];
+    }
+    for (const [inputField, resolverKey] of Object.entries(
+      ADD_DELETE_FIELD_CONFIG
+    )) {
+      const field = args[inputField];
+      if (!field) continue;
+      const resolvedField = await resolveAddDelete(
+        fieldResolver.getResolver(resolverKey),
+        inputField,
+        resolverKey,
+        field,
+        context,
+        warnings
+      );
+      if (Object.keys(resolvedField).length > 0)
+        body[inputField] = resolvedField;
+    }
+    await this.client.getApiClient().put(ENDPOINTS.UPDATE_TEST_CASE(entry.uid, versionNo), body);
+    return {
+      structuredContent: UpdateTestCaseResponse.parse({
+        key: args.key,
+        versionNo,
+        updated: true
+      }),
+      content: warnings.length > 0 ? [{ type: "text", text: `Note: ${warnings.join(" | ")}` }] : []
+    };
+  };
+}
+export {
+  UpdateTestCase
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartbear/mcp",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "description": "MCP server for interacting SmartBear Products",
   "keywords": [
     "smartbear",
@@ -9,7 +9,8 @@
     "reflect",
     "swagger",
     "pactflow",
-    "zephyr"
+    "zephyr",
+    "qtm4j"
   ],
   "homepage": "https://developer.smartbear.com/smartbear-mcp",
   "mcpName": "com.smartbear/smartbear-mcp",
@@ -32,6 +33,7 @@
   },
   "scripts": {
     "build": "tsc && vite build && shx chmod +x dist/*.js",
+    "build:mcpb": "npm run build && node scripts/pack-mcpb.js",
     "lint": "biome lint .",
     "lint:fix": "biome lint . --fix",
     "format": "biome format . --write",
@@ -44,8 +46,7 @@
     "test:coverage:ci": "vitest --coverage --reporter=verbose",
     "test:run": "vitest run",
     "coverage:check": "vitest --coverage --reporter=verbose",
-    "bump": "node scripts/bump.js",
-    "postpack": "node scripts/pack-mcpb.js"
+    "bump": "node scripts/bump.js"
   },
   "dependencies": {
     "@bugsnag/js": "^8.8.1",