@browserstack/mcp-server 1.2.2-beta.1 → 1.2.3-beta.1

package/dist/tools/percy-snapshot-utils/types.d.ts

@@ -1,15 +0,0 @@
-import { SDKSupportedTestingFrameworkEnum, SDKSupportedLanguageEnum } from "../sdk-utils/common/types.js";
-export type ListTestFilesParams = {
-    dirs: string[];
-    language: SDKSupportedLanguageEnum;
-    framework?: SDKSupportedTestingFrameworkEnum;
-};
-export interface DetectionConfig {
-    extensions: string[];
-    namePatterns: RegExp[];
-    contentRegex: RegExp[];
-    uiDriverRegex: RegExp[];
-    uiIndicatorRegex: RegExp[];
-    backendRegex: RegExp[];
-    excludeRegex?: RegExp[];
-}

package/dist/tools/percy-snapshot-utils/utils.d.ts

@@ -1,4 +0,0 @@
-export declare function updateFileAndStep(file: string, idx: number, total: number, instruction: string): Promise<{
-    type: "text";
-    text: string;
-}[]>;

package/dist/tools/percy-snapshot-utils/utils.js

@@ -1,30 +0,0 @@
-const content = [];
-export async function updateFileAndStep(file, idx, total, instruction) {
-    content.length = 0;
-    const nextIndex = idx + 1;
-    content.push({
-        type: "text",
-        text: `Complete all steps in order. If a tool call is requested, update the file first, then call the tool. Follow instructions exactly— do not skip any steps to ensure all files are updated.`,
-    });
-    content.push({
-        type: "text",
-        text: `Step 1 : You need to add percy snapshot commands in some key test cases in the file ${file} use the following instructions: \n${instruction}`,
-    });
-    content.push({
-        type: "text",
-        text: `Step 2 : Confirm that Percy snapshot commands have been added at all key points of visual change in the file ${file}.`,
-    });
-    if (nextIndex < total) {
-        content.push({
-            type: "text",
-            text: `Step 3 : Call the tool updateTestFileWithInstructions with index as ${nextIndex} out of ${total}`,
-        });
-    }
-    if (nextIndex === total) {
-        content.push({
-            type: "text",
-            text: `Step 4: Percy snapshot commands have been added to all files. You can now run the Percy build using the above command.`,
-        });
-    }
-    return content;
-}

package/dist/tools/sdk-utils/bstack/commands.js

