@browserstack/mcp-server 1.0.5 → 1.0.8

package/README.md

@@ -88,7 +88,7 @@ Use the following prompts to run/debug/fix your **automated tests** on BrowserSt
 
 1. **Create a BrowserStack Account**
 
-   - Sign up for [BrowserStack](https://www.browserstack.com/signup) if you don't have an account already.
+   - Sign up for [BrowserStack](https://www.browserstack.com/users/sign_up) if you don't have an account already.
 
    - ℹ️ If you have an open-source project, we'll be able to provide you with a [free plan](https://www.browserstack.com/open-source).
    <div align="center">
@@ -154,6 +154,14 @@ Use the following prompts to run/debug/fix your **automated tests** on BrowserSt
    }
    ```
 
+### Installing via Smithery
+
+To install BrowserStack Test Platform Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@browserstack/mcp-server):
+
+```bash
+npx -y @smithery/cli install @browserstack/mcp-server --client claude
+```
+
 ## 🤝 Recommended MCP Clients
 
 - We recommend using **Github Copilot or Cursor** for automated testing + debugging use cases.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "description": "BrowserStack's Official MCP Server",
   "main": "dist/index.js",
   "repository": {

package/dist/config.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = void 0;
-if (!process.env.BROWSERSTACK_ACCESS_KEY ||
-    !process.env.BROWSERSTACK_USERNAME) {
-    throw new Error("Unable to start MCP server. Please set the BROWSERSTACK_ACCESS_KEY and BROWSERSTACK_USERNAME environment variables. Go to https://www.browserstack.com/accounts/profile/details to access them");
-}
-class Config {
-    browserstackUsername;
-    browserstackAccessKey;
-    constructor(browserstackUsername, browserstackAccessKey) {
-        this.browserstackUsername = browserstackUsername;
-        this.browserstackAccessKey = browserstackAccessKey;
-    }
-}
-exports.Config = Config;
-const config = new Config(process.env.BROWSERSTACK_USERNAME, process.env.BROWSERSTACK_ACCESS_KEY);
-exports.default = config;

package/dist/index.js

@@ -1,41 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
-const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
-const package_json_1 = __importDefault(require("../package.json"));
-require("dotenv/config");
-const logger_1 = __importDefault(require("./logger"));
-const bstack_sdk_1 = __importDefault(require("./tools/bstack-sdk"));
-const applive_1 = __importDefault(require("./tools/applive"));
-const observability_1 = __importDefault(require("./tools/observability"));
-const live_1 = __importDefault(require("./tools/live"));
-const accessibility_1 = __importDefault(require("./tools/accessibility"));
-function registerTools(server) {
-    (0, bstack_sdk_1.default)(server);
-    (0, applive_1.default)(server);
-    (0, live_1.default)(server);
-    (0, observability_1.default)(server);
-    (0, accessibility_1.default)(server);
-}
-// Create an MCP server
-const server = new mcp_js_1.McpServer({
-    name: "BrowserStack MCP Server",
-    version: package_json_1.default.version,
-});
-registerTools(server);
-async function main() {
-    logger_1.default.info("Launching BrowserStack MCP server, version %s", package_json_1.default.version);
-    // Start receiving messages on stdin and sending messages on stdout
-    const transport = new stdio_js_1.StdioServerTransport();
-    await server.connect(transport);
-    logger_1.default.info("MCP server started successfully");
-}
-main().catch(console.error);
-// Ensure logs are flushed before exit
-process.on("exit", () => {
-    logger_1.default.flush();
-});

package/dist/lib/api.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLatestO11YBuildInfo = getLatestO11YBuildInfo;
-const config_1 = __importDefault(require("../config"));
-async function getLatestO11YBuildInfo(buildName, projectName) {
-    const buildsUrl = `https://api-observability.browserstack.com/ext/v1/builds/latest?build_name=${encodeURIComponent(buildName)}&project_name=${encodeURIComponent(projectName)}`;
-    const buildsResponse = await fetch(buildsUrl, {
-        headers: {
-            Authorization: `Basic ${Buffer.from(`${config_1.default.browserstackUsername}:${config_1.default.browserstackAccessKey}`).toString("base64")}`,
-        },
-    });
-    if (!buildsResponse.ok) {
-        if (buildsResponse.statusText === "Unauthorized") {
-            throw new Error(`Failed to fetch builds: ${buildsResponse.statusText}. Please check if the BrowserStack credentials are correctly configured when installing the MCP server.`);
-        }
-        throw new Error(`Failed to fetch builds: ${buildsResponse.statusText}`);
-    }
-    return buildsResponse.json();
-}

package/dist/lib/local.js

