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

package/README.md

@@ -38,7 +38,15 @@ Stay in flow—keep all project context in one place and trigger actions directl
 ## ⚡️ One Click MCP Setup
 
 [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](http://mcp.browserstack.com/one-click-setup?client=vscode)   [![Install in Cursor](https://img.shields.io/badge/Cursor-Install_Server-24bfa5?style=flat-square&color=000000&logo=visualstudiocode&logoColor=white)](http://mcp.browserstack.com/one-click-setup?client=cursor)
-
+#### Note : Ensure you are using Node version >= `18.0` 
+- Check your node version using `node --version`. Recommended version: `v22.15.0` (LTS)
+- To Upgrade Node :
+- 1. On macOS `(Homebrew) - brew update && brew upgrade node  or if using (nvm) - nvm install 22.15.0 && nvm use 22.15.0 && nvm alias default 22.15.0`
+- 2. On Windows `(nvm-windows) : nvm install 22.15.0 && nvm use 22.15.0`
+- 👉 <a href="https://nodejs.org/en/download" target="_blank">Or directly download the Node.js LTS Installer</a>
+
+.
+        
 ## 💡 Usage Examples
 
 ### 📱 Manual App Testing
@@ -142,6 +150,10 @@ Generate test cases from PRDs, convert manual tests to low-code automation, and
 
 ## 🛠️ Installation
 
+### 📋 Prerequisites for MCP Setup
+#### Note : Ensure you are using Node version >= `18.0` 
+- Check your node version using `node --version`. Recommended version: `v22.15.0` (LTS)
+   
 ### **One Click MCP Setup**
 
 [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](http://mcp.browserstack.com/one-click-setup?client=vscode) &nbsp; [![Install in Cursor](https://img.shields.io/badge/Cursor-Install_Server-24bfa5?style=flat-square&color=000000&logo=visualstudiocode&logoColor=white)](http://mcp.browserstack.com/one-click-setup?client=cursor)
@@ -158,7 +170,9 @@ Generate test cases from PRDs, convert manual tests to low-code automation, and
 
    - Once you have an account (and purchased appropriate plan), note down your `username` and `access_key` from [Account Settings](https://www.browserstack.com/accounts/profile/details).
 
-2. Ensure you are using Node version >= `18.0`. Check your node version using `node --version`. Recommended version: `v22.15.0` (LTS)
+2. #### Note : Ensure you are using Node version >= `18.0` 
+    - Check your node version using `node --version`. Recommended version: `v22.15.0` (LTS)
+   
 
 3. **Install the MCP Server**
 
@@ -456,7 +470,79 @@ As of now we support 20 tools.
   ```text
   Upload PRD from /Users/xyz/Desktop/login-flow.pdf and use BrowserStack AI to generate test cases
   ```
+##  🚀 Remote MCP Server
+
+Remote MCP comes with all the functionalities of an MCP server without the hassles of complex setup or local installation.
+
+### Key benefits:
+
+- ✅ Works seamlessly in enterprise networks without worrying about firewalls or binaries or where local installation is not allowed.
+
+- ✅ Secure OAuth integration – no password sharing or manual credential handling.
+
+### Limitations:
+
+- ❌ No Local Testing support (cannot test apps behind VPNs, firewalls, or localhost). If you have to do Local Testing, you would have to use a BrowserStack Local MCP server.
+- ❌ Latency can be slightly higher, but nothing considerable — you generally won’t notice it in normal use.
+
+### Installation Steps: 
 
+   - On VSCode (Copilot - Agent Mode): `.vscode/mcp.json`:
+    
+      - Locate or Create the Configuration File:
+      - In the root directory of your project, look for a folder named .vscode. This folder is usually hidden so you will need to find it as            mentioned in the expand.
+      - If this folder doesn't exist, create it.
+      - Inside the .vscode folder, create a new file named mcp.json
+      - To setup Remote BrowserStack MCP instead of local BrowserStack MCP you can add the following JSON content :
+         <div align="center">
+         <img src="assets/remotemcp_json_file.png" alt="Remote MCP JSON file" height="300" width="300">
+         </div>
+        
+        ### Alternative way to Setup Remote MCP
+
+      -  Step 1.Click on the gear icon to Select Tools
+      
+          <div align="center">
+          <img src="assets/select_tools.png" alt="Select Tools" height="300" width="300"> 
+          </div>
+          
+      -  Step 2. A tool menu would appear at the top-centre, scroll down on the menu at the top and then Click on Add MCP Server
+      
+        <div align="center">
+        <img src="assets/add_mcp_server.png" alt="Add MCP Server" height="300" width="300"> 
+        </div>
+
+      - Step 3. Click on HTTP option
+         <div align="center">
+         <img src="assets/http_option.png" alt="HTTP Option" height="300" width="300">
+         </div>
+         
+      - Step 4. Paste Remote MCP Server URL : https://mcp.browserstack.com/mcp
+         <div align="center">
+         <img src="assets/server_url.png" alt="Remote MCP Server URL" height="300" width="300">
+         </div>
+         
+      - Step 5. Give server id as : browserstack
+      
+          <div align="center">
+          <img src="assets/server_id.png" alt="Remote MCP Server ID" height="300" width="300">
+          </div>
+          
+      - Step 6. In VSCode Click on start MCP Server and then click on "Allow"
+      
+          <div align="center">
+          <img src="assets/authentication1.png" alt="authentication1" height="300" width="300">
+          </div>
+          
+          <div align="center">
+          <img src="assets/authentication2.png" alt="authentication2" height="300" width="300">
+          </div>
+          
+          <div align="center">
+          <img src="assets/signin_success.png" alt="Sign_in_success" height="300" width="300">
+          </div>
+
+     
 
 ## 🤝 Recommended MCP Clients
 

package/dist/lib/device-cache.js

@@ -26,30 +26,33 @@ export async function getDevicesAndBrowsers(type) {
         fs.mkdirSync(CACHE_DIR, { recursive: true });
     }
     let cache = {};
+    // Load existing cache
     if (fs.existsSync(CACHE_FILE)) {
-        const stats = fs.statSync(CACHE_FILE);
-        if (Date.now() - stats.mtimeMs < TTL_MS) {
-            try {
-                cache = JSON.parse(fs.readFileSync(CACHE_FILE, "utf8"));
-                if (cache[type]) {
-                    return cache[type];
-                }
-            }
-            catch (error) {
-                console.error("Error parsing cache file:", error);
-                // Continue with fetching fresh data
-            }
+        try {
+            cache = JSON.parse(fs.readFileSync(CACHE_FILE, "utf8"));
+        }
+        catch (err) {
+            console.error("Error parsing cache file:", err);
+            cache = {};
+        }
+        // Check per-product TTL
+        const cachedEntry = cache[type];
+        if (cachedEntry?.timestamp && Date.now() - cachedEntry.timestamp < TTL_MS) {
+            return cachedEntry.data;
         }
     }
+    // Fetch fresh data from BrowserStack
     const liveRes = await apiClient.get({ url: URLS[type], raise_error: false });
     if (!liveRes.ok) {
-        throw new Error(`Failed to fetch configuration from BrowserStack : ${type}=${liveRes.statusText}`);
+        throw new Error(`Failed to fetch configuration from BrowserStack: ${type} = ${liveRes.statusText}`);
     }
-    cache = {
-        [type]: liveRes.data,
+    // Save to cache with timestamp and data directly under product key
+    cache[type] = {
+        timestamp: Date.now(),
+        data: liveRes.data,
     };
-    fs.writeFileSync(CACHE_FILE, JSON.stringify(cache), "utf8");
-    return cache[type];
+    fs.writeFileSync(CACHE_FILE, JSON.stringify(cache, null, 2), "utf8");
+    return liveRes.data;
 }
 // Rate limiter for started event (3H)
 export function shouldSendStartedEvent() {

package/dist/lib/inmemory-store.d.ts

@@ -1 +1,2 @@
 export declare const signedUrlMap: Map<string, object>;
+export declare const testFilePathsMap: Map<string, string[]>;

package/dist/lib/inmemory-store.js

@@ -1 +1,2 @@
 export const signedUrlMap = new Map();
+export const testFilePathsMap = new Map();

package/dist/lib/utils.d.ts

@@ -1,4 +1,9 @@
 import type { ApiResponse } from "./apiClient.js";
+import { BrowserStackConfig } from "./types.js";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 export declare function sanitizeUrlParam(param: string): string;
 export declare function maybeCompressBase64(base64: string): Promise<string>;
 export declare function assertOkResponse(response: Response | ApiResponse, action: string): Promise<void>;
+export declare function fetchFromBrowserStackAPI(url: string, config: BrowserStackConfig): Promise<any>;
+export declare function handleMCPError(toolName: string, server: McpServer, config: BrowserStackConfig, error: unknown): CallToolResult;

package/dist/lib/utils.js

@@ -1,4 +1,6 @@
 import sharp from "sharp";
+import { getBrowserStackAuth } from "./get-auth.js";
+import { trackMCP } from "../index.js";
 export function sanitizeUrlParam(param) {
     // Remove any characters that could be used for command injection
     return param.replace(/[;&|`$(){}[\]<>]/g, "");
@@ -24,3 +26,28 @@ export async function assertOkResponse(response, action) {
         throw new Error(`Failed to fetch logs for ${action}: ${response.statusText}`);
     }
 }
+export async function fetchFromBrowserStackAPI(url, config) {
+    const authString = getBrowserStackAuth(config);
+    const auth = Buffer.from(authString).toString("base64");
+    const res = await fetch(url, {
+        headers: {
+            Authorization: `Basic ${auth}`,
+        },
+    });
+    if (!res.ok) {
+        throw new Error(`Failed to fetch from ${url}: ${res.status} ${res.statusText}`);
+    }
+    return res.json();
+}
+function errorContent(message) {
+    return {
+        content: [{ type: "text", text: message }],
+        isError: true,
+    };
+}
+export function handleMCPError(toolName, server, config, error) {
+    trackMCP(toolName, server.server.getClientVersion(), error, config);
+    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const readableToolName = toolName.replace(/([A-Z])/g, " $1").toLowerCase();
+    return errorContent(`Failed to ${readableToolName}: ${errorMessage}. Please open an issue on GitHub if the problem persists`);
+}

package/dist/server-factory.js

@@ -4,6 +4,7 @@ const require = createRequire(import.meta.url);
 const packageJson = require("../package.json");
 import logger from "./logger.js";
 import addSDKTools from "./tools/bstack-sdk.js";
+import addPercyTools from "./tools/percy-sdk.js";
 import addBrowserLiveTools from "./tools/live.js";
 import addAccessibilityTools from "./tools/accessibility.js";
 import addTestManagementTools from "./tools/testmanagement.js";
@@ -12,7 +13,9 @@ import addFailureLogsTools from "./tools/get-failure-logs.js";
 import addAutomateTools from "./tools/automate.js";
 import addSelfHealTools from "./tools/selfheal.js";
 import addAppLiveTools from "./tools/applive.js";
+import addBuildInsightsTools from "./tools/build-insights.js";
 import { setupOnInitialized } from "./oninitialized.js";
+import addRCATools from "./tools/rca-agent.js";
 /**
  * Wrapper class for BrowserStack MCP Server
  * Stores a map of registered tools by name
@@ -38,6 +41,7 @@ export class BrowserStackMcpServer {
         const toolAdders = [
             addAccessibilityTools,
             addSDKTools,
+            addPercyTools,
             addAppLiveTools,
             addBrowserLiveTools,
             addTestManagementTools,
@@ -45,6 +49,8 @@ export class BrowserStackMcpServer {
             addFailureLogsTools,
             addAutomateTools,
             addSelfHealTools,
+            addBuildInsightsTools,
+            addRCATools,
         ];
         toolAdders.forEach((adder) => {
             // Each adder now returns a Record<string, Tool>

package/dist/tools/add-percy-snapshots.d.ts

@@ -0,0 +1,5 @@
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+export declare function updateTestsWithPercyCommands(args: {
+    uuid: string;
+    index: number;
+}): Promise<CallToolResult>;

package/dist/tools/add-percy-snapshots.js

@@ -0,0 +1,17 @@
+import { testFilePathsMap } from "../lib/inmemory-store.js";
+import { updateFileAndStep } from "./percy-snapshot-utils/utils.js";
+import { percyWebSetupInstructions } from "../tools/sdk-utils/percy-web/handler.js";
+export async function updateTestsWithPercyCommands(args) {
+    const { uuid, index } = args;
+    const filePaths = testFilePathsMap.get(uuid);
+    if (!filePaths) {
+        throw new Error(`No test files found in memory for UUID: ${uuid}`);
+    }
+    if (index < 0 || index >= filePaths.length) {
+        throw new Error(`Invalid index: ${index}. There are ${filePaths.length} files for UUID: ${uuid}`);
+    }
+    const result = await updateFileAndStep(filePaths[index], index, filePaths.length, percyWebSetupInstructions);
+    return {
+        content: result,
+    };
+}

package/dist/tools/appautomate-utils/appium-sdk/types.d.ts

@@ -49,8 +49,8 @@ export interface AppSDKInstruction {
 export declare const SUPPORTED_CONFIGURATIONS: {
     appium: {
         ruby: string[];
-        java: string[];
-        csharp: string[];
+        java: never[];
+        csharp: never[];
         python: string[];
         nodejs: string[];
     };

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

@@ -46,15 +46,8 @@ export var AppSDKSupportedPlatformEnum;
 export const SUPPORTED_CONFIGURATIONS = {
     appium: {
         ruby: ["cucumberRuby"],
-        java: [
-            "junit5",
-            "junit4",
-            "testng",
-            "cucumberTestng",
-            "selenide",
-            "jbehave",
-        ],
-        csharp: ["nunit", "xunit", "mstest", "specflow", "reqnroll"],
+        java: [],
+        csharp: [],
         python: ["pytest", "robot", "behave", "lettuce"],
         nodejs: ["jest", "mocha", "cucumberJs", "webdriverio", "nightwatch"],
     },

package/dist/tools/appautomate-utils/appium-sdk/utils.js

@@ -55,6 +55,9 @@ export function validateSupportforAppAutomate(framework, language, testingFramew
         throw new Error(`Unsupported language '${language}' for framework '${framework}'. Supported languages: ${languages.join(", ")}`);
     }
     const testingFrameworks = SUPPORTED_CONFIGURATIONS[framework][language];
+    if (testingFrameworks.length === 0) {
+        throw new Error(`No testing frameworks are supported for language '${language}' and framework '${framework}'.`);
+    }
     if (!testingFrameworks.includes(testingFramework)) {
         throw new Error(`Unsupported testing framework '${testingFramework}' for language '${language}' and framework '${framework}'. Supported testing frameworks: ${testingFrameworks.join(", ")}`);
     }

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

@@ -1,17 +1,4 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { SDKSupportedBrowserAutomationFramework, SDKSupportedLanguage, SDKSupportedTestingFramework } from "./sdk-utils/types.js";
 import { BrowserStackConfig } from "../lib/types.js";
-/**
- * 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.
- */
-export declare function bootstrapProjectWithSDK({ detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, desiredPlatforms, enablePercy, config, }: {
-    detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework;
-    detectedTestingFramework: SDKSupportedTestingFramework;
-    detectedLanguage: SDKSupportedLanguage;
-    desiredPlatforms: string[];
-    enablePercy: boolean;
-    config: BrowserStackConfig;
-}): Promise<CallToolResult>;
-export default function addSDKTools(server: McpServer, config: BrowserStackConfig): Record<string, any>;
+export declare function registerRunBrowserStackTestsTool(server: McpServer, config: BrowserStackConfig): Record<string, any>;
+export default registerRunBrowserStackTestsTool;

package/dist/tools/bstack-sdk.js

@@ -1,128 +1,19 @@
-import { z } from "zod";
+import { RunTestsOnBrowserStackParamsShape } from "./sdk-utils/common/schema.js";
+import { runTestsOnBrowserStackHandler } from "./sdk-utils/handler.js";
+import { RUN_ON_BROWSERSTACK_DESCRIPTION } from "./sdk-utils/common/constants.js";
+import { handleMCPError } from "../lib/utils.js";
 import { trackMCP } from "../lib/instrumentation.js";
-import { getSDKPrefixCommand } from "./sdk-utils/commands.js";
-import { SDKSupportedLanguageEnum, SDKSupportedBrowserAutomationFrameworkEnum, SDKSupportedTestingFrameworkEnum, } from "./sdk-utils/types.js";
-import { generateBrowserStackYMLInstructions, getInstructionsForProjectConfiguration, formatInstructionsWithNumbers, } from "./sdk-utils/instructions.js";
-import { formatPercyInstructions, getPercyInstructions, } from "./sdk-utils/percy/instructions.js";
-import { getBrowserStackAuth } from "../lib/get-auth.js";
-/**
- * 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.
- */
-export async function bootstrapProjectWithSDK({ detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, desiredPlatforms, enablePercy, config, }) {
-    // Get credentials from config
-    const authString = getBrowserStackAuth(config);
-    const [username, accessKey] = authString.split(":");
-    // Handle frameworks with unique setup instructions that don't use browserstack.yml
-    if (detectedBrowserAutomationFramework === "cypress" ||
-        detectedTestingFramework === "webdriverio") {
-        let combinedInstructions = getInstructionsForProjectConfiguration(detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey);
-        if (enablePercy) {
-            const percyInstructions = getPercyInstructions(detectedLanguage, detectedBrowserAutomationFramework, detectedTestingFramework);
-            if (percyInstructions) {
-                combinedInstructions +=
-                    "\n\n" + formatPercyInstructions(percyInstructions);
-            }
-            else {
-                throw new Error(`Percy is currently not supported through MCP for ${detectedLanguage} with ${detectedTestingFramework}. If you want to run the test cases without Percy, disable Percy and run it again.`);
-            }
-        }
-        // Apply consistent formatting for all configurations
-        return formatFinalInstructions(combinedInstructions);
-    }
-    // Handle default flow using browserstack.yml
-    const sdkSetupCommand = getSDKPrefixCommand(detectedLanguage, detectedTestingFramework, username, accessKey);
-    const ymlInstructions = generateBrowserStackYMLInstructions(desiredPlatforms, enablePercy);
-    const instructionsForProjectConfiguration = getInstructionsForProjectConfiguration(detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey);
-    let combinedInstructions = "";
-    // Step 1: Add SDK setup command
-    if (sdkSetupCommand) {
-        combinedInstructions += sdkSetupCommand;
-    }
-    // Step 2: Add browserstack.yml setup
-    if (ymlInstructions) {
-        combinedInstructions += "\n\n---STEP---\n" + ymlInstructions;
-    }
-    // Step 3: Add language/framework-specific setup
-    if (instructionsForProjectConfiguration) {
-        combinedInstructions += "\n\n" + instructionsForProjectConfiguration;
-    }
-    // Step 4: Add Percy setup if applicable
-    if (enablePercy) {
-        const percyInstructions = getPercyInstructions(detectedLanguage, detectedBrowserAutomationFramework, detectedTestingFramework);
-        if (percyInstructions) {
-            combinedInstructions +=
-                "\n\n" + formatPercyInstructions(percyInstructions);
-        }
-        else {
-            throw new Error(`Percy is currently not supported through MCP for ${detectedLanguage} with ${detectedTestingFramework}. If you want to run the test cases without Percy, disable Percy and run it again.`);
-        }
-    }
-    // Apply consistent formatting for all configurations
-    return formatFinalInstructions(combinedInstructions);
-}
-// Helper function to apply consistent formatting to all instruction types
-function formatFinalInstructions(combinedInstructions) {
-    const fullInstructions = `⚠️ IMPORTANT: DO NOT SKIP ANY STEP
-  All the setup steps described in this file MUST be executed regardless of any existing configuration or setup.
-  This ensures proper BrowserStack SDK setup.
-
-  ${formatInstructionsWithNumbers(combinedInstructions)}`;
-    return {
-        content: [
-            {
-                type: "text",
-                text: fullInstructions,
-                isError: false,
-            },
-        ],
-    };
-}
-export default function addSDKTools(server, config) {
+export function registerRunBrowserStackTestsTool(server, config) {
     const tools = {};
-    tools.setupBrowserStackAutomateTests = server.tool("setupBrowserStackAutomateTests", "Set up and run automated web-based tests on BrowserStack using the BrowserStack SDK. Use for functional or integration tests on BrowserStack, with optional Percy visual testing for supported frameworks. Example prompts: run this test on browserstack; run this test on browserstack with Percy; set up this project for browserstack with Percy. Integrate BrowserStack SDK into your project", {
-        detectedBrowserAutomationFramework: z
-            .nativeEnum(SDKSupportedBrowserAutomationFrameworkEnum)
-            .describe("The automation framework configured in the project. Example: 'playwright', 'selenium'"),
-        detectedTestingFramework: z
-            .nativeEnum(SDKSupportedTestingFrameworkEnum)
-            .describe("The testing framework used in the project. Be precise with framework selection Example: 'webdriverio', 'jest', 'pytest', 'junit4', 'junit5', 'mocha'"),
-        detectedLanguage: z
-            .nativeEnum(SDKSupportedLanguageEnum)
-            .describe("The programming language used in the project. Example: 'nodejs', 'python', 'java', 'csharp'"),
-        desiredPlatforms: z
-            .array(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."),
-        enablePercy: z
-            .boolean()
-            .optional()
-            .default(false)
-            .describe("Set to true if the user wants to enable Percy for visual testing. Defaults to false."),
-    }, async (args) => {
+    tools.setupBrowserStackAutomateTests = server.tool("setupBrowserStackAutomateTests", RUN_ON_BROWSERSTACK_DESCRIPTION, RunTestsOnBrowserStackParamsShape, async (args) => {
         try {
-            trackMCP("runTestsOnBrowserStack", server.server.getClientVersion(), undefined, config);
-            return await bootstrapProjectWithSDK({
-                detectedBrowserAutomationFramework: args.detectedBrowserAutomationFramework,
-                detectedTestingFramework: args.detectedTestingFramework,
-                detectedLanguage: args.detectedLanguage,
-                desiredPlatforms: args.desiredPlatforms,
-                enablePercy: args.enablePercy,
-                config,
-            });
+            trackMCP("runTestsOnBrowserStack", server.server.getClientVersion(), config);
+            return await runTestsOnBrowserStackHandler(args, config);
         }
         catch (error) {
-            trackMCP("runTestsOnBrowserStack", server.server.getClientVersion(), error, config);
-            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,
-            };
+            return handleMCPError("runTestsOnBrowserStack", server, config, error);
         }
     });
     return tools;
 }
+export default registerRunBrowserStackTestsTool;

package/dist/tools/build-insights.d.ts

@@ -0,0 +1,7 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { BrowserStackConfig } from "../lib/types.js";
+export declare function fetchBuildInsightsTool(args: {
+    buildId: string;
+}, config: BrowserStackConfig): Promise<CallToolResult>;
+export default function addBuildInsightsTools(server: McpServer, config: BrowserStackConfig): Record<string, any>;

package/dist/tools/build-insights.js

@@ -0,0 +1,67 @@
+import { z } from "zod";
+import logger from "../logger.js";
+import { fetchFromBrowserStackAPI, handleMCPError } from "../lib/utils.js";
+import { trackMCP } from "../lib/instrumentation.js";
+// Tool function that fetches build insights from two APIs
+export async function fetchBuildInsightsTool(args, config) {
+    try {
+        const buildUrl = `https://api-automation.browserstack.com/ext/v1/builds/${args.buildId}`;
+        const qualityGateUrl = `https://api-automation.browserstack.com/ext/v1/quality-gates/${args.buildId}`;
+        const [buildData, qualityData] = await Promise.all([
+            fetchFromBrowserStackAPI(buildUrl, config),
+            fetchFromBrowserStackAPI(qualityGateUrl, config),
+        ]);
+        // Select useful fields for users
+        const insights = {
+            name: buildData.name,
+            status: buildData.status,
+            duration: buildData.duration,
+            user: buildData.user,
+            tags: buildData.tags,
+            alerts: buildData.alerts,
+            status_stats: buildData.status_stats,
+            failure_categories: buildData.failure_categories,
+            smart_tags: buildData.smart_tags,
+            unique_errors: buildData.unique_errors?.overview,
+            observability_url: buildData?.observability_url,
+            ci_build_url: buildData.ci_info?.build_url,
+            quality_gate_result: qualityData.quality_gate_result,
+        };
+        const qualityProfiles = qualityData.quality_profiles?.map((profile) => ({
+            name: profile.name,
+            result: profile.result,
+        }));
+        const qualityProfilesText = qualityProfiles && qualityProfiles.length > 0
+            ? `Quality Gate Profiles (respond only if explicitly requested): ${JSON.stringify(qualityProfiles, null, 2)}`
+            : "No Quality Gate Profiles available.";
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: "Build insights:\n" + JSON.stringify(insights, null, 2),
+                },
+                { type: "text", text: qualityProfilesText },
+            ],
+        };
+    }
+    catch (error) {
+        logger.error("Error fetching build insights", error);
+        throw error;
+    }
+}
+// Registers the fetchBuildInsights tool with the MCP server
+export default function addBuildInsightsTools(server, config) {
+    const tools = {};
+    tools.fetchBuildInsights = server.tool("fetchBuildInsights", "Fetches insights about a BrowserStack build by combining build details and quality gate results.", {
+        buildId: z.string().describe("The build UUID of the BrowserStack build"),
+    }, async (args) => {
+        try {
+            trackMCP("fetchBuildInsights", server.server.getClientVersion(), config);
+            return await fetchBuildInsightsTool(args, config);
+        }
+        catch (error) {
+            return handleMCPError("fetchBuildInsights", server, config, error);
+        }
+    });
+    return tools;
+}

package/dist/tools/list-test-files.d.ts

@@ -0,0 +1,2 @@
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+export declare function addListTestFiles(args: any): Promise<CallToolResult>;

package/dist/tools/list-test-files.js

@@ -0,0 +1,36 @@
+import { listTestFiles } from "./percy-snapshot-utils/detect-test-files.js";
+import { testFilePathsMap } from "../lib/inmemory-store.js";
+import crypto from "crypto";
+export async function addListTestFiles(args) {
+    const { dirs, language, framework } = args;
+    let testFiles = [];
+    if (!dirs || dirs.length === 0) {
+        throw new Error("No directories provided to add the test files. Please provide test directories to add percy snapshot commands.");
+    }
+    for (const dir of dirs) {
+        const files = await listTestFiles({
+            language,
+            framework,
+            baseDir: dir,
+        });
+        testFiles = testFiles.concat(files);
+    }
+    if (testFiles.length === 0) {
+        throw new Error("No test files found");
+    }
+    // Generate a UUID and store the test files in memory
+    const uuid = crypto.randomUUID();
+    testFilePathsMap.set(uuid, testFiles);
+    return {
+        content: [
+            {
+                type: "text",
+                text: `The Test files are stored in memory with id ${uuid} and the total number of tests files found is ${testFiles.length}. You can use this UUID to retrieve the tests file paths later.`,
+            },
+            {
+                type: "text",
+                text: `You can now use the tool addPercySnapshotCommands to update the test file with Percy commands for visual testing with the UUID ${uuid}`,
+            },
+        ],
+    };
+}

package/dist/tools/percy-sdk.d.ts

@@ -0,0 +1,4 @@
+import { BrowserStackConfig } from "../lib/types.js";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+export declare function registerPercyTools(server: McpServer, config: BrowserStackConfig): Record<string, any>;
+export default registerPercyTools;