@@ -1,88 +0,0 @@
-// Constants
-const MAVEN_ARCHETYPE_GROUP_ID = "com.browserstack";
-const MAVEN_ARCHETYPE_ARTIFACT_ID = "browserstack-sdk-archetype-integrate";
-const MAVEN_ARCHETYPE_VERSION = "1.0";
-// Mapping of test frameworks to their corresponding Maven archetype framework names
-const JAVA_FRAMEWORK_MAP = {
-    testng: "testng",
-    junit5: "junit5",
-    junit4: "junit4",
-    cucumber: "cucumber-testng",
-};
-// Template for Node.js SDK setup instructions
-const NODEJS_SDK_INSTRUCTIONS = (username, accessKey) => `---STEP---
-Install BrowserStack Node SDK using command:
-\`\`\`bash
-npm i -D browserstack-node-sdk@latest
-\`\`\`
----STEP---
-Run the following command to setup browserstack sdk:
-\`\`\`bash
-npx setup --username ${username} --key ${accessKey}
-\`\`\``;
-// Template for Gradle setup instructions (platform-independent)
-const GRADLE_SETUP_INSTRUCTIONS = `
-**For Gradle setup:**
-1. Add browserstack-java-sdk to dependencies:
-   compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'
-
-2. Add browserstackSDK path variable:
-   def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
-
-3. Add javaagent to gradle tasks:
-   jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
-`;
-// Generates Maven archetype command for Windows platform
-function getMavenCommandForWindows(framework, mavenFramework) {
-    return (`mvn archetype:generate -B ` +
-        `-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
-        `-DarchetypeArtifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
-        `-DarchetypeVersion="${MAVEN_ARCHETYPE_VERSION}" ` +
-        `-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
-        `-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
-        `-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
-        `-DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" ` +
-        `-DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" ` +
-        `-DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`);
-}
-// Generates Maven archetype command for Unix-like platforms (macOS/Linux)
-function getMavenCommandForUnix(username, accessKey, mavenFramework) {
-    return `mvn archetype:generate -B -DarchetypeGroupId=${MAVEN_ARCHETYPE_GROUP_ID} \\
--DarchetypeArtifactId=${MAVEN_ARCHETYPE_ARTIFACT_ID} -DarchetypeVersion=${MAVEN_ARCHETYPE_VERSION} \\
--DgroupId=${MAVEN_ARCHETYPE_GROUP_ID} -DartifactId=${MAVEN_ARCHETYPE_ARTIFACT_ID} -Dversion=${MAVEN_ARCHETYPE_VERSION} \\
--DBROWSERSTACK_USERNAME="${username}" \\
--DBROWSERSTACK_ACCESS_KEY="${accessKey}" \\
--DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`;
-}
-// Generates Java SDK setup instructions with Maven/Gradle options
-function getJavaSDKInstructions(framework, username, accessKey) {
-    const mavenFramework = getJavaFrameworkForMaven(framework);
-    const isWindows = process.platform === "win32";
-    const platformLabel = isWindows ? "Windows" : "macOS/Linux";
-    const mavenCommand = isWindows
-        ? getMavenCommandForWindows(framework, mavenFramework)
-        : getMavenCommandForUnix(username, accessKey, mavenFramework);
-    return `---STEP---
-Install BrowserStack Java SDK
-
-**Maven command for ${framework} (${platformLabel}):**
-Run the command, it is required to generate the browserstack-sdk-archetype-integrate project:
-${mavenCommand}
-
-Alternative setup for Gradle users:
-${GRADLE_SETUP_INSTRUCTIONS}`;
-}
-// Main function to get SDK setup commands based on language and framework
-export function getSDKPrefixCommand(language, framework, username, accessKey) {
-    switch (language) {
-        case "nodejs":
-            return NODEJS_SDK_INSTRUCTIONS(username, accessKey);
-        case "java":
-            return getJavaSDKInstructions(framework, username, accessKey);
-        default:
-            return "";
-    }
-}
-export function getJavaFrameworkForMaven(framework) {
-    return JAVA_FRAMEWORK_MAP[framework] || framework;
-}

package/dist/tools/sdk-utils/bstack/configUtils.d.ts

@@ -1,4 +0,0 @@
-/**
- * Utilities for generating BrowserStack configuration files.
- */
-export declare function generateBrowserStackYMLInstructions(desiredPlatforms: string[], enablePercy: boolean | undefined, projectName: string): string;

package/dist/tools/sdk-utils/bstack/configUtils.js

@@ -1,66 +0,0 @@
-/**
- * Utilities for generating BrowserStack configuration files.
- */
-export function generateBrowserStackYMLInstructions(desiredPlatforms, enablePercy = false, projectName) {
-    let ymlContent = `
-# ======================
-# BrowserStack Reporting
-# ======================
-# A single name for your project to organize all your tests. This is required for Percy.
-projectName: ${projectName}
-# TODO: Replace these sample values with your actual project details
-buildName: Sample-Build
-
-# =======================================
-# 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
-
-# =================
-# Local Testing
-# =================
-# Set to true to test local
-browserstackLocal: true
-
-# ===================
-# Debugging features
-# ===================
-debug: true # Visual logs, text logs, etc.
-testObservability: true # For Test Observability`;
-    if (enablePercy) {
-        ymlContent += `
-
-# =====================
-# Percy Visual Testing
-# =====================
-# Set percy to true to enable visual testing.
-# Set percyCaptureMode to 'manual' to control when screenshots are taken.
-percy: true
-percyCaptureMode: manual`;
-    }
-    return `
----STEP---
-Create a browserstack.yml file in the project root. The file should be in the following format:
-
-\`\`\`yaml${ymlContent}
-\`\`\`
-\n`;
-}

package/dist/tools/sdk-utils/bstack/constants.d.ts