@@ -1,109 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.killExistingBrowserStackLocalProcesses = killExistingBrowserStackLocalProcesses;
-exports.ensureLocalBinarySetup = ensureLocalBinarySetup;
-exports.isLocalURL = isLocalURL;
-const logger_1 = __importDefault(require("../logger"));
-const child_process_1 = require("child_process");
-const browserstack_local_1 = require("browserstack-local");
-const config_1 = __importDefault(require("../config"));
-async function isBrowserStackLocalRunning() {
-    // Check if BrowserStackLocal binary is already running
-    try {
-        if (process.platform === "win32") {
-            const result = (0, child_process_1.execSync)('tasklist /FI "IMAGENAME eq BrowserStackLocal.exe"', {
-                encoding: "utf8",
-            });
-            if (result.includes("BrowserStackLocal.exe")) {
-                logger_1.default.info("BrowserStackLocal binary is already running");
-                return true;
-            }
-        }
-        else {
-            const result = (0, child_process_1.execSync)("pgrep -f BrowserStackLocal", {
-                encoding: "utf8",
-                stdio: "pipe",
-            }).toString();
-            if (result) {
-                logger_1.default.info("BrowserStackLocal binary is already running");
-                return true;
-            }
-        }
-        logger_1.default.info("BrowserStackLocal binary is not running");
-        return false;
-    }
-    catch (error) {
-        logger_1.default.info("Error checking BrowserStackLocal status, assuming not running ... " +
-            error);
-        return false;
-    }
-}
-async function killExistingBrowserStackLocalProcesses() {
-    const isRunning = await isBrowserStackLocalRunning();
-    if (!isRunning) {
-        return;
-    }
-    // Check and kill any existing BrowserStackLocal processes before starting new one
-    try {
-        if (process.platform === "win32") {
-            // Check if process exists on Windows
-            const checkResult = (0, child_process_1.execSync)('tasklist /FI "IMAGENAME eq BrowserStackLocal.exe"', { encoding: "utf8" });
-            if (checkResult.includes("BrowserStackLocal.exe")) {
-                (0, child_process_1.execSync)("taskkill /F /IM BrowserStackLocal.exe", { stdio: "ignore" });
-                logger_1.default.info("Successfully killed existing BrowserStackLocal processes");
-            }
-        }
-        else {
-            // Check if process exists on Unix-like systems
-            const checkResult = (0, child_process_1.execSync)("pgrep -f BrowserStackLocal", {
-                encoding: "utf8",
-                stdio: "pipe",
-            }).toString();
-            if (checkResult) {
-                (0, child_process_1.execSync)("pkill -f BrowserStackLocal", { stdio: "ignore" });
-                logger_1.default.info("Successfully killed existing BrowserStackLocal processes");
-            }
-        }
-    }
-    catch (error) {
-        logger_1.default.info(`Error checking/killing BrowserStackLocal processes: ${error}`);
-        // Continue execution as there may not be any processes running
-    }
-}
-async function ensureLocalBinarySetup() {
-    logger_1.default.info("Ensuring local binary setup as it is required for private URLs...");
-    const localBinary = new browserstack_local_1.Local();
-    await killExistingBrowserStackLocalProcesses();
-    return await new Promise((resolve, reject) => {
-        localBinary.start({
-            key: config_1.default.browserstackAccessKey,
-            username: config_1.default.browserstackUsername,
-        }, (error) => {
-            if (error) {
-                logger_1.default.error(`Unable to start BrowserStack Local... please check your credentials and try again. Error: ${error}`);
-                reject(new Error(`Unable to configure local tunnel binary, please check your credentials and try again. Error: ${error}`));
-            }
-            else {
-                logger_1.default.info("Successfully started BrowserStack Local");
-                resolve();
-            }
-        });
-    });
-}
-function isLocalURL(url) {
-    try {
-        const urlObj = new URL(url);
-        const hostname = urlObj.hostname.toLowerCase();
-        return (hostname === "localhost" ||
-            hostname === "127.0.0.1" ||
-            hostname.endsWith(".local") ||
-            hostname.endsWith(".localhost"));
-    }
-    catch (error) {
-        logger_1.default.error(`Error checking if URL is local: ${error}`);
-        return false;
-    }
-}

