@browserstack/mcp-server 1.2.8 → 1.2.9-beta.1

package/README.md

@@ -288,20 +288,10 @@ Select the “Installed” tab. Click the “Configure MCP Servers” button at
    }
    ```
 
-### 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
-```
-
-
 ### 💡 List of BrowserStack MCP Tools
 
 As of now we support 20 tools.
 
-
 ---
 
 ## 🧾 Test Management

package/dist/lib/utils.d.ts

@@ -8,71 +8,93 @@ export declare function fetchFromBrowserStackAPI(url: string, config: BrowserSta
 export declare function handleMCPError(toolName: string, server: McpServer, config: BrowserStackConfig, error: unknown): {
     [x: string]: unknown;
     content: ({
-        [x: string]: unknown;
         type: "text";
         text: string;
+        annotations?: {
+            audience?: ("user" | "assistant")[] | undefined;
+            priority?: number | undefined;
+            lastModified?: string | undefined;
+        } | undefined;
         _meta?: {
             [x: string]: unknown;
         } | undefined;
     } | {
-        [x: string]: unknown;
         type: "image";
         data: string;
         mimeType: string;
+        annotations?: {
+            audience?: ("user" | "assistant")[] | undefined;
+            priority?: number | undefined;
+            lastModified?: string | undefined;
+        } | undefined;
         _meta?: {
             [x: string]: unknown;
         } | undefined;
     } | {
-        [x: string]: unknown;
         type: "audio";
         data: string;
         mimeType: string;
+        annotations?: {
+            audience?: ("user" | "assistant")[] | undefined;
+            priority?: number | undefined;
+            lastModified?: string | undefined;
+        } | undefined;
         _meta?: {
             [x: string]: unknown;
         } | undefined;
     } | {
-        [x: string]: unknown;
-        type: "resource_link";
-        name: string;
         uri: string;
+        name: string;
+        type: "resource_link";
+        description?: string | undefined;
+        mimeType?: string | undefined;
+        annotations?: {
+            audience?: ("user" | "assistant")[] | undefined;
+            priority?: number | undefined;
+            lastModified?: string | undefined;
+        } | undefined;
         _meta?: {
             [x: string]: unknown;
         } | undefined;
-        mimeType?: string | undefined;
-        title?: string | undefined;
-        description?: string | undefined;
         icons?: {
-            [x: string]: unknown;
             src: string;
             mimeType?: string | undefined;
             sizes?: string[] | undefined;
+            theme?: "light" | "dark" | undefined;
         }[] | undefined;
+        title?: string | undefined;
     } | {
-        [x: string]: unknown;
         type: "resource";
         resource: {
-            [x: string]: unknown;
-            text: string;
             uri: string;
+            text: string;
+            mimeType?: string | undefined;
             _meta?: {
                 [x: string]: unknown;
             } | undefined;
-            mimeType?: string | undefined;
         } | {
-            [x: string]: unknown;
             uri: string;
             blob: string;
+            mimeType?: string | undefined;
             _meta?: {
                 [x: string]: unknown;
             } | undefined;
-            mimeType?: string | undefined;
         };
+        annotations?: {
+            audience?: ("user" | "assistant")[] | undefined;
+            priority?: number | undefined;
+            lastModified?: string | undefined;
+        } | undefined;
         _meta?: {
             [x: string]: unknown;
         } | undefined;
     })[];
     _meta?: {
         [x: string]: unknown;
+        progressToken?: string | number | undefined;
+        "io.modelcontextprotocol/related-task"?: {
+            taskId: string;
+        } | undefined;
     } | undefined;
     structuredContent?: {
         [x: string]: unknown;

package/dist/tools/accessibility.js

@@ -12,16 +12,15 @@ function setupAuth(config) {
     const [username, password] = authString.split(":");
     return { username, password };
 }
-function createErrorResponse(message, isError = true) {
+function createErrorResponse(message) {
     return {
         content: [
             {
                 type: "text",
                 text: message,
-                isError,
             },
         ],
-        isError,
+        isError: true,
     };
 }
 function createSuccessResponse(messages) {

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

@@ -13,36 +13,26 @@ export declare const APP_DEVICE_CONFIGS: {
 export declare const STEP_DELIMITER = "---STEP---";
 export declare const DEFAULT_APP_PATH = "bs://sample.app";
 export declare const MobileDeviceSchema: z.ZodObject<{
-    platform: z.ZodEnum<["android", "ios"]>;
+    platform: z.ZodEnum<{
+        android: "android";
+        ios: "ios";
+    }>;
     deviceName: z.ZodString;
     osVersion: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    platform: "android" | "ios";
-    deviceName: string;
-    osVersion: string;
-}, {
-    platform: "android" | "ios";
-    deviceName: string;
-    osVersion: string;
-}>;
+}, z.core.$strip>;
 export declare const SETUP_APP_AUTOMATE_DESCRIPTION = "Set up BrowserStack App Automate SDK integration for Appium-based mobile app testing. ONLY for Appium based framework . This tool configures SDK for various languages with appium. For pre-built Espresso or XCUITest test suites, use 'runAppTestsOnBrowserStack' instead.";
 export declare const SETUP_APP_AUTOMATE_SCHEMA: {
-    detectedFramework: z.ZodNativeEnum<typeof AppSDKSupportedFrameworkEnum>;
-    detectedTestingFramework: z.ZodNativeEnum<typeof AppSDKSupportedTestingFrameworkEnum>;
-    detectedLanguage: z.ZodNativeEnum<typeof AppSDKSupportedLanguageEnum>;
+    detectedFramework: z.ZodEnum<typeof AppSDKSupportedFrameworkEnum>;
+    detectedTestingFramework: z.ZodEnum<typeof AppSDKSupportedTestingFrameworkEnum>;
+    detectedLanguage: z.ZodEnum<typeof AppSDKSupportedLanguageEnum>;
     devices: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        platform: z.ZodEnum<["android", "ios"]>;
+        platform: z.ZodEnum<{
+            android: "android";
+            ios: "ios";
+        }>;
         deviceName: z.ZodString;
         osVersion: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        platform: "android" | "ios";
-        deviceName: string;
-        osVersion: string;
-    }, {
-        platform: "android" | "ios";
-        deviceName: string;
-        osVersion: string;
-    }>, "many">>;
+    }, z.core.$strip>>>;
     appPath: z.ZodString;
     project: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 };

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

@@ -12,7 +12,6 @@ ${formattedInstructions}`;
             {
                 type: "text",
                 text: fullInstructions,
-                isError: false,
             },
         ],
     };

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

@@ -62,7 +62,6 @@ export async function setupAppAutomateHandler(rawInput, config) {
             {
                 type: "text",
                 text: formatAppInstructionsWithNumbers(combinedInstructions),
-                isError: false,
             },
         ],
         isError: false,

package/dist/tools/appautomate-utils/native-execution/constants.d.ts

@@ -2,34 +2,24 @@ import { z } from "zod";
 import { AppTestPlatform } from "./types.js";
 export declare const RUN_APP_AUTOMATE_DESCRIPTION = "Execute pre-built native mobile test suites (Espresso for Android, XCUITest for iOS) by direct upload to BrowserStack. ONLY for compiled .apk/.ipa test files. This is NOT for SDK integration or Appium tests. For Appium-based testing with SDK setup, use 'setupBrowserStackAppAutomateTests' instead.";
 export declare const MobileDeviceSchema: z.ZodObject<{
-    platform: z.ZodEnum<["android", "ios"]>;
+    platform: z.ZodEnum<{
+        android: "android";
+        ios: "ios";
+    }>;
     deviceName: z.ZodString;
     osVersion: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    platform: "android" | "ios";
-    deviceName: string;
-    osVersion: string;
-}, {
-    platform: "android" | "ios";
-    deviceName: string;
-    osVersion: string;
-}>;
+}, z.core.$strip>;
 export declare const RUN_APP_AUTOMATE_SCHEMA: {
     appPath: z.ZodString;
     testSuitePath: z.ZodString;
     devices: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        platform: z.ZodEnum<["android", "ios"]>;
+        platform: z.ZodEnum<{
+            android: "android";
+            ios: "ios";
+        }>;
         deviceName: z.ZodString;
         osVersion: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        platform: "android" | "ios";
-        deviceName: string;
-        osVersion: string;
-    }, {
-        platform: "android" | "ios";
-        deviceName: string;
-        osVersion: string;
-    }>, "many">>;
+    }, z.core.$strip>>>;
     project: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    detectedAutomationFramework: z.ZodNativeEnum<typeof AppTestPlatform>;
+    detectedAutomationFramework: z.ZodEnum<typeof AppTestPlatform>;
 };

package/dist/tools/appautomate.js

@@ -81,7 +81,6 @@ async function takeAppScreenshot(args) {
                     type: "image",
                     data: compressed,
                     mimeType: "image/png",
-                    name: `screenshot-${selectedDevice.device}-${Date.now()}`,
                 },
             ],
         };
@@ -257,7 +256,6 @@ export default function addAppAutomationTools(server, config) {
                     {
                         type: "text",
                         text: `Failed to bootstrap project with BrowserStack App Automate SDK. Error: ${error_message}. Please open an issue on GitHub if the problem persists`,
-                        isError: true,
                     },
                 ],
                 isError: true,

package/dist/tools/applive.js

@@ -80,7 +80,6 @@ export default function addAppLiveTools(server, config) {
                     {
                         type: "text",
                         text: `Failed to start app live session: ${error instanceof Error ? error.message : String(error)}`,
-                        isError: true,
                     },
                 ],
                 isError: true,

package/dist/tools/automate.js

@@ -20,10 +20,9 @@ export async function fetchAutomationScreenshotsTool(args, config) {
         }
         const results = screenshots.map((screenshot, index) => ({
             type: "image",
-            text: `Screenshot ${index + 1}`,
             data: screenshot.base64,
             mimeType: "image/png",
-            metadata: { url: screenshot.url },
+            _meta: { url: screenshot.url, index: index + 1 },
         }));
         return {
             content: [

package/dist/tools/get-failure-logs.js

@@ -41,9 +41,9 @@ export async function getFailureLogs(args, config) {
                 {
                     type: "text",
                     text: `No valid log types found for ${args.sessionType} session.\nErrors encountered:\n${errors.join("\n")}`,
-                    isError: true,
                 },
             ],
+            isError: true,
         };
     }
     let response;
@@ -91,7 +91,6 @@ export async function getFailureLogs(args, config) {
         results.push({
             type: "text",
             text: `Errors encountered:\n${errors.join("\n")}`,
-            isError: true,
         });
     }
     return { content: results };
@@ -132,7 +131,6 @@ export default function registerGetFailureLogs(server, config) {
                     {
                         type: "text",
                         text: `Failed to fetch failure logs: ${error instanceof Error ? error.message : "Unknown error"}`,
-                        isError: true,
                     },
                 ],
                 isError: true,

package/dist/tools/live.js

@@ -101,7 +101,6 @@ export default function addBrowserLiveTools(server, config) {
                     {
                         type: "text",
                         text: `Failed to start a browser live session. Error: ${error}`,
-                        isError: true,
                     },
                 ],
                 isError: true,

package/dist/tools/observability.js

@@ -52,7 +52,6 @@ export default function addObservabilityTools(server, config) {
                     {
                         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/rca-agent-utils/constants.d.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 import { TestStatus } from "./types.js";
 export declare const FETCH_RCA_PARAMS: {
-    testId: z.ZodArray<z.ZodNumber, "many">;
+    testId: z.ZodArray<z.ZodNumber>;
 };
 export declare const GET_BUILD_ID_PARAMS: {
     browserStackProjectName: z.ZodString;
@@ -9,5 +9,5 @@ export declare const GET_BUILD_ID_PARAMS: {
 };
 export declare const LIST_TEST_IDS_PARAMS: {
     buildId: z.ZodString;
-    status: z.ZodNativeEnum<typeof TestStatus>;
+    status: z.ZodEnum<typeof TestStatus>;
 };

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

@@ -15,123 +15,73 @@ export declare const MacOSPlatformEnum: {
 };
 export declare const SetUpPercyParamsShape: {
     projectName: z.ZodString;
-    detectedLanguage: z.ZodNativeEnum<typeof SDKSupportedLanguageEnum>;
-    detectedBrowserAutomationFramework: z.ZodNativeEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
-    detectedTestingFramework: z.ZodNativeEnum<typeof SDKSupportedTestingFrameworkEnum>;
-    integrationType: z.ZodNativeEnum<typeof PercyIntegrationTypeEnum>;
-    folderPaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    filePaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    detectedLanguage: z.ZodEnum<typeof SDKSupportedLanguageEnum>;
+    detectedBrowserAutomationFramework: z.ZodEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
+    detectedTestingFramework: z.ZodEnum<typeof SDKSupportedTestingFrameworkEnum>;
+    integrationType: z.ZodEnum<typeof PercyIntegrationTypeEnum>;
+    folderPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    filePaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
 };
 export declare const RunTestsOnBrowserStackParamsShape: {
     projectName: z.ZodString;
-    detectedLanguage: z.ZodNativeEnum<typeof SDKSupportedLanguageEnum>;
-    detectedBrowserAutomationFramework: z.ZodNativeEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
-    detectedTestingFramework: z.ZodNativeEnum<typeof SDKSupportedTestingFrameworkEnum>;
+    detectedLanguage: z.ZodEnum<typeof SDKSupportedLanguageEnum>;
+    detectedBrowserAutomationFramework: z.ZodEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
+    detectedTestingFramework: z.ZodEnum<typeof SDKSupportedTestingFrameworkEnum>;
     devices: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        platform: z.ZodEnum<["windows", "macos", "android", "ios"]>;
+        platform: z.ZodEnum<{
+            android: "android";
+            windows: "windows";
+            macos: "macos";
+            ios: "ios";
+        }>;
         deviceName: z.ZodOptional<z.ZodString>;
         osVersion: z.ZodString;
         browser: z.ZodOptional<z.ZodString>;
         browserVersion: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        platform: "android" | "windows" | "macos" | "ios";
-        osVersion: string;
-        deviceName?: string | undefined;
-        browser?: string | undefined;
-        browserVersion?: string | undefined;
-    }, {
-        platform: "android" | "windows" | "macos" | "ios";
-        osVersion: string;
-        deviceName?: string | undefined;
-        browser?: string | undefined;
-        browserVersion?: string | undefined;
-    }>, "many">>;
+    }, z.core.$strip>>>;
 };
 export declare const SetUpPercySchema: z.ZodObject<{
     projectName: z.ZodString;
-    detectedLanguage: z.ZodNativeEnum<typeof SDKSupportedLanguageEnum>;
-    detectedBrowserAutomationFramework: z.ZodNativeEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
-    detectedTestingFramework: z.ZodNativeEnum<typeof SDKSupportedTestingFrameworkEnum>;
-    integrationType: z.ZodNativeEnum<typeof PercyIntegrationTypeEnum>;
-    folderPaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    filePaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strip", z.ZodTypeAny, {
-    projectName: string;
-    detectedLanguage: SDKSupportedLanguageEnum;
-    detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFrameworkEnum;
-    detectedTestingFramework: SDKSupportedTestingFrameworkEnum;
-    integrationType: PercyIntegrationTypeEnum;
-    folderPaths?: string[] | undefined;
-    filePaths?: string[] | undefined;
-}, {
-    projectName: string;
-    detectedLanguage: SDKSupportedLanguageEnum;
-    detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFrameworkEnum;
-    detectedTestingFramework: SDKSupportedTestingFrameworkEnum;
-    integrationType: PercyIntegrationTypeEnum;
-    folderPaths?: string[] | undefined;
-    filePaths?: string[] | undefined;
-}>;
+    detectedLanguage: z.ZodEnum<typeof SDKSupportedLanguageEnum>;
+    detectedBrowserAutomationFramework: z.ZodEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
+    detectedTestingFramework: z.ZodEnum<typeof SDKSupportedTestingFrameworkEnum>;
+    integrationType: z.ZodEnum<typeof PercyIntegrationTypeEnum>;
+    folderPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    filePaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
 export declare const RunTestsOnBrowserStackSchema: z.ZodObject<{
     projectName: z.ZodString;
-    detectedLanguage: z.ZodNativeEnum<typeof SDKSupportedLanguageEnum>;
-    detectedBrowserAutomationFramework: z.ZodNativeEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
-    detectedTestingFramework: z.ZodNativeEnum<typeof SDKSupportedTestingFrameworkEnum>;
+    detectedLanguage: z.ZodEnum<typeof SDKSupportedLanguageEnum>;
+    detectedBrowserAutomationFramework: z.ZodEnum<typeof SDKSupportedBrowserAutomationFrameworkEnum>;
+    detectedTestingFramework: z.ZodEnum<typeof SDKSupportedTestingFrameworkEnum>;
     devices: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        platform: z.ZodEnum<["windows", "macos", "android", "ios"]>;
+        platform: z.ZodEnum<{
+            android: "android";
+            windows: "windows";
+            macos: "macos";
+            ios: "ios";
+        }>;
         deviceName: z.ZodOptional<z.ZodString>;
         osVersion: z.ZodString;
         browser: z.ZodOptional<z.ZodString>;
         browserVersion: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        platform: "android" | "windows" | "macos" | "ios";
-        osVersion: string;
-        deviceName?: string | undefined;
-        browser?: string | undefined;
-        browserVersion?: string | undefined;
-    }, {
-        platform: "android" | "windows" | "macos" | "ios";
-        osVersion: string;
-        deviceName?: string | undefined;
-        browser?: string | undefined;
-        browserVersion?: string | undefined;
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    projectName: string;
-    detectedLanguage: SDKSupportedLanguageEnum;
-    detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFrameworkEnum;
-    detectedTestingFramework: SDKSupportedTestingFrameworkEnum;
-    devices: {
-        platform: "android" | "windows" | "macos" | "ios";
-        osVersion: string;
-        deviceName?: string | undefined;
-        browser?: string | undefined;
-        browserVersion?: string | undefined;
-    }[];
-}, {
-    projectName: string;
-    detectedLanguage: SDKSupportedLanguageEnum;
-    detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFrameworkEnum;
-    detectedTestingFramework: SDKSupportedTestingFrameworkEnum;
-    devices?: {
-        platform: "android" | "windows" | "macos" | "ios";
-        osVersion: string;
-        deviceName?: string | undefined;
-        browser?: string | undefined;
-        browserVersion?: string | undefined;
-    }[] | undefined;
-}>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 export type SetUpPercyInput = z.infer<typeof SetUpPercySchema>;
 export type RunTestsOnBrowserStackInput = z.infer<typeof RunTestsOnBrowserStackSchema>;
 export declare const RunPercyScanParamsShape: {
     projectName: z.ZodString;
     percyRunCommand: z.ZodOptional<z.ZodString>;
-    integrationType: z.ZodNativeEnum<typeof PercyIntegrationTypeEnum>;
+    integrationType: z.ZodEnum<typeof PercyIntegrationTypeEnum>;
 };
 export declare const FetchPercyChangesParamsShape: {
     project_name: z.ZodString;
 };
 export declare const ManagePercyBuildApprovalParamsShape: {
     buildId: z.ZodString;
-    action: z.ZodEnum<["approve", "unapprove", "reject"]>;
+    action: z.ZodEnum<{
+        approve: "approve";
+        unapprove: "unapprove";
+        reject: "reject";
+    }>;
 };

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

@@ -143,7 +143,7 @@ export async function simulatePercyChangeHandler(rawInput, config) {
         }
         if (Array.isArray(percyInstruction.content)) {
             percyInstruction.content = percyInstruction.content.map((item) => {
-                if (typeof item.text === "string") {
+                if (item.type === "text" && typeof item.text === "string") {
                     const updatedText = item.text
                         .replace(PERCY_REPLACE_REGEX, PERCY_SIMULATE_INSTRUCTION)
                         .replace(PERCY_VERIFICATION_REGEX, "");

package/dist/tools/testmanagement-utils/TCG-utils/types.d.ts

@@ -3,15 +3,7 @@ export declare const CreateTestCasesFromFileSchema: z.ZodObject<{
     documentId: z.ZodString;
     folderId: z.ZodString;
     projectReferenceId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    documentId: string;
-    folderId: string;
-    projectReferenceId: string;
-}, {
-    documentId: string;
-    folderId: string;
-    projectReferenceId: string;
-}>;
+}, z.core.$strip>;
 export type CreateTestCasesFromFileArgs = z.infer<typeof CreateTestCasesFromFileSchema>;
 export interface DefaultFieldMaps {
     priority: Record<string, number>;

package/dist/tools/testmanagement-utils/add-test-result.d.ts

@@ -10,31 +10,9 @@ export declare const AddTestResultSchema: z.ZodObject<{
     test_result: z.ZodObject<{
         status: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        status: string;
-        description?: string | undefined;
-    }, {
-        status: string;
-        description?: string | undefined;
-    }>;
+    }, z.core.$strip>;
     test_case_id: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    project_identifier: string;
-    test_run_id: string;
-    test_result: {
-        status: string;
-        description?: string | undefined;
-    };
-    test_case_id: string;
-}, {
-    project_identifier: string;
-    test_run_id: string;
-    test_result: {
-        status: string;
-        description?: string | undefined;
-    };
-    test_case_id: string;
-}>;
+}, z.core.$strip>;
 export type AddTestResultArgs = z.infer<typeof AddTestResultSchema>;
 /**
  * Adds a test result to a specific test run via BrowserStack Test Management API.