@@ -1,58 +0,0 @@
-import { ConfigMapping } from "../common/types.js";
-/**
- * ---------- PYTHON INSTRUCTIONS ----------
- */
-export declare const pythonInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const generatePythonFrameworkInstructions: (framework: string) => (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const robotInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const behaveInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const pytestInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const javaInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-/**
- * ---------- CSharp INSTRUCTIONS ----------
- */
-export declare const csharpCommonInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const csharpPlaywrightCommonInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-/**
- * ---------- NODEJS INSTRUCTIONS ----------
- */
-export declare const nodejsInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-/**
- * ---------- EXPORT CONFIG ----------
- */
-export declare const webdriverioInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const cypressInstructions: (username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};
-export declare const SUPPORTED_CONFIGURATIONS: ConfigMapping;

package/dist/tools/sdk-utils/bstack/frameworks.js

@@ -1,57 +0,0 @@
-import * as constants from "./constants.js";
-export const SUPPORTED_CONFIGURATIONS = {
-    python: {
-        playwright: {
-            pytest: { instructions: constants.pythonInstructions },
-        },
-        selenium: {
-            pytest: { instructions: constants.pytestInstructions },
-            robot: { instructions: constants.robotInstructions },
-            behave: { instructions: constants.behaveInstructions },
-        },
-    },
-    java: {
-        playwright: {
-            junit4: { instructions: constants.javaInstructions },
-            junit5: { instructions: constants.javaInstructions },
-            testng: { instructions: constants.javaInstructions },
-        },
-        selenium: {
-            testng: { instructions: constants.javaInstructions },
-            cucumber: { instructions: constants.javaInstructions },
-            junit4: { instructions: constants.javaInstructions },
-            junit5: { instructions: constants.javaInstructions },
-        },
-    },
-    csharp: {
-        playwright: {
-            nunit: { instructions: constants.csharpPlaywrightCommonInstructions },
-            mstest: { instructions: constants.csharpPlaywrightCommonInstructions },
-        },
-        selenium: {
-            xunit: { instructions: constants.csharpCommonInstructions },
-            nunit: { instructions: constants.csharpCommonInstructions },
-            mstest: { instructions: constants.csharpCommonInstructions },
-            specflow: { instructions: constants.csharpCommonInstructions },
-            reqnroll: { instructions: constants.csharpCommonInstructions },
-        },
-    },
-    nodejs: {
-        playwright: {
-            jest: { instructions: constants.nodejsInstructions },
-            codeceptjs: { instructions: constants.nodejsInstructions },
-            playwright: { instructions: constants.nodejsInstructions },
-        },
-        selenium: {
-            jest: { instructions: constants.nodejsInstructions },
-            webdriverio: { instructions: constants.webdriverioInstructions },
-            mocha: { instructions: constants.nodejsInstructions },
-            cucumber: { instructions: constants.nodejsInstructions },
-            nightwatch: { instructions: constants.nodejsInstructions },
-            codeceptjs: { instructions: constants.nodejsInstructions },
-        },
-        cypress: {
-            cypress: { instructions: constants.cypressInstructions },
-        },
-    },
-};

package/dist/tools/sdk-utils/bstack/index.d.ts

@@ -1,4 +0,0 @@
-export { runBstackSDKOnly } from "./sdkHandler.js";
-export { getSDKPrefixCommand, getJavaFrameworkForMaven } from "./commands.js";
-export { generateBrowserStackYMLInstructions } from "./configUtils.js";
-export { SUPPORTED_CONFIGURATIONS } from "./frameworks.js";

package/dist/tools/sdk-utils/bstack/index.js

@@ -1,5 +0,0 @@
-// BrowserStack SDK utilities
-export { runBstackSDKOnly } from "./sdkHandler.js";
-export { getSDKPrefixCommand, getJavaFrameworkForMaven } from "./commands.js";
-export { generateBrowserStackYMLInstructions } from "./configUtils.js";
-export { SUPPORTED_CONFIGURATIONS } from "./frameworks.js";

package/dist/tools/sdk-utils/bstack/sdkHandler.d.ts

@@ -1,4 +0,0 @@
-import { RunTestsInstructionResult } from "../common/types.js";
-import { RunTestsOnBrowserStackInput } from "../common/schema.js";
-import { BrowserStackConfig } from "../../../lib/types.js";
-export declare function runBstackSDKOnly(input: RunTestsOnBrowserStackInput, config: BrowserStackConfig, isPercyAutomate?: boolean): RunTestsInstructionResult;

package/dist/tools/sdk-utils/bstack/sdkHandler.js

@@ -1,74 +0,0 @@
-import { getBrowserStackAuth } from "../../../lib/get-auth.js";
-import { getSDKPrefixCommand } from "./commands.js";
-import { generateBrowserStackYMLInstructions } from "./configUtils.js";
-import { getInstructionsForProjectConfiguration } from "../common/instructionUtils.js";
-export function runBstackSDKOnly(input, config, isPercyAutomate = false) {
-    const steps = [];
-    const authString = getBrowserStackAuth(config);
-    const [username, accessKey] = authString.split(":");
-    // Handle frameworks with unique setup instructions that don't use browserstack.yml
-    if (input.detectedBrowserAutomationFramework === "cypress" ||
-        input.detectedTestingFramework === "webdriverio") {
-        const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage, username, accessKey);
-        if (frameworkInstructions) {
-            if (frameworkInstructions.setup) {
-                steps.push({
-                    type: "instruction",
-                    title: "Framework-Specific Setup",
-                    content: frameworkInstructions.setup,
-                });
-            }
-            if (frameworkInstructions.run && !isPercyAutomate) {
-                steps.push({
-                    type: "instruction",
-                    title: "Run the tests",
-                    content: frameworkInstructions.run,
-                });
-            }
-        }
-        return {
-            steps,
-            requiresPercy: false,
-            missingDependencies: [],
-        };
-    }
-    // Default flow using browserstack.yml
-    const sdkSetupCommand = getSDKPrefixCommand(input.detectedLanguage, input.detectedTestingFramework, username, accessKey);
-    if (sdkSetupCommand) {
-        steps.push({
-            type: "instruction",
-            title: "Install BrowserStack SDK",
-            content: sdkSetupCommand,
-        });
-    }
-    const ymlInstructions = generateBrowserStackYMLInstructions(input.desiredPlatforms, false, input.projectName);
-    if (ymlInstructions) {
-        steps.push({
-            type: "instruction",
-            title: "Configure browserstack.yml",
-            content: ymlInstructions,
-        });
-    }
-    const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage, username, accessKey);
-    if (frameworkInstructions) {
-        if (frameworkInstructions.setup) {
-            steps.push({
-                type: "instruction",
-                title: "Framework-Specific Setup",
-                content: frameworkInstructions.setup,
-            });
-        }
-        if (frameworkInstructions.run && !isPercyAutomate) {
-            steps.push({
-                type: "instruction",
-                title: "Run the tests",
-                content: frameworkInstructions.run,
-            });
-        }
-    }
-    return {
-        steps,
-        requiresPercy: false,
-        missingDependencies: [],
-    };
-}