package/dist/lib/utils.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeUrlParam = sanitizeUrlParam;
-function sanitizeUrlParam(param) {
-    // Remove any characters that could be used for command injection
-    return param.replace(/[;&|`$(){}[\]<>]/g, "");
-}

package/dist/logger.js

@@ -1,40 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const pino_1 = __importDefault(require("pino"));
-let logger;
-if (process.env.NODE_ENV === "development") {
-    logger = (0, pino_1.default)({
-        level: "debug",
-        transport: {
-            targets: [
-                {
-                    level: "debug",
-                    target: "pino-pretty",
-                    options: {
-                        colorize: true,
-                        levelFirst: true,
-                        destination: process.platform === "win32"
-                            ? "C:\\Windows\\Temp\\browserstack-mcp-server.log"
-                            : "/tmp/browserstack-mcp-server.log",
-                    },
-                },
-            ],
-        },
-    });
-}
-else {
-    // NULL logger
-    logger = (0, pino_1.default)({
-        level: "info",
-        transport: {
-            target: "pino/file",
-            options: {
-                destination: process.platform === "win32" ? "NUL" : "/dev/null",
-            },
-        },
-    });
-}
-exports.default = logger;

package/dist/tools/accessibility.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = addAccessibilityTools;
-const zod_1 = require("zod");
-const accessibility_1 = require("./accessiblity-utils/accessibility");
-async function runAccessibilityScan(name, pageURL) {
-    try {
-        const response = await (0, accessibility_1.startAccessibilityScan)(name, [pageURL]);
-        const scanId = response.data?.id;
-        const scanRunId = response.data?.scanRunId;
-        if (!scanId || !scanRunId) {
-            throw new Error("Unable to start a accessibility scan, please try again later or open an issue on GitHub if the problem persists");
-        }
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: `Successfully queued accessibility scan, you will get a report via email within 5 minutes.`,
-                },
-            ],
-        };
-    }
-    catch (error) {
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: `Failed to start accessibility scan: ${error instanceof Error ? error.message : "Unknown error"}. Please open an issue on GitHub if the problem persists`,
-                    isError: true,
-                },
-            ],
-            isError: true,
-        };
-    }
-}
-function addAccessibilityTools(server) {
-    server.tool("startAccessibilityScan", "Use this tool to start an accessibility scan for a list of URLs on BrowserStack.", {
-        name: zod_1.z.string().describe("Name of the accessibility scan"),
-        pageURL: zod_1.z.string().describe("The URL to scan for accessibility issues"),
-    }, async (args) => {
-        return runAccessibilityScan(args.name, args.pageURL);
-    });
-}

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

@@ -1,82 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startAccessibilityScan = startAccessibilityScan;
-exports.pollScanStatus = pollScanStatus;
-exports.waitUntilScanComplete = waitUntilScanComplete;
-const axios_1 = __importDefault(require("axios"));
-const config_js_1 = __importDefault(require("../../config.js"));
-const axios_2 = require("axios");
-async function startAccessibilityScan(name, urlList) {
-    try {
-        const response = await axios_1.default.post("https://api-accessibility.browserstack.com/api/website-scanner/v1/scans", {
-            name,
-            urlList,
-            recurring: false,
-        }, {
-            auth: {
-                username: config_js_1.default.browserstackUsername,
-                password: config_js_1.default.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 axios_2.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;
-    }
-}
-async function pollScanStatus(scanId, scanRunId) {
-    try {
-        const response = await axios_1.default.get(`https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/${scanRunId}/status`, {
-            auth: {
-                username: config_js_1.default.browserstackUsername,
-                password: config_js_1.default.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 axios_2.AxiosError) {
-            throw new Error(`Failed to get scan status: ${error.response?.data?.message || error.message}`);
-        }
-        throw error;
-    }
-}
-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);
-    });
-}

package/dist/tools/applive-utils/constants.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUPPORTED_LIVE_CONFIGURATIONS = void 0;
-exports.SUPPORTED_LIVE_CONFIGURATIONS = {
-    android: {
-        chrome: {
-            version: "100",
-        },
-        firefox: {
-            version: "100",
-        },
-        safari: {
-            version: "100",
-        },
-        "samsung browser": {
-            version: "100",
-        },
-        "internet-explorer": {
-            version: "100",
-        },
-    },
-    ios: {
-        chrome: {
-            version: "100",
-        },
-        firefox: {
-            version: "100",
-        },
-        edge: {
-            version: "100",
-        },
-        safari: {
-            version: "100",
-        },
-        "samsung browser": {
-            version: "100",
-        },
-        "internet-explorer": {
-            version: "100",
-        },
-    },
-    windows: {
-        chrome: {
-            version: "100",
-        },
-        firefox: {
-            version: "100",
-        },
-        edge: {
-            version: "100",
-        },
-        safari: {
-            version: "100",
-        },
-        "samsung browser": {
-            version: "100",
-        },
-        "internet-explorer": {
-            version: "100",
-        },
-    },
-    macos: {
-        chrome: {
-            version: "100",
-        },
-        firefox: {
-            version: "100",
-        },
-        edge: {
-            version: "100",
-        },
-        safari: {
-            version: "100",
-        },
-        "samsung browser": {
-            version: "100",
-        },
-        "internet-explorer": {
-            version: "100",
-        },
-    },
-};

package/dist/tools/applive-utils/start-session.js

@@ -1,55 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startSession = startSession;
-const child_process_1 = __importDefault(require("child_process"));
-const logger_1 = __importDefault(require("../../logger"));
-const utils_1 = require("../../lib/utils");
-async function startSession(args) {
-    // Sanitize all input parameters
-    const sanitizedArgs = {
-        appUrl: (0, utils_1.sanitizeUrlParam)(args.appUrl),
-        desiredPlatform: (0, utils_1.sanitizeUrlParam)(args.desiredPlatform),
-        desiredPhone: (0, utils_1.sanitizeUrlParam)(args.desiredPhone),
-        desiredPlatformVersion: (0, utils_1.sanitizeUrlParam)(args.desiredPlatformVersion),
-    };
-    // Get app hash ID and format phone name
-    const appHashedId = sanitizedArgs.appUrl.split("bs://").pop();
-    const desiredPhoneWithSpaces = sanitizedArgs.desiredPhone.replace(/\s+/g, "+");
-    // Construct URL with encoded parameters
-    const params = new URLSearchParams({
-        os: sanitizedArgs.desiredPlatform,
-        os_version: sanitizedArgs.desiredPlatformVersion,
-        app_hashed_id: appHashedId || "",
-        scale_to_fit: "true",
-        speed: "1",
-        start: "true",
-    });
-    const launchUrl = `https://app-live.browserstack.com/dashboard#${params.toString()}&device=${desiredPhoneWithSpaces}`;
-    try {
-        // Use platform-specific commands with proper escaping
-        const command = process.platform === "darwin"
-            ? ["open", launchUrl]
-            : process.platform === "win32"
-                ? ["cmd", "/c", "start", launchUrl]
-                : ["xdg-open", launchUrl];
-        // nosemgrep:javascript.lang.security.detect-child-process.detect-child-process
-        const child = child_process_1.default.spawn(command[0], command.slice(1), {
-            stdio: "ignore",
-            detached: true,
-        });
-        // Handle process errors
-        child.on("error", (error) => {
-            logger_1.default.error(`Failed to open browser automatically: ${error}. Please open this URL manually: ${launchUrl}`);
-        });
-        // Unref the child process to allow the parent to exit
-        child.unref();
-        return launchUrl;
-    }
-    catch (error) {
-        logger_1.default.error(`Failed to open browser automatically: ${error}. Please open this URL manually: ${launchUrl}`);
-        return launchUrl;
-    }
-}

package/dist/tools/applive-utils/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/tools/applive-utils/upload-app.js

@@ -1,68 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadApp = uploadApp;
-const axios_1 = __importStar(require("axios"));
-const form_data_1 = __importDefault(require("form-data"));
-const fs_1 = __importDefault(require("fs"));
-const config_1 = __importDefault(require("../../config"));
-async function uploadApp(filePath) {
-    if (!fs_1.default.existsSync(filePath)) {
-        throw new Error(`File not found at path: ${filePath}`);
-    }
-    const formData = new form_data_1.default();
-    formData.append("file", fs_1.default.createReadStream(filePath));
-    try {
-        const response = await axios_1.default.post("https://api-cloud.browserstack.com/app-live/upload", formData, {
-            headers: {
-                ...formData.getHeaders(),
-            },
-            auth: {
-                username: config_1.default.browserstackUsername,
-                password: config_1.default.browserstackAccessKey,
-            },
-        });
-        return response.data;
-    }
-    catch (error) {
-        if (error instanceof axios_1.AxiosError) {
-            throw new Error(`Failed to upload app: ${error.response?.data?.message || error.message}`);
-        }
-        throw error;
-    }
-}

package/dist/tools/applive.js

@@ -1,93 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startAppLiveSession = startAppLiveSession;
-exports.default = addAppLiveTools;
-const zod_1 = require("zod");
-const fs_1 = __importDefault(require("fs"));
-const upload_app_1 = require("./applive-utils/upload-app");
-const start_session_1 = require("./applive-utils/start-session");
-const logger_1 = __importDefault(require("../logger"));
-/**
- * Launches an App Live Session on BrowserStack.
- */
-async function startAppLiveSession(args) {
-    if (!args.desiredPlatform) {
-        throw new Error("You must provide a desiredPlatform.");
-    }
-    if (!args.appPath) {
-        throw new Error("You must provide a appPath.");
-    }
-    if (!args.desiredPhone) {
-        throw new Error("You must provide a desiredPhone.");
-    }
-    if (args.desiredPlatform === "android" && !args.appPath.endsWith(".apk")) {
-        throw new Error("You must provide a valid Android app path.");
-    }
-    if (args.desiredPlatform === "ios" && !args.appPath.endsWith(".ipa")) {
-        throw new Error("You must provide a valid iOS app path.");
-    }
-    // check if the app path exists && is readable
-    try {
-        if (!fs_1.default.existsSync(args.appPath)) {
-            throw new Error("The app path does not exist.");
-        }
-        fs_1.default.accessSync(args.appPath, fs_1.default.constants.R_OK);
-    }
-    catch (error) {
-        logger_1.default.error("The app path does not exist or is not readable: %s", error);
-        throw new Error("The app path does not exist or is not readable.");
-    }
-    const { app_url } = await (0, upload_app_1.uploadApp)(args.appPath);
-    if (!app_url.match("bs://")) {
-        throw new Error("The app path is not a valid BrowserStack app URL.");
-    }
-    const launchUrl = await (0, start_session_1.startSession)({
-        appUrl: app_url,
-        desiredPlatform: args.desiredPlatform,
-        desiredPhone: args.desiredPhone,
-        desiredPlatformVersion: args.desiredPlatformVersion,
-    });
-    return {
-        content: [
-            {
-                type: "text",
-                text: `Successfully started a session. If a browser window did not open automatically, use the following URL to start the session: ${launchUrl}`,
-            },
-        ],
-    };
-}
-function addAppLiveTools(server) {
-    server.tool("runAppLiveSession", "Use this tool when user wants to manually check their app on a particular mobile device using BrowserStack's cloud infrastructure. Can be used to debug crashes, slow performance, etc.", {
-        desiredPhone: zod_1.z
-            .string()
-            .describe("The full name of the device to run the app on. Example: 'iPhone 12 Pro' or 'Samsung Galaxy S20' or 'Google Pixel 6'. Always ask the user for the device they want to use, do not assume it. "),
-        desiredPlatformVersion: zod_1.z
-            .string()
-            .describe("The platform version to run the app on. Example: '12.0' for Android devices or '16.0' for iOS devices"),
-        desiredPlatform: zod_1.z
-            .enum(["android", "ios"])
-            .describe("Which platform to run on, examples: 'android', 'ios'. Set this based on the app path provided."),
-        appPath: zod_1.z
-            .string()
-            .describe("The path to the .ipa or .apk file to install on the device. Always ask the user for the app path, do not assume it."),
-    }, async (args) => {
-        try {
-            return startAppLiveSession(args);
-        }
-        catch (error) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `Failed to start an app live session. Error: ${error}. Please open an issue on GitHub if the problem persists`,
-                        isError: true,
-                    },
-                ],
-                isError: true,
-            };
-        }
-    });
-}

