@browserstack/mcp-server 1.0.12 → 1.0.14

package/dist/tools/testmanagement-utils/add-test-result.js

@@ -0,0 +1,61 @@
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
+/**
+ * Schema for adding a test result to a test run.
+ */
+export const AddTestResultSchema = z.object({
+    project_identifier: z
+        .string()
+        .describe("Identifier of the project (Starts with 'PR-')"),
+    test_run_id: z.string().describe("Identifier of the test run (e.g., TR-678)"),
+    test_result: z.object({
+        status: z
+            .string()
+            .describe("Status of the test result, e.g., 'passed', 'failed'."),
+        description: z
+            .string()
+            .optional()
+            .describe("Optional description of the test result."),
+    }),
+    test_case_id: z
+        .string()
+        .describe("Identifier of the test case, e.g., 'TC-13'."),
+});
+/**
+ * Adds a test result to a specific test run via BrowserStack Test Management API.
+ */
+export async function addTestResult(rawArgs) {
+    try {
+        const args = AddTestResultSchema.parse(rawArgs);
+        const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs/${encodeURIComponent(args.test_run_id)}/results`;
+        const body = {
+            test_result: args.test_result,
+            test_case_id: args.test_case_id,
+        };
+        const response = await axios.post(url, body, {
+            auth: {
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
+            },
+            headers: { "Content-Type": "application/json" },
+        });
+        const data = response.data;
+        if (!data.success) {
+            throw new Error(`API returned unsuccessful response: ${JSON.stringify(data)}`);
+        }
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Successfully added test result with ID=${data["test-result"].id}`,
+                },
+                { type: "text", text: JSON.stringify(data["test-result"], null, 2) },
+            ],
+        };
+    }
+    catch (err) {
+        return formatAxiosError(err, "Failed to add test result to test run");
+    }
+}

package/dist/tools/testmanagement-utils/create-project-folder.js

@@ -1,34 +1,27 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateProjFoldSchema = void 0;
-exports.createProjectOrFolder = createProjectOrFolder;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error"); // or correct path
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js"; // or correct path
 // Schema for combined project/folder creation