package/dist/tools/sdk-utils/common/constants.d.ts

@@ -1,10 +0,0 @@
-export declare const IMPORTANT_SETUP_WARNING = "IMPORTANT: DO NOT SKIP ANY STEP. All the setup steps described below MUST be executed regardless of any existing configuration or setup. This ensures proper BrowserStack SDK setup.";
-export declare const SETUP_PERCY_DESCRIPTION = "Set up Percy visual testing for your project. This supports both Percy Web Standalone and Percy Automate.";
-export declare const LIST_TEST_FILES_DESCRIPTION = "Lists all test files for a given set of directories.";
-export declare const PERCY_SNAPSHOT_COMMANDS_DESCRIPTION = "Adds Percy snapshot commands to the specified test files.";
-export declare const RUN_ON_BROWSERSTACK_DESCRIPTION = "Set up and run automated web-based tests on BrowserStack using the BrowserStack SDK. Use this tool for functional or integration test setup on BrowserStack only. For any visual testing or Percy integration, use the dedicated Percy setup tool. Example prompts: run this test on browserstack; set up this project for browserstack.";
-export declare const SIMULATE_PERCY_CHANGE_DESCRIPTION = "This tool helps new users simulate a Percy visual change by guiding them to make a visible UI modification, rerun Percy, and verify that the change is detected. Only Percy web is supported";
-export declare const PERCY_REPLACE_REGEX: RegExp;
-export declare const PERCY_SNAPSHOT_INSTRUCTION = "\nInvoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---\nProcess files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:\n- Start with index 0\n- Then index 1  \n- Then index 2\n- Continue sequentially until the last index\n- DO NOT skip any index numbers\n- DO NOT jump to random indices like 10, 20, 30\n- DO NOT worry about time consuming and any constraints.\n- DO NOT STOP until you add commands in all the files or you reach end of the files.\n";
-export declare const PERCY_SIMULATE_INSTRUCTION = "\nMANDATORY: Aggressive, Accurate Percy Snapshots Integration\n\nPrerequisite: Before making any code changes in the user's repo, switch to a branch named temp-percy (run git init first if the repo is not yet initialized).\n\nYou MUST follow these steps with NO EXCEPTIONS:\n1. Identify 4-5 key test files in the project that are critical for visual testing.\n2. For EACH identified test file, analyze the code to find EVERY location where a Percy snapshot should be called (e.g., after each navigation, UI change, or significant state in tests).\n3. Insert snapshot calls at ALL such points, not just the first or most obvious one.\n\nIteratively update every selected test file with percy snapshot calls at all identified points, ensuring comprehensive coverage of visual changes.";
-export declare const PERCY_SIMULATION_DRIVER_INSTRUCTION = "\nMANDATORY: Step-by-Step Percy Visual Change Simulation\nYou MUST follow these steps with NO EXCEPTIONS:\n\nSTEP 1: At this case we have added Percy snapshot commands to the test files at the appropriate locations (e.g., after navigation, UI change, or significant state). \n- Use ONLY existing snapshot names.\n- Do NOT add any popup injection or visual changes yet.\n- Do NOT run any Percy builds at this stage.\n\nSTEP 2: Run ONE comprehensive baseline Percy build that executes ALL tests containing Percy snapshots in a SINGLE build. This creates one baseline build with all snapshots for comparison. Use a command like: npx percy exec -- python -m pytest tests/ -k 'test_name1 or test_name2 or test_name3' -v to run multiple specific tests in one build.\"\n\nSTEP 3: Modify your test to inject a visible UI change (such as a popup) IMMEDIATELY BEFORE an EXISTING snapshot command (e.g., before percy_snapshot(self.driver, \"screenshot name\")).\n- Do NOT add a new snapshot name for the popup.\n- The popup must appear in an existing snapshot, not a new one.\n- Add this popup code in some test files before the percy_snapshot command you've added, to display the visual changes.\n\n```Javascript\npopup_script = `\nvar popup = document.createElement('div');\npopup.id = 'percy-test-popup';\npopup.style.cssText = popup.style.cssText = `\n  /* TODO: Add styles to make the popup large, centered, and visually noticeable.\n     Suggested properties: position: fixed; top/left; transform; background; color; font-size; padding; z-index; animation, etc. */\n`;\npopup.innerHTML = 'PERCY TEST<br>VISUAL CHANGE<br>DETECTED!';\ndocument.body.appendChild(popup);\n`;\n\n# Insert this just before the EXISTING snapshot command:\ndriver.execute_script(popup_script)\npercy_snapshot(self.driver, \"Before Adding to Cart\")  # (Do NOT change the snapshot name, keep existing one)\n```\n\nSTEP 4: Run a second Percy build.\n- The snapshot names must remain the same as in the baseline.\n- The visual change should now appear in the same snapshot as before.\n- Use the same build command you ran for the baseline.\n\nSTEP 5: Compare the two Percy builds to see the detected visual difference.\n\nSTEP 6: Now ask user if they want to setup percy for full project coverage? If yes, call the \"setupPercyVisualTesting\" tool to enable complete coverage for the entire project.\n\nCONSTRAINTS:\n- Do NOT run any builds until explicitly instructed in the steps.\n- Do NOT add new snapshot names\u2014only use existing ones.\n- Do NOT add popup injection until the baseline is established.\n- Visual changes must appear in EXISTING snapshots, not new ones.\n\nVALIDATION CHECKPOINTS (before proceeding to the next step):\n- Are you adding only snapshot commands (not running builds)?\n- Are you reusing existing snapshot names (not creating new ones)?\n- Have you established the baseline first (before adding visual changes)\n\nCRITICAL: \nDo NOT run tests separately or create multiple builds during baseline establishment. The goal is to have exactly TWO builds total: (1) baseline build with all original snapshots, (2) modified build with the same tests but visual changes injected.\n";

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