package/dist/tools/bstack-sdk.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bootstrapProjectWithSDK = bootstrapProjectWithSDK;
-exports.default = addSDKTools;
-const zod_1 = require("zod");
-const instructions_1 = require("./sdk-utils/instructions");
-/**
- * BrowserStack SDK hooks into your test framework to seamlessly run tests on BrowserStack.
- * This tool gives instructions to setup a browserstack.yml file in the project root and installs the necessary dependencies.
- */
-async function bootstrapProjectWithSDK({ detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, desiredPlatforms, }) {
-    const instructions = (0, instructions_1.generateBrowserStackYMLInstructions)(desiredPlatforms);
-    const instructionsForProjectConfiguration = (0, instructions_1.getInstructionsForProjectConfiguration)(detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage);
-    return {
-        content: [
-            {
-                type: "text",
-                text: `${instructions}\n\n After creating the browserstack.yml file above, do the following: ${instructionsForProjectConfiguration}`,
-                isError: false,
-            },
-        ],
-    };
-}
-function addSDKTools(server) {
-    server.tool("runTestsOnBrowserStack", "Use this tool to get instructions for running tests on BrowserStack.", {
-        detectedBrowserAutomationFramework: zod_1.z
-            .string()
-            .describe("The automation framework configured in the project. Example: 'playwright', 'selenium'"),
-        detectedTestingFramework: zod_1.z
-            .string()
-            .describe("The testing framework used in the project. Example: 'jest', 'pytest'"),
-        detectedLanguage: zod_1.z
-            .string()
-            .describe("The programming language used in the project. Example: 'nodejs', 'python'"),
-        desiredPlatforms: zod_1.z
-            .array(zod_1.z.enum(["windows", "macos", "android", "ios"]))
-            .describe("The platforms the user wants to test on. Always ask this to the user, do not try to infer this."),
-    }, async (args) => {
-        const detectedBrowserAutomationFramework = args.detectedBrowserAutomationFramework;
-        const detectedTestingFramework = args.detectedTestingFramework;
-        const detectedLanguage = args.detectedLanguage;
-        const desiredPlatforms = args.desiredPlatforms;
-        try {
-            return bootstrapProjectWithSDK({
-                detectedBrowserAutomationFramework,
-                detectedTestingFramework,
-                detectedLanguage,
-                desiredPlatforms,
-            });
-        }
-        catch (error) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `Failed to bootstrap project with BrowserStack SDK. Error: ${error}. Please open an issue on GitHub if the problem persists`,
-                        isError: true,
-                    },
-                ],
-                isError: true,
-            };
-        }
-    });
-}