-exports.CreateProjFoldSchema = zod_1.z.object({
-    project_name: zod_1.z
+export const CreateProjFoldSchema = z.object({
+    project_name: z
         .string()
         .optional()
         .describe("Name of the project to create."),
-    project_description: zod_1.z
+    project_description: z
         .string()
         .optional()
         .describe("Description for the new project."),
-    project_identifier: zod_1.z
+    project_identifier: z
         .string()
         .optional()
         .describe("Existing project identifier to use for folder creation."),
-    folder_name: zod_1.z.string().optional().describe("Name of the folder to create."),
-    folder_description: zod_1.z
+    folder_name: z.string().optional().describe("Name of the folder to create."),
+    folder_description: z
         .string()
         .optional()
         .describe("Description for the new folder."),
-    parent_id: zod_1.z
+    parent_id: z
         .number()
         .optional()
         .describe("Parent folder ID; if omitted, folder is created at root."),
@@ -36,8 +29,8 @@ exports.CreateProjFoldSchema = zod_1.z.object({
 /**
  * Creates a project and/or folder in BrowserStack Test Management.
  */
-async function createProjectOrFolder(args) {
-    const { project_name, project_description, project_identifier, folder_name, folder_description, parent_id, } = exports.CreateProjFoldSchema.parse(args);
+export async function createProjectOrFolder(args) {
+    const { project_name, project_description, project_identifier, folder_name, folder_description, parent_id, } = CreateProjFoldSchema.parse(args);
     if (!project_name && !project_identifier && !folder_name) {
         throw new Error("Provide project_name (to create project), or project_identifier and folder_name (to create folder).");
     }
@@ -45,10 +38,10 @@ async function createProjectOrFolder(args) {
     // Step 1: Create project if project_name provided
     if (project_name) {
         try {
-            const res = await axios_1.default.post("https://test-management.browserstack.com/api/v2/projects", { project: { name: project_name, description: project_description } }, {
+            const res = await axios.post("https://test-management.browserstack.com/api/v2/projects", { project: { name: project_name, description: project_description } }, {
                 auth: {
-                    username: config_1.default.browserstackUsername,
-                    password: config_1.default.browserstackAccessKey,
+                    username: config.browserstackUsername,
+                    password: config.browserstackAccessKey,
                 },
                 headers: { "Content-Type": "application/json" },
             });
@@ -59,7 +52,7 @@ async function createProjectOrFolder(args) {
             projId = res.data.project.identifier;
         }
         catch (err) {
-            return (0, error_1.formatAxiosError)(err, "Failed to create project..");
+            return formatAxiosError(err, "Failed to create project..");
         }
     }
     // Step 2: Create folder if folder_name provided
@@ -67,7 +60,7 @@ async function createProjectOrFolder(args) {
         if (!projId)
             throw new Error("Cannot create folder without project_identifier.");
         try {
-            const res = await axios_1.default.post(`https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(projId)}/folders`, {
+            const res = await axios.post(`https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(projId)}/folders`, {
                 folder: {
                     name: folder_name,
                     description: folder_description,
@@ -75,8 +68,8 @@ async function createProjectOrFolder(args) {
                 },
             }, {
                 auth: {
-                    username: config_1.default.browserstackUsername,
-                    password: config_1.default.browserstackAccessKey,
+                    username: config.browserstackUsername,
+                    password: config.browserstackAccessKey,
                 },
                 headers: { "Content-Type": "application/json" },
             });
@@ -95,7 +88,7 @@ async function createProjectOrFolder(args) {
             };
         }
         catch (err) {
-            return (0, error_1.formatAxiosError)(err, "Failed to create folder.");
+            return formatAxiosError(err, "Failed to create folder.");
         }
     }
     // Only project was created

package/dist/tools/testmanagement-utils/create-testcase.js

@@ -1,64 +1,56 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateTestCaseSchema = void 0;
-exports.sanitizeArgs = sanitizeArgs;
-exports.createTestCase = createTestCase;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error"); // or correct
-exports.CreateTestCaseSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js"; // or correct
+export const CreateTestCaseSchema = z.object({
+    project_identifier: z
         .string()
         .describe("The ID of the BrowserStack project where the test case should be created. If no project identifier is provided, ask the user if they would like to create a new project using the createProjectOrFolder tool."),
-    folder_id: zod_1.z
+    folder_id: z
         .string()
         .describe("The ID of the folder within the project where the test case should be created. If not provided, ask the user if they would like to create a new folder using the createProjectOrFolder tool."),
-    name: zod_1.z.string().describe("Name of the test case."),
-    description: zod_1.z
+    name: z.string().describe("Name of the test case."),
+    description: z
         .string()
         .optional()
         .describe("Brief description of the test case."),
-    owner: zod_1.z
+    owner: z
         .string()
         .email()
         .describe("Email of the test case owner.")
         .optional(),
-    preconditions: zod_1.z
+    preconditions: z
         .string()
         .optional()
         .describe("Any preconditions (HTML allowed)."),
-    test_case_steps: zod_1.z
-        .array(zod_1.z.object({
-        step: zod_1.z.string().describe("Action to perform in this step."),
-        result: zod_1.z.string().describe("Expected result of this step."),
+    test_case_steps: z
+        .array(z.object({
+        step: z.string().describe("Action to perform in this step."),
+        result: z.string().describe("Expected result of this step."),
     }))
         .describe("List of steps and expected results."),
-    issues: zod_1.z
-        .array(zod_1.z.string())
+    issues: z
+        .array(z.string())
         .optional()
         .describe("List of the linked Jira, Asana or Azure issues ID's. This should be strictly in array format not the string of json."),
-    issue_tracker: zod_1.z
+    issue_tracker: z
         .object({
-        name: zod_1.z
+        name: z
             .string()
             .describe("Issue tracker name,  For example, use jira for Jira, azure for Azure DevOps, or asana for Asana."),
-        host: zod_1.z.string().url().describe("Base URL of the issue tracker."),
+        host: z.string().url().describe("Base URL of the issue tracker."),
     })
         .optional(),
-    tags: zod_1.z
-        .array(zod_1.z.string())
+    tags: z
+        .array(z.string())
         .optional()
         .describe("Tags to attach to the test case. This should be strictly in array format not the string of json"),
-    custom_fields: zod_1.z
-        .record(zod_1.z.string(), zod_1.z.string())
+    custom_fields: z
+        .record(z.string(), z.string())
         .optional()
         .describe("Map of custom field names to values."),
 });
-function sanitizeArgs(args) {
+export function sanitizeArgs(args) {
     const cleaned = { ...args };
     if (cleaned.description === null)
         delete cleaned.description;
@@ -74,13 +66,13 @@ function sanitizeArgs(args) {
     }
     return cleaned;
 }
-async function createTestCase(params) {
+export async function createTestCase(params) {
     const body = { test_case: params };
     try {
-        const response = await axios_1.default.post(`https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(params.project_identifier)}/folders/${encodeURIComponent(params.folder_id)}/test-cases`, body, {
+        const response = await axios.post(`https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(params.project_identifier)}/folders/${encodeURIComponent(params.folder_id)}/test-cases`, body, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
             headers: { "Content-Type": "application/json" },
         });
@@ -110,6 +102,6 @@ async function createTestCase(params) {
     }
     catch (err) {
         // Delegate to our centralized Axios error formatter
-        return (0, error_1.formatAxiosError)(err, "Failed to create test case");
+        return formatAxiosError(err, "Failed to create test case");
     }
 }

package/dist/tools/testmanagement-utils/create-testrun.js

@@ -1,28 +1,21 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateTestRunSchema = void 0;
-exports.createTestRun = createTestRun;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for creating a test run.
  */
-exports.CreateTestRunSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const CreateTestRunSchema = z.object({
+    project_identifier: z
         .string()
         .describe("Identifier of the project in which to create the test run."),
-    test_run: zod_1.z.object({
-        name: zod_1.z.string().describe("Name of the test run"),
-        description: zod_1.z
+    test_run: z.object({
+        name: z.string().describe("Name of the test run"),
+        description: z
             .string()
             .optional()
             .describe("Brief information about the test run"),
-        run_state: zod_1.z
+        run_state: z
             .enum([
             "new_run",
             "in_progress",
@@ -33,17 +26,17 @@ exports.CreateTestRunSchema = zod_1.z.object({
         ])
             .optional()
             .describe("State of the test run. One of new_run, in_progress, under_review, rejected, done, closed"),
-        issues: zod_1.z.array(zod_1.z.string()).optional().describe("Linked issue IDs"),
-        issue_tracker: zod_1.z
-            .object({ name: zod_1.z.string(), host: zod_1.z.string().url() })
+        issues: z.array(z.string()).optional().describe("Linked issue IDs"),
+        issue_tracker: z
+            .object({ name: z.string(), host: z.string().url() })
             .optional()
             .describe("Issue tracker configuration"),
-        test_cases: zod_1.z
-            .array(zod_1.z.string())
+        test_cases: z
+            .array(z.string())
             .optional()
             .describe("List of test case IDs"),
-        folder_ids: zod_1.z
-            .array(zod_1.z.number())
+        folder_ids: z
+            .array(z.number())
             .optional()
             .describe("Folder IDs to include"),
     }),
@@ -51,7 +44,7 @@ exports.CreateTestRunSchema = zod_1.z.object({
 /**
  * Creates a test run via BrowserStack Test Management API.
  */
-async function createTestRun(rawArgs) {
+export async function createTestRun(rawArgs) {
     try {
         const inputArgs = {
             ...rawArgs,
@@ -60,12 +53,12 @@ async function createTestRun(rawArgs) {
                 include_all: false,
             },
         };
-        const args = exports.CreateTestRunSchema.parse(inputArgs);
+        const args = CreateTestRunSchema.parse(inputArgs);
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs`;
-        const response = await axios_1.default.post(url, { test_run: args.test_run }, {
+        const response = await axios.post(url, { test_run: args.test_run }, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
             headers: { "Content-Type": "application/json" },
         });
@@ -85,6 +78,6 @@ async function createTestRun(rawArgs) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to create test run");
+        return formatAxiosError(err, "Failed to create test run");
     }
 }

package/dist/tools/testmanagement-utils/list-testcases.js

@@ -1,39 +1,32 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListTestCasesSchema = void 0;
-exports.listTestCases = listTestCases;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for listing test cases with optional filters.
  */
-exports.ListTestCasesSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const ListTestCasesSchema = z.object({
+    project_identifier: z
         .string()
-        .describe("Identifier of the project to fetch test cases from.  Example: PR-12345"),
-    folder_id: zod_1.z
+        .describe("Identifier of the project to fetch test cases from. This id starts with a PR- and is followed by a number."),
+    folder_id: z
         .string()
         .optional()
         .describe("If provided, only return cases in this folder."),
-    case_type: zod_1.z
+    case_type: z
         .string()
         .optional()
         .describe("Comma-separated list of case types (e.g. functional,regression)."),
-    priority: zod_1.z
+    priority: z
         .string()
         .optional()
         .describe("Comma-separated list of priorities (e.g. critical,medium,low)."),
-    p: zod_1.z.number().optional().describe("Page number."),
+    p: z.number().optional().describe("Page number."),
 });
 /**
  * Calls BrowserStack Test Management to list test cases with filters.
  */
-async function listTestCases(args) {
+export async function listTestCases(args) {
     try {
         // Build query string
         const params = new URLSearchParams();
@@ -46,10 +39,10 @@ async function listTestCases(args) {
         if (args.p !== undefined)
             params.append("p", args.p.toString());
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-cases?${params.toString()}`;
-        const resp = await axios_1.default.get(url, {
+        const resp = await axios.get(url, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
         });
         const resp_data = resp.data;
@@ -85,6 +78,6 @@ async function listTestCases(args) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to list test cases");
+        return formatAxiosError(err, "Failed to list test cases");
     }
 }

package/dist/tools/testmanagement-utils/list-testruns.js

@@ -1,22 +1,15 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListTestRunsSchema = void 0;
-exports.listTestRuns = listTestRuns;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for listing test runs with optional filters.
  */
-exports.ListTestRunsSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const ListTestRunsSchema = z.object({
+    project_identifier: z
         .string()
-        .describe("Identifier of the project to fetch test runs from (e.g., PR-12345)"),
-    run_state: zod_1.z
+        .describe("Identifier of the project to fetch test runs from (usually starts with PR-)."),
+    run_state: z
         .string()
         .optional()
         .describe("Return all test runs with this state (comma-separated)"),
@@ -24,17 +17,17 @@ exports.ListTestRunsSchema = zod_1.z.object({
 /**
  * Fetches and formats the list of test runs for a project.
  */
-async function listTestRuns(args) {
+export async function listTestRuns(args) {
     try {
         const params = new URLSearchParams();
         if (args.run_state) {
             params.set("run_state", args.run_state);
         }
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs?` + params.toString();
-        const resp = await axios_1.default.get(url, {
+        const resp = await axios.get(url, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
         });
         const data = resp.data;
@@ -63,6 +56,6 @@ async function listTestRuns(args) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to list test runs");
+        return formatAxiosError(err, "Failed to list test runs");
     }
 }

package/dist/tools/testmanagement-utils/testcase-from-file.js

@@ -0,0 +1,42 @@
+import { fetchFormFields, triggerTestCaseGeneration, pollScenariosTestDetails, bulkCreateTestCases, } from "./TCG-utils/api.js";
+import { buildDefaultFieldMaps, findBooleanFieldId, } from "./TCG-utils/helpers.js";
+import { signedUrlMap } from "../../lib/inmemory-store.js";
+import logger from "../../logger.js";
+import { projectIdentifierToId } from "./TCG-utils/api.js";
+export async function createTestCasesFromFile(args, context) {
+    logger.info(`createTestCasesFromFile called with projectId: ${args.projectReferenceId}, folderId: ${args.folderId}`);
+    if (args.projectReferenceId.startsWith("PR-")) {
+        args.projectReferenceId = await projectIdentifierToId(args.projectReferenceId);
+    }
+    const { default_fields, custom_fields } = await fetchFormFields(args.projectReferenceId);
+    const fieldMaps = buildDefaultFieldMaps(default_fields);
+    const booleanFieldId = findBooleanFieldId(custom_fields);
+    const documentObj = signedUrlMap.get(args.documentId);
+    if (!documentObj) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Document with ID ${args.documentId} not found.`,
+                    isError: true,
+                },
+            ],
+            isError: true,
+        };
+    }
+    const documentId = documentObj.fileId;
+    const document = documentObj.downloadUrl;
+    const source = "jira-on-prem";
+    const traceId = await triggerTestCaseGeneration(document, documentId, args.folderId, args.projectReferenceId, source);
+    const scenariosMap = await pollScenariosTestDetails(args, traceId, context, documentId, source);
+    const resultString = await bulkCreateTestCases(scenariosMap, args.projectReferenceId, args.folderId, fieldMaps, booleanFieldId, traceId, context, documentId);
+    signedUrlMap.delete(args.documentId);
+    return {
+        content: [
+            {
+                type: "text",
+                text: resultString,
+            },
+        ],
+    };
+}

package/dist/tools/testmanagement-utils/update-testrun.js

@@ -1,25 +1,18 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateTestRunSchema = void 0;
-exports.updateTestRun = updateTestRun;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("../../config"));
-const zod_1 = require("zod");
-const error_1 = require("../../lib/error");
+import axios from "axios";
+import config from "../../config.js";
+import { z } from "zod";
+import { formatAxiosError } from "../../lib/error.js";
 /**
  * Schema for updating a test run with partial fields.
  */
-exports.UpdateTestRunSchema = zod_1.z.object({
-    project_identifier: zod_1.z
+export const UpdateTestRunSchema = z.object({
+    project_identifier: z
         .string()
-        .describe("Project identifier (e.g., PR-12345)"),
-    test_run_id: zod_1.z.string().describe("Test run identifier (e.g., TR-678)"),
-    test_run: zod_1.z.object({
-        name: zod_1.z.string().optional().describe("New name of the test run"),
-        run_state: zod_1.z
+        .describe("Identifier of the project (Starts with 'PR-')"),
+    test_run_id: z.string().describe("Test run identifier (e.g., TR-678)"),
+    test_run: z.object({
+        name: z.string().optional().describe("New name of the test run"),
+        run_state: z
             .enum([
             "new_run",
             "in_progress",
@@ -35,14 +28,14 @@ exports.UpdateTestRunSchema = zod_1.z.object({
 /**
  * Partially updates an existing test run.
  */
-async function updateTestRun(args) {
+export async function updateTestRun(args) {
     try {
         const body = { test_run: args.test_run };
         const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(args.project_identifier)}/test-runs/${encodeURIComponent(args.test_run_id)}/update`;
-        const resp = await axios_1.default.patch(url, body, {
+        const resp = await axios.patch(url, body, {
             auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
+                username: config.browserstackUsername,
+                password: config.browserstackAccessKey,
             },
         });
         const data = resp.data;
@@ -69,6 +62,6 @@ async function updateTestRun(args) {
         };
     }
     catch (err) {
-        return (0, error_1.formatAxiosError)(err, "Failed to update test run");
+        return formatAxiosError(err, "Failed to update test run");
     }
 }