@@ -1,86 +0,0 @@
-export const IMPORTANT_SETUP_WARNING = "IMPORTANT: DO NOT SKIP ANY STEP. All the setup steps described below MUST be executed regardless of any existing configuration or setup. This ensures proper BrowserStack SDK setup.";
-export const SETUP_PERCY_DESCRIPTION = "Set up Percy visual testing for your project. This supports both Percy Web Standalone and Percy Automate.";
-export const LIST_TEST_FILES_DESCRIPTION = "Lists all test files for a given set of directories.";
-export const PERCY_SNAPSHOT_COMMANDS_DESCRIPTION = "Adds Percy snapshot commands to the specified test files.";
-export const RUN_ON_BROWSERSTACK_DESCRIPTION = "Set up and run automated web-based tests on BrowserStack using the BrowserStack SDK. Use this tool for functional or integration test setup on BrowserStack only. For any visual testing or Percy integration, use the dedicated Percy setup tool. Example prompts: run this test on browserstack; set up this project for browserstack.";
-export const SIMULATE_PERCY_CHANGE_DESCRIPTION = "This tool helps new users simulate a Percy visual change by guiding them to make a visible UI modification, rerun Percy, and verify that the change is detected. Only Percy web is supported";
-export const PERCY_REPLACE_REGEX = /Invoke listTestFiles\(\) with the provided directories[\s\S]*?- DO NOT STOP until you add commands in all the files or you reach end of the files\./;
-export const PERCY_SNAPSHOT_INSTRUCTION = `
-Invoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---
-Process files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:
-- Start with index 0
-- Then index 1  
-- Then index 2
-- Continue sequentially until the last index
-- DO NOT skip any index numbers
-- DO NOT jump to random indices like 10, 20, 30
-- DO NOT worry about time consuming and any constraints.
-- DO NOT STOP until you add commands in all the files or you reach end of the files.
-`;
-export const PERCY_SIMULATE_INSTRUCTION = `
-MANDATORY: Aggressive, Accurate Percy Snapshots Integration
-
-Prerequisite: Before making any code changes in the user's repo, switch to a branch named temp-percy (run git init first if the repo is not yet initialized).
-
-You MUST follow these steps with NO EXCEPTIONS:
-1. Identify 4-5 key test files in the project that are critical for visual testing.
-2. For EACH identified test file, analyze the code to find EVERY location where a Percy snapshot should be called (e.g., after each navigation, UI change, or significant state in tests).
-3. Insert snapshot calls at ALL such points, not just the first or most obvious one.
-
-Iteratively update every selected test file with percy snapshot calls at all identified points, ensuring comprehensive coverage of visual changes.`;
-export const PERCY_SIMULATION_DRIVER_INSTRUCTION = `
-MANDATORY: Step-by-Step Percy Visual Change Simulation
-You MUST follow these steps with NO EXCEPTIONS:
-
-STEP 1: At this case we have added Percy snapshot commands to the test files at the appropriate locations (e.g., after navigation, UI change, or significant state). 
-- Use ONLY existing snapshot names.
-- Do NOT add any popup injection or visual changes yet.
-- Do NOT run any Percy builds at this stage.
-
-STEP 2: Run ONE comprehensive baseline Percy build that executes ALL tests containing Percy snapshots in a SINGLE build. This creates one baseline build with all snapshots for comparison. Use a command like: npx percy exec -- python -m pytest tests/ -k 'test_name1 or test_name2 or test_name3' -v to run multiple specific tests in one build."
-
-STEP 3: Modify your test to inject a visible UI change (such as a popup) IMMEDIATELY BEFORE an EXISTING snapshot command (e.g., before percy_snapshot(self.driver, "screenshot name")).
-- Do NOT add a new snapshot name for the popup.
-- The popup must appear in an existing snapshot, not a new one.
-- Add this popup code in some test files before the percy_snapshot command you've added, to display the visual changes.
-
-\`\`\`Javascript
-popup_script = \`
-var popup = document.createElement('div');
-popup.id = 'percy-test-popup';
-popup.style.cssText = popup.style.cssText = \`
-  /* TODO: Add styles to make the popup large, centered, and visually noticeable.
-     Suggested properties: position: fixed; top/left; transform; background; color; font-size; padding; z-index; animation, etc. */
-\`;
-popup.innerHTML = 'PERCY TEST<br>VISUAL CHANGE<br>DETECTED!';
-document.body.appendChild(popup);
-\`;
-
-# Insert this just before the EXISTING snapshot command:
-driver.execute_script(popup_script)
-percy_snapshot(self.driver, "Before Adding to Cart")  # (Do NOT change the snapshot name, keep existing one)
-\`\`\`
-
-STEP 4: Run a second Percy build.
-- The snapshot names must remain the same as in the baseline.
-- The visual change should now appear in the same snapshot as before.
-- Use the same build command you ran for the baseline.
-
-STEP 5: Compare the two Percy builds to see the detected visual difference.
-
-STEP 6: Now ask user if they want to setup percy for full project coverage? If yes, call the "setupPercyVisualTesting" tool to enable complete coverage for the entire project.
-
-CONSTRAINTS:
-- Do NOT run any builds until explicitly instructed in the steps.
-- Do NOT add new snapshot names—only use existing ones.
-- Do NOT add popup injection until the baseline is established.
-- Visual changes must appear in EXISTING snapshots, not new ones.
-
-VALIDATION CHECKPOINTS (before proceeding to the next step):
-- Are you adding only snapshot commands (not running builds)?
-- Are you reusing existing snapshot names (not creating new ones)?
-- Have you established the baseline first (before adding visual changes)
-
-CRITICAL: 
-Do NOT run tests separately or create multiple builds during baseline establishment. The goal is to have exactly TWO builds total: (1) baseline build with all original snapshots, (2) modified build with the same tests but visual changes injected.
-`;