package/dist/tools/live-utils/start-session.js

@@ -1,58 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startBrowserSession = startBrowserSession;
-const utils_1 = require("../../lib/utils");
-const logger_1 = __importDefault(require("../../logger"));
-const child_process_1 = __importDefault(require("child_process"));
-async function startBrowserSession(args) {
-    // Sanitize all input parameters
-    const sanitizedArgs = {
-        browser: (0, utils_1.sanitizeUrlParam)(args.browser),
-        os: (0, utils_1.sanitizeUrlParam)(args.os),
-        osVersion: (0, utils_1.sanitizeUrlParam)(args.osVersion),
-        url: (0, utils_1.sanitizeUrlParam)(args.url),
-        browserVersion: (0, utils_1.sanitizeUrlParam)(args.browserVersion),
-        isLocal: args.isLocal,
-    };
-    // Construct URL with encoded parameters
-    const params = new URLSearchParams({
-        os: sanitizedArgs.os,
-        os_version: sanitizedArgs.osVersion,
-        browser: sanitizedArgs.browser,
-        browser_version: sanitizedArgs.browserVersion,
-        scale_to_fit: "true",
-        url: sanitizedArgs.url,
-        resolution: "responsive-mode",
-        speed: "1",
-        local: sanitizedArgs.isLocal ? "true" : "false",
-        start: "true",
-    });
-    const launchUrl = `https://live.browserstack.com/dashboard#${params.toString()}`;
-    try {
-        // Use platform-specific commands with proper escaping
-        const command = process.platform === "darwin"
-            ? ["open", launchUrl]
-            : process.platform === "win32"
-                ? ["cmd", "/c", "start", launchUrl]
-                : ["xdg-open", launchUrl];
-        // nosemgrep:javascript.lang.security.detect-child-process.detect-child-process
-        const child = child_process_1.default.spawn(command[0], command.slice(1), {
-            stdio: "ignore",
-            detached: true,
-        });
-        // Handle process errors
-        child.on("error", (error) => {
-            logger_1.default.error(`Failed to open browser automatically: ${error}. Please open this URL manually: ${launchUrl}`);
-        });
-        // Unref the child process to allow the parent to exit
-        child.unref();
-        return launchUrl;
-    }
-    catch (error) {
-        logger_1.default.error(`Failed to open browser automatically: ${error}. Please open this URL manually: ${launchUrl}`);
-        return launchUrl;
-    }
-}

