@browserstack/mcp-server 1.0.14 → 1.1.0

package/dist/tools/testmanagement-utils/upload-file.js

@@ -1,31 +1,38 @@
-import { z } from "zod";
-import axios from "axios";
-import FormData from "form-data";
-import fs from "fs";
-import path from "path";
-import { v4 as uuidv4 } from "uuid";
-import config from "../../config.js";
-import { signedUrlMap } from "../../lib/inmemory-store.js";
-import { projectIdentifierToId } from "./TCG-utils/api.js";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadFileSchema = void 0;
+exports.uploadFile = uploadFile;
+const zod_1 = require("zod");
+const axios_1 = __importDefault(require("axios"));
+const form_data_1 = __importDefault(require("form-data"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const uuid_1 = require("uuid");
+const config_js_1 = __importDefault(require("../../config.js"));
+const inmemory_store_js_1 = require("../../lib/inmemory-store.js");
+const api_js_1 = require("./TCG-utils/api.js");
 /**
  * Schema for the upload file tool
  */
-export const UploadFileSchema = z.object({
-    project_identifier: z
+exports.UploadFileSchema = zod_1.z.object({
+    project_identifier: zod_1.z
         .string()
         .describe("ID of the project where the file should be uploaded. Do not assume it, always ask user for it."),
-    file_path: z
+    file_path: zod_1.z
         .string()
         .describe("Full path to the file that should be uploaded"),
 });
 /**
  * Uploads a file to BrowserStack Test Management and returns the signed URL.
  */
-export async function uploadFile(args) {
+async function uploadFile(args) {
     const { project_identifier, file_path } = args;
     try {
         // Validate file exists
-        if (!fs.existsSync(file_path)) {
+        if (!fs_1.default.existsSync(file_path)) {
             return {
                 content: [
                     {
@@ -38,14 +45,14 @@ export async function uploadFile(args) {
             };
         }
         // Get the project ID
-        const projectIdResponse = await projectIdentifierToId(project_identifier);
-        const formData = new FormData();
-        formData.append("attachments[]", fs.createReadStream(file_path));
+        const projectIdResponse = await (0, api_js_1.projectIdentifierToId)(project_identifier);
+        const formData = new form_data_1.default();
+        formData.append("attachments[]", fs_1.default.createReadStream(file_path));
         const uploadUrl = `https://test-management.browserstack.com/api/v1/projects/${projectIdResponse}/generic/attachments/ai_uploads`;
-        const response = await axios.post(uploadUrl, formData, {
+        const response = await axios_1.default.post(uploadUrl, formData, {
             headers: {
                 ...formData.getHeaders(),
-                "API-TOKEN": `${config.browserstackUsername}:${config.browserstackAccessKey}`,
+                "API-TOKEN": `${config_js_1.default.browserstackUsername}:${config_js_1.default.browserstackAccessKey}`,
                 accept: "application/json, text/plain, */*",
             },
         });
@@ -54,13 +61,13 @@ export async function uploadFile(args) {
             response.data.generic_attachment) {
             const attachments = response.data.generic_attachment.map((attachment) => {
                 // Generate a unique ID for each attachment
-                const fileId = uuidv4();
+                const fileId = (0, uuid_1.v4)();
                 // Store the download URL in the signedUrlMap
                 const data = {
                     fileId: attachment.id,
                     downloadUrl: attachment.download_url,
                 };
-                signedUrlMap.set(fileId, data);
+                inmemory_store_js_1.signedUrlMap.set(fileId, data);
                 return {
                     name: attachment.name,
                     documentID: fileId,
@@ -73,7 +80,7 @@ export async function uploadFile(args) {
                 content: [
                     {
                         type: "text",
-                        text: `Successfully uploaded ${path.basename(file_path)} to BrowserStack Test Management.`,
+                        text: `Successfully uploaded ${path_1.default.basename(file_path)} to BrowserStack Test Management.`,
                     },
                     {
                         type: "text",

package/dist/tools/testmanagement.js

@@ -1,28 +1,43 @@
-import { trackMCP } from "../lib/instrumentation.js";
-import logger from "../logger.js";
-import { createProjectOrFolder, CreateProjFoldSchema, } from "./testmanagement-utils/create-project-folder.js";
-import { createTestCase as createTestCaseAPI, sanitizeArgs, CreateTestCaseSchema, } from "./testmanagement-utils/create-testcase.js";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProjectOrFolderTool = createProjectOrFolderTool;
+exports.createTestCaseTool = createTestCaseTool;
+exports.listTestCasesTool = listTestCasesTool;
+exports.createTestRunTool = createTestRunTool;
+exports.listTestRunsTool = listTestRunsTool;
+exports.updateTestRunTool = updateTestRunTool;
+exports.addTestResultTool = addTestResultTool;
+exports.uploadProductRequirementFileTool = uploadProductRequirementFileTool;
+exports.createTestCasesFromFileTool = createTestCasesFromFileTool;
+exports.default = addTestManagementTools;
+const instrumentation_js_1 = require("../lib/instrumentation.js");
+const logger_js_1 = __importDefault(require("../logger.js"));
+const create_project_folder_js_1 = require("./testmanagement-utils/create-project-folder.js");
+const create_testcase_js_1 = require("./testmanagement-utils/create-testcase.js");
 let serverInstance;
-import { listTestCases, ListTestCasesSchema, } from "./testmanagement-utils/list-testcases.js";
-import { CreateTestRunSchema, createTestRun, } from "./testmanagement-utils/create-testrun.js";
-import { ListTestRunsSchema, listTestRuns, } from "./testmanagement-utils/list-testruns.js";
-import { UpdateTestRunSchema, updateTestRun, } from "./testmanagement-utils/update-testrun.js";
-import { addTestResult, AddTestResultSchema, } from "./testmanagement-utils/add-test-result.js";
-import { UploadFileSchema, uploadFile, } from "./testmanagement-utils/upload-file.js";
-import { createTestCasesFromFile } from "./testmanagement-utils/testcase-from-file.js";
-import { CreateTestCasesFromFileSchema } from "./testmanagement-utils/TCG-utils/types.js";
+const list_testcases_js_1 = require("./testmanagement-utils/list-testcases.js");
+const create_testrun_js_1 = require("./testmanagement-utils/create-testrun.js");
+const list_testruns_js_1 = require("./testmanagement-utils/list-testruns.js");
+const update_testrun_js_1 = require("./testmanagement-utils/update-testrun.js");
+const add_test_result_js_1 = require("./testmanagement-utils/add-test-result.js");
+const upload_file_js_1 = require("./testmanagement-utils/upload-file.js");
+const testcase_from_file_js_1 = require("./testmanagement-utils/testcase-from-file.js");
+const types_js_1 = require("./testmanagement-utils/TCG-utils/types.js");
 //TODO: Moving the traceMCP and catch block to the parent(server) function
 /**
  * Wrapper to call createProjectOrFolder util.
  */
-export async function createProjectOrFolderTool(args) {
+async function createProjectOrFolderTool(args) {
     try {
-        trackMCP("createProjectOrFolder", serverInstance.server.getClientVersion());
-        return await createProjectOrFolder(args);
+        (0, instrumentation_js_1.trackMCP)("createProjectOrFolder", serverInstance.server.getClientVersion());
+        return await (0, create_project_folder_js_1.createProjectOrFolder)(args);
     }
     catch (err) {
-        logger.error("Failed to create project/folder: %s", err);
-        trackMCP("createProjectOrFolder", serverInstance.server.getClientVersion(), err);
+        logger_js_1.default.error("Failed to create project/folder: %s", err);
+        (0, instrumentation_js_1.trackMCP)("createProjectOrFolder", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -38,16 +53,16 @@ export async function createProjectOrFolderTool(args) {
 /**
  * Creates a test case in BrowserStack Test Management.
  */
-export async function createTestCaseTool(args) {
+async function createTestCaseTool(args) {
     // Sanitize input arguments
-    const cleanedArgs = sanitizeArgs(args);
+    const cleanedArgs = (0, create_testcase_js_1.sanitizeArgs)(args);
     try {
-        trackMCP("createTestCase", serverInstance.server.getClientVersion());
-        return await createTestCaseAPI(cleanedArgs);
+        (0, instrumentation_js_1.trackMCP)("createTestCase", serverInstance.server.getClientVersion());
+        return await (0, create_testcase_js_1.createTestCase)(cleanedArgs);
     }
     catch (err) {
-        logger.error("Failed to create test case: %s", err);
-        trackMCP("createTestCase", serverInstance.server.getClientVersion(), err);
+        logger_js_1.default.error("Failed to create test case: %s", err);
+        (0, instrumentation_js_1.trackMCP)("createTestCase", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -63,13 +78,13 @@ export async function createTestCaseTool(args) {
 /**
  * Lists test cases in a project with optional filters (status, priority, custom fields, etc.)
  */
-export async function listTestCasesTool(args) {
+async function listTestCasesTool(args) {
     try {
-        trackMCP("listTestCases", serverInstance.server.getClientVersion());
-        return await listTestCases(args);
+        (0, instrumentation_js_1.trackMCP)("listTestCases", serverInstance.server.getClientVersion());
+        return await (0, list_testcases_js_1.listTestCases)(args);
     }
     catch (err) {
-        trackMCP("listTestCases", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("listTestCases", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -85,13 +100,13 @@ export async function listTestCasesTool(args) {
 /**
  * Creates a test run in BrowserStack Test Management.
  */
-export async function createTestRunTool(args) {
+async function createTestRunTool(args) {
     try {
-        trackMCP("createTestRun", serverInstance.server.getClientVersion());
-        return await createTestRun(args);
+        (0, instrumentation_js_1.trackMCP)("createTestRun", serverInstance.server.getClientVersion());
+        return await (0, create_testrun_js_1.createTestRun)(args);
     }
     catch (err) {
-        trackMCP("createTestRun", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("createTestRun", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -107,13 +122,13 @@ export async function createTestRunTool(args) {
 /**
  * Lists test runs in a project with optional filters (date ranges, assignee, state, etc.)
  */
-export async function listTestRunsTool(args) {
+async function listTestRunsTool(args) {
     try {
-        trackMCP("listTestRuns", serverInstance.server.getClientVersion());
-        return await listTestRuns(args);
+        (0, instrumentation_js_1.trackMCP)("listTestRuns", serverInstance.server.getClientVersion());
+        return await (0, list_testruns_js_1.listTestRuns)(args);
     }
     catch (err) {
-        trackMCP("listTestRuns", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("listTestRuns", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -131,13 +146,13 @@ export async function listTestRunsTool(args) {
  * This function allows for partial updates to an existing test run.
  * It takes the project identifier and test run ID as parameters.
  */
-export async function updateTestRunTool(args) {
+async function updateTestRunTool(args) {
     try {
-        trackMCP("updateTestRun", serverInstance.server.getClientVersion());
-        return await updateTestRun(args);
+        (0, instrumentation_js_1.trackMCP)("updateTestRun", serverInstance.server.getClientVersion());
+        return await (0, update_testrun_js_1.updateTestRun)(args);
     }
     catch (err) {
-        trackMCP("updateTestRun", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("updateTestRun", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -153,13 +168,13 @@ export async function updateTestRunTool(args) {
 /**
  * Adds a test result to a specific test run via BrowserStack Test Management API.
  */
-export async function addTestResultTool(args) {
+async function addTestResultTool(args) {
     try {
-        trackMCP("addTestResult", serverInstance.server.getClientVersion());
-        return await addTestResult(args);
+        (0, instrumentation_js_1.trackMCP)("addTestResult", serverInstance.server.getClientVersion());
+        return await (0, add_test_result_js_1.addTestResult)(args);
     }
     catch (err) {
-        trackMCP("addTestResult", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("addTestResult", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -175,13 +190,13 @@ export async function addTestResultTool(args) {
 /**
  * Uploads files such as PDRs or screenshots to BrowserStack Test Management and get file mapping ID back.
  */
-export async function uploadFileTestManagementTool(args) {
+async function uploadProductRequirementFileTool(args) {
     try {
-        trackMCP("uploadFileTestManagement", serverInstance.server.getClientVersion());
-        return await uploadFile(args);
+        (0, instrumentation_js_1.trackMCP)("uploadProductRequirementFile", serverInstance.server.getClientVersion());
+        return await (0, upload_file_js_1.uploadFile)(args);
     }
     catch (err) {
-        trackMCP("uploadFileTestManagement", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("uploadProductRequirementFile", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -197,13 +212,13 @@ export async function uploadFileTestManagementTool(args) {
 /**
  * Creates test cases from a file in BrowserStack Test Management.
  */
-export async function createTestCasesFromFileTool(args, context) {
+async function createTestCasesFromFileTool(args, context) {
     try {
-        trackMCP("createTestCasesFromFile", serverInstance.server.getClientVersion());
-        return await createTestCasesFromFile(args, context);
+        (0, instrumentation_js_1.trackMCP)("createTestCasesFromFile", serverInstance.server.getClientVersion());
+        return await (0, testcase_from_file_js_1.createTestCasesFromFile)(args, context);
     }
     catch (err) {
-        trackMCP("createTestCasesFromFile", serverInstance.server.getClientVersion(), err);
+        (0, instrumentation_js_1.trackMCP)("createTestCasesFromFile", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -219,15 +234,15 @@ export async function createTestCasesFromFileTool(args, context) {
 /**
  * Registers both project/folder and test-case tools.
  */
-export default function addTestManagementTools(server) {
+function addTestManagementTools(server) {
     serverInstance = server;
-    server.tool("createProjectOrFolder", "Create a project and/or folder in BrowserStack Test Management.", CreateProjFoldSchema.shape, createProjectOrFolderTool);
-    server.tool("createTestCase", "Use this tool to create a test case in BrowserStack Test Management.", CreateTestCaseSchema.shape, createTestCaseTool);
-    server.tool("listTestCases", "List test cases in a project with optional filters (status, priority, custom fields, etc.)", ListTestCasesSchema.shape, listTestCasesTool);
-    server.tool("createTestRun", "Create a test run in BrowserStack Test Management.", CreateTestRunSchema.shape, createTestRunTool);
-    server.tool("listTestRuns", "List test runs in a project with optional filters (date ranges, assignee, state, etc.)", ListTestRunsSchema.shape, listTestRunsTool);
-    server.tool("updateTestRun", "Update a test run in BrowserStack Test Management.", UpdateTestRunSchema.shape, updateTestRunTool);
-    server.tool("addTestResult", "Add a test result to a specific test run via BrowserStack Test Management API.", AddTestResultSchema.shape, addTestResultTool);
-    server.tool("uploadFileTestManagement", "Upload files such as PDRs or PDFs to BrowserStack Test Management and get file mapping ID back. Its Used for generating test cases from file.", UploadFileSchema.shape, uploadFileTestManagementTool);
-    server.tool("createTestCasesFromFile", "Create test cases from a file in BrowserStack Test Management.", CreateTestCasesFromFileSchema.shape, createTestCasesFromFileTool);
+    server.tool("createProjectOrFolder", "Create a project and/or folder in BrowserStack Test Management.", create_project_folder_js_1.CreateProjFoldSchema.shape, createProjectOrFolderTool);
+    server.tool("createTestCase", "Use this tool to create a test case in BrowserStack Test Management.", create_testcase_js_1.CreateTestCaseSchema.shape, createTestCaseTool);
+    server.tool("listTestCases", "List test cases in a project with optional filters (status, priority, custom fields, etc.)", list_testcases_js_1.ListTestCasesSchema.shape, listTestCasesTool);
+    server.tool("createTestRun", "Create a test run in BrowserStack Test Management.", create_testrun_js_1.CreateTestRunSchema.shape, createTestRunTool);
+    server.tool("listTestRuns", "List test runs in a project with optional filters (date ranges, assignee, state, etc.)", list_testruns_js_1.ListTestRunsSchema.shape, listTestRunsTool);
+    server.tool("updateTestRun", "Update a test run in BrowserStack Test Management.", update_testrun_js_1.UpdateTestRunSchema.shape, updateTestRunTool);
+    server.tool("addTestResult", "Add a test result to a specific test run via BrowserStack Test Management API.", add_test_result_js_1.AddTestResultSchema.shape, addTestResultTool);
+    server.tool("uploadProductRequirementFile", "Upload files such as PDRs or PDFs to BrowserStack Test Management and get file mapping ID back. Its Used for generating test cases from file.", upload_file_js_1.UploadFileSchema.shape, uploadProductRequirementFileTool);
+    server.tool("createTestCasesFromFile", "Create test cases from a file in BrowserStack Test Management.", types_js_1.CreateTestCasesFromFileSchema.shape, createTestCasesFromFileTool);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.0.14",
+  "version": "1.1.0",
   "description": "BrowserStack's Official MCP Server",
   "main": "dist/index.js",
   "repository": {
@@ -34,10 +34,11 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.10.1",
+    "@modelcontextprotocol/sdk": "^1.11.4",
     "@types/form-data": "^2.5.2",
     "axios": "^1.8.4",
     "browserstack-local": "^1.5.6",
+    "csv-parse": "^5.6.0",
     "dotenv": "^16.5.0",
     "form-data": "^4.0.2",
     "pino": "^9.6.0",
@@ -49,6 +50,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.25.0",
+    "@types/csv-parse": "^1.1.12",
     "@types/node": "^22.14.1",
     "@types/uuid": "^10.0.0",
     "eslint": "^9.25.0",

package/dist/tools/accessiblity-utils/accessibility.js

@@ -1,74 +0,0 @@
-import axios from "axios";
-import config from "../../config.js";
-import { AxiosError } from "axios";
-export async function startAccessibilityScan(name, urlList) {
-    try {
-        const response = await axios.post("https://api-accessibility.browserstack.com/api/website-scanner/v1/scans", {
-            name,
-            urlList,
-            recurring: false,
-        }, {
-            auth: {
-                username: config.browserstackUsername,
-                password: config.browserstackAccessKey,
-            },
-        });
-        if (!response.data.success) {
-            throw new Error(`Unable to create an accessibility scan: ${response.data.errors?.join(", ")}`);
-        }
-        return response.data;
-    }
-    catch (error) {
-        if (error instanceof AxiosError) {
-            if (error.response?.data?.error) {
-                throw new Error(`Failed to start accessibility scan: ${error.response?.data?.error}`);
-            }
-            else {
-                throw new Error(`Failed to start accessibility scan: ${error.response?.data?.message || error.message}`);
-            }
-        }
-        throw error;
-    }
-}
-export async function pollScanStatus(scanId, scanRunId) {
-    try {
-        const response = await axios.get(`https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/${scanRunId}/status`, {
-            auth: {
-                username: config.browserstackUsername,
-                password: config.browserstackAccessKey,
-            },
-        });
-        if (!response.data.success) {
-            throw new Error(`Failed to get scan status: ${response.data.errors?.join(", ")}`);
-        }
-        return response.data.data?.status || "unknown";
-    }
-    catch (error) {
-        if (error instanceof AxiosError) {
-            throw new Error(`Failed to get scan status: ${error.response?.data?.message || error.message}`);
-        }
-        throw error;
-    }
-}
-export async function waitUntilScanComplete(scanId, scanRunId) {
-    return new Promise((resolve, reject) => {
-        const interval = setInterval(async () => {
-            try {
-                const status = await pollScanStatus(scanId, scanRunId);
-                if (status === "completed") {
-                    clearInterval(interval);
-                    resolve();
-                }
-            }
-            catch (error) {
-                clearInterval(interval);
-                reject(error);
-            }
-        }, 5000); // Poll every 5 seconds
-        // Set a timeout of 5 minutes
-        setTimeout(() => {
-            clearInterval(interval);
-            reject(new Error("Scan timed out after 5 minutes"));
-        }, 5 * 60 * 1000);
-    });
-}