package/dist/tools/sdk-utils/common/formatUtils.d.ts

@@ -1,5 +0,0 @@
-export declare function formatInstructionsWithNumbers(instructionText: string, separator?: string): {
-    formattedSteps: string;
-    stepCount: number;
-};
-export declare function generateVerificationMessage(stepCount: number): string;

package/dist/tools/sdk-utils/common/formatUtils.js

@@ -1,27 +0,0 @@
-export function formatInstructionsWithNumbers(instructionText, separator = "---STEP---") {
-    // Split the instructions by the separator
-    const steps = instructionText
-        .split(separator)
-        .map((step) => step.trim())
-        .filter((step) => step.length > 0);
-    // If no separators found, treat the entire text as one step
-    if (steps.length === 1 && !instructionText.includes(separator)) {
-        return {
-            formattedSteps: `**Step 1:**\n${instructionText.trim()}`,
-            stepCount: 1,
-        };
-    }
-    // Format each step with numbering
-    const formattedSteps = steps
-        .map((step, index) => {
-        return `**Step ${index + 1}:**\n${step.trim()}`;
-    })
-        .join("\n\n");
-    return {
-        formattedSteps,
-        stepCount: steps.length,
-    };
-}
-export function generateVerificationMessage(stepCount) {
-    return `**✅ Verification:**\nPlease verify that you have completed all ${stepCount} steps above to ensure proper setup. If you encounter any issues, double-check each step and ensure all commands executed successfully.`;
-}