package/dist/tools/live.js

@@ -1,97 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startBrowserLiveSession = startBrowserLiveSession;
-exports.default = addBrowserLiveTools;
-const zod_1 = require("zod");
-const start_session_1 = require("./live-utils/start-session");
-const logger_1 = __importDefault(require("../logger"));
-const local_1 = require("../lib/local");
-/**
- * Launches a Browser Live Session on BrowserStack.
- */
-async function startBrowserLiveSession(args) {
-    if (!args.desiredBrowser) {
-        throw new Error("You must provide a desiredBrowser.");
-    }
-    if (!args.desiredURL) {
-        throw new Error("You must provide a desiredURL.");
-    }
-    if (!args.desiredOS) {
-        throw new Error("You must provide a desiredOS.");
-    }
-    if (!args.desiredOSVersion) {
-        throw new Error("You must provide a desiredOSVersion.");
-    }
-    if (!args.desiredBrowserVersion) {
-        throw new Error("You must provide a desiredBrowserVersion.");
-    }
-    // Validate URL format
-    try {
-        new URL(args.desiredURL);
-    }
-    catch (error) {
-        logger_1.default.error("Invalid URL format: %s", error);
-        throw new Error("The provided URL is invalid.");
-    }
-    const isLocal = (0, local_1.isLocalURL)(args.desiredURL);
-    if (isLocal) {
-        await (0, local_1.ensureLocalBinarySetup)();
-    }
-    else {
-        await (0, local_1.killExistingBrowserStackLocalProcesses)();
-    }
-    const launchUrl = await (0, start_session_1.startBrowserSession)({
-        browser: args.desiredBrowser,
-        os: args.desiredOS,
-        osVersion: args.desiredOSVersion,
-        url: args.desiredURL,
-        browserVersion: args.desiredBrowserVersion,
-        isLocal,
-    });
-    return {
-        content: [
-            {
-                type: "text",
-                text: `Successfully started a browser session. If a browser window did not open automatically, use the following URL to start the session: ${launchUrl}`,
-            },
-        ],
-    };
-}
-function addBrowserLiveTools(server) {
-    server.tool("runBrowserLiveSession", "Use this tool when user wants to manually check their website on a particular browser and OS combination using BrowserStack's cloud infrastructure. Can be used to debug layout issues, compatibility problems, etc.", {
-        desiredBrowser: zod_1.z
-            .enum(["Chrome", "IE", "Firefox", "Safari", "Edge"])
-            .describe("The browser to run the test on. Example: 'Chrome', 'IE', 'Safari', 'Edge'. Always ask the user for the browser they want to use, do not assume it."),
-        desiredOSVersion: zod_1.z
-            .string()
-            .describe("The OS version to run the browser on. Example: '10' for Windows, '12' for macOS, '14' for iOS"),
-        desiredOS: zod_1.z
-            .enum(["Windows", "OS X"])
-            .describe("The operating system to run the browser on. Example: 'Windows', 'OS X'"),
-        desiredURL: zod_1.z
-            .string()
-            .describe("The URL of the website to test. This can be a local URL (e.g., http://localhost:3000) or a public URL. Always ask the user for the URL, do not assume it."),
-        desiredBrowserVersion: zod_1.z
-            .string()
-            .describe("The version of the browser to use. Example: 133.0, 134.0, 87.0"),
-    }, async (args) => {
-        try {
-            return startBrowserLiveSession(args);
-        }
-        catch (error) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `Failed to start a browser live session. Error: ${error}. Please open an issue on GitHub if the problem persists`,
-                        isError: true,
-                    },
-                ],
-                isError: true,
-            };
-        }
-    });
-}

package/dist/tools/observability.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFailuresInLastRun = getFailuresInLastRun;
-exports.default = addObservabilityTools;
-const zod_1 = require("zod");
-const api_1 = require("../lib/api");
-async function getFailuresInLastRun(buildName, projectName) {
-    const buildsData = await (0, api_1.getLatestO11YBuildInfo)(buildName, projectName);
-    const observabilityUrl = buildsData.observability_url;
-    if (!observabilityUrl) {
-        throw new Error("No observability URL found in build data, this is likely because the build is not yet available on BrowserStack Observability.");
-    }
-    let overview = "No overview available";
-    if (buildsData.unique_errors?.overview?.insight) {
-        overview = buildsData.unique_errors.overview.insight;
-    }
-    let details = "No error details available";
-    if (buildsData.unique_errors?.top_unique_errors?.length > 0) {
-        details = buildsData.unique_errors.top_unique_errors
-            .map((error) => error.error)
-            .filter(Boolean)
-            .join("\n");
-    }
-    return {
-        content: [
-            {
-                type: "text",
-                text: `Observability URL: ${observabilityUrl}\nOverview: ${overview}\nError Details: ${details}`,
-            },
-        ],
-    };
-}
-function addObservabilityTools(server) {
-    server.tool("getFailuresInLastRun", "Use this tool to debug failures in the last run of the test suite on BrowserStack. Use only when browserstack.yml file is present in the project root.", {
-        buildName: zod_1.z
-            .string()
-            .describe("Name of the build to get failures for. This is the 'build' key in the browserstack.yml file. If not sure, ask the user for the build name."),
-        projectName: zod_1.z
-            .string()
-            .describe("Name of the project to get failures for. This is the 'projectName' key in the browserstack.yml file. If not sure, ask the user for the project name."),
-    }, async (args) => {
-        try {
-            return getFailuresInLastRun(args.buildName, args.projectName);
-        }
-        catch (error) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `Failed to get failures in the last run. Error: ${error}. Please open an issue on GitHub if this is an issue with BrowserStack`,
-                        isError: true,
-                    },
-                ],
-                isError: true,
-            };
-        }
-    });
-}