package/dist/tools/sdk-utils/common/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./types.js";
-export * from "./constants.js";
-export * from "./formatUtils.js";

package/dist/tools/sdk-utils/common/index.js

@@ -1,4 +0,0 @@
-// Common utilities and types for SDK tools
-export * from "./types.js";
-export * from "./constants.js";
-export * from "./formatUtils.js";

package/dist/tools/sdk-utils/common/instructionUtils.d.ts

@@ -1,8 +0,0 @@
-/**
- * Core instruction configuration utilities for runTestsOnBrowserStack tool.
- */
-import { SDKSupportedLanguage, SDKSupportedBrowserAutomationFramework, SDKSupportedTestingFramework } from "./types.js";
-export declare const getInstructionsForProjectConfiguration: (detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework, detectedTestingFramework: SDKSupportedTestingFramework, detectedLanguage: SDKSupportedLanguage, username: string, accessKey: string) => {
-    setup: string;
-    run: string;
-};

package/dist/tools/sdk-utils/common/instructionUtils.js

@@ -1,20 +0,0 @@
-/**
- * Core instruction configuration utilities for runTestsOnBrowserStack tool.
- */
-import { SUPPORTED_CONFIGURATIONS } from "../bstack/frameworks.js";
-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";
-export const getInstructionsForProjectConfiguration = (detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey) => {
-    const configuration = 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}`);
-    }
-    const instructionFunction = configuration[detectedBrowserAutomationFramework][detectedTestingFramework]
-        .instructions;
-    return instructionFunction(username, accessKey);
-};