package/dist/tools/sdk-utils/constants.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUPPORTED_CONFIGURATIONS = void 0;
-const config_1 = __importDefault(require("../../config"));
-const nodejsInstructions = `
-- Ensure that \`browserstack-node-sdk\` is present in package.json, use the latest version.
-- Add new scripts to package.json for running tests on BrowserStack (use \`npx\` to trigger the sdk):
-  \`\`\`json
-  "scripts": {
-    "test:browserstack": "npx browserstack-node-sdk <framework-specific-test-execution-command>"
-  }
-  \`\`\`
-- Add to dependencies:
-  \`\`\`json
-  "browserstack-node-sdk": "latest"
-  \`\`\`
-`;
-const pythonInstructions = `
-Run the following command to install the browserstack-sdk:
-\`\`\`bash
-python3 -m pip install browserstack-sdk
-\`\`\`
-
-Run the following command to setup the browserstack-sdk:
-\`\`\`bash
-browserstack-sdk setup --username "${config_1.default.browserstackUsername}" --key "${config_1.default.browserstackAccessKey}"
-\`\`\`
-
-In order to run tests on BrowserStack, run the following command:
-\`\`\`bash
-browserstack-sdk python <path-to-test-file>
-\`\`\`
-`;
-exports.SUPPORTED_CONFIGURATIONS = {
-    nodejs: {
-        playwright: {
-            jest: { instructions: nodejsInstructions },
-            codeceptjs: { instructions: nodejsInstructions },
-            playwright: { instructions: nodejsInstructions },
-        },
-        selenium: {
-            jest: { instructions: nodejsInstructions },
-            webdriverio: { instructions: nodejsInstructions },
-            mocha: { instructions: nodejsInstructions },
-            cucumber: { instructions: nodejsInstructions },
-            nightwatch: { instructions: nodejsInstructions },
-            codeceptjs: { instructions: nodejsInstructions },
-        },
-    },
-    python: {
-        playwright: {
-            pytest: { instructions: pythonInstructions },
-        },
-        selenium: {
-            pytest: { instructions: pythonInstructions },
-            robot: { instructions: pythonInstructions },
-            behave: { instructions: pythonInstructions },
-        },
-    },
-};

package/dist/tools/sdk-utils/instructions.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInstructionsForProjectConfiguration = void 0;
-exports.generateBrowserStackYMLInstructions = generateBrowserStackYMLInstructions;
-const constants_1 = require("./constants");
-const errorMessageSuffix = "Please open an issue at our Github repo: https://github.com/browserstack/browserstack-mcp-server/issues to request support for your project configuration";
-const getInstructionsForProjectConfiguration = (detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage) => {
-    const configuration = constants_1.SUPPORTED_CONFIGURATIONS[detectedLanguage];
-    if (!configuration) {
-        throw new Error(`BrowserStack MCP Server currently does not support ${detectedLanguage}, ${errorMessageSuffix}`);
-    }
-    if (!configuration[detectedBrowserAutomationFramework]) {
-        throw new Error(`BrowserStack MCP Server currently does not support ${detectedBrowserAutomationFramework} for ${detectedLanguage}, ${errorMessageSuffix}`);
-    }
-    if (!configuration[detectedBrowserAutomationFramework][detectedTestingFramework]) {
-        throw new Error(`BrowserStack MCP Server currently does not support ${detectedTestingFramework} for ${detectedBrowserAutomationFramework} on ${detectedLanguage}, ${errorMessageSuffix}`);
-    }
-    return configuration[detectedBrowserAutomationFramework][detectedTestingFramework].instructions;
-};
-exports.getInstructionsForProjectConfiguration = getInstructionsForProjectConfiguration;
-function generateBrowserStackYMLInstructions(desiredPlatforms) {
-    return `
-      Create a browserstack.yml file in the project root. The file should be in the following format:
-
-      \`\`\`yaml
-# ======================
-# BrowserStack Reporting
-# ======================
-projectName: BrowserStack MCP Runs
-build: mcp-run
-
-# =======================================
-# Platforms (Browsers / Devices to test)
-# =======================================
-# Platforms object contains all the browser / device combinations you want to test on.
-# Generate this on the basis of the following platforms requested by the user:
-# Requested platforms: ${desiredPlatforms}
-platforms:
-  - os: Windows
-    osVersion: 11
-    browserName: chrome
-    browserVersion: latest
-  
-# =======================
-# Parallels per Platform
-# =======================
-# The number of parallel threads to be used for each platform set.
-# BrowserStack's SDK runner will select the best strategy based on the configured value
-#
-# Example 1 - If you have configured 3 platforms and set \`parallelsPerPlatform\` as 2, a total of 6 (2 * 3) parallel threads will be used on BrowserStack
-#
-# Example 2 - If you have configured 1 platform and set \`parallelsPerPlatform\` as 5, a total of 5 (1 * 5) parallel threads will be used on BrowserStack
-parallelsPerPlatform: 1
-
-browserstackLocal: true
-
-# ===================
-# Debugging features
-# ===================
-debug: true
-testObservability: true
-      \`\`\`
-      \n`;
-}

package/dist/tools/sdk-utils/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });