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

package/dist/tools/appautomate.js

@@ -4,14 +4,13 @@ import { getBrowserStackAuth } from "../lib/get-auth.js";
 import { trackMCP } from "../lib/instrumentation.js";
 import { maybeCompressBase64 } from "../lib/utils.js";
 import { remote } from "webdriverio";
-import { AppTestPlatform } from "./appautomate-utils/types.js";
+import { AppTestPlatform } from "./appautomate-utils/native-execution/types.js";
+import { setupAppAutomateHandler } from "./appautomate-utils/appium-sdk/handler.js";
+import { SETUP_APP_AUTOMATE_DESCRIPTION, SETUP_APP_AUTOMATE_SCHEMA, } from "./appautomate-utils/appium-sdk/constants.js";
+import { Platform, } from "./appautomate-utils/native-execution/types.js";
 import { getDevicesAndBrowsers, BrowserStackProducts, } from "../lib/device-cache.js";
-import { findMatchingDevice, getDeviceVersions, resolveVersion, validateArgs, uploadApp, uploadEspressoApp, uploadEspressoTestSuite, triggerEspressoBuild, uploadXcuiApp, uploadXcuiTestSuite, triggerXcuiBuild, } from "./appautomate-utils/appautomate.js";
-var Platform;
-(function (Platform) {
-    Platform["ANDROID"] = "android";
-    Platform["IOS"] = "ios";
-})(Platform || (Platform = {}));
+import { findMatchingDevice, getDeviceVersions, resolveVersion, validateArgs, uploadApp, uploadEspressoApp, uploadEspressoTestSuite, triggerEspressoBuild, uploadXcuiApp, uploadXcuiTestSuite, triggerXcuiBuild, } from "./appautomate-utils/native-execution/appautomate.js";
+import { RUN_APP_AUTOMATE_DESCRIPTION, RUN_APP_AUTOMATE_SCHEMA, } from "./appautomate-utils/native-execution/constants.js";
 /**
  * Launches an app on a selected BrowserStack device and takes a screenshot.
  */
@@ -214,39 +213,7 @@ export default function addAppAutomationTools(server, config) {
             };
         }
     });
-    tools.runAppTestsOnBrowserStack = server.tool("runAppTestsOnBrowserStack", "Run AppAutomate tests on BrowserStack by uploading app and test suite. If running from Android Studio or Xcode, the tool will help export app and test files automatically. For other environments, you'll need to provide the paths to your pre-built app and test files.", {
-        appPath: z
-            .string()
-            .describe("Path to your application file:\n" +
-            "If in development IDE directory:\n" +
-            "• For Android: 'gradle assembleDebug'\n" +
-            "• For iOS:\n" +
-            "  xcodebuild clean -scheme YOUR_SCHEME && \\\n" +
-            "  xcodebuild archive -scheme YOUR_SCHEME -configuration Release -archivePath build/app.xcarchive && \\\n" +
-            "  xcodebuild -exportArchive -archivePath build/app.xcarchive -exportPath build/ipa -exportOptionsPlist exportOptions.plist\n\n" +
-            "If in other directory, provide existing app path"),
-        testSuitePath: z
-            .string()
-            .describe("Path to your test suite file:\n" +
-            "If in development IDE directory:\n" +
-            "• For Android: 'gradle assembleAndroidTest'\n" +
-            "• For iOS:\n" +
-            "  xcodebuild test-without-building -scheme YOUR_SCHEME -destination 'generic/platform=iOS' && \\\n" +
-            "  cd ~/Library/Developer/Xcode/DerivedData/*/Build/Products/Debug-iphonesimulator/ && \\\n" +
-            "  zip -r Tests.zip *.xctestrun *-Runner.app\n\n" +
-            "If in other directory, provide existing test file path"),
-        devices: z
-            .array(z.string())
-            .describe("List of devices to run the test on, e.g., ['Samsung Galaxy S20-10.0', 'iPhone 12 Pro-16.0']."),
-        project: z
-            .string()
-            .optional()
-            .default("BStack-AppAutomate-Suite")
-            .describe("Project name for organizing test runs on BrowserStack."),
-        detectedAutomationFramework: z
-            .string()
-            .describe("The automation framework used in the project, such as 'espresso' (Android) or 'xcuitest' (iOS)."),
-    }, async (args) => {
+    tools.runAppTestsOnBrowserStack = server.tool("runAppTestsOnBrowserStack", RUN_APP_AUTOMATE_DESCRIPTION, RUN_APP_AUTOMATE_SCHEMA, async (args) => {
         try {
             trackMCP("runAppTestsOnBrowserStack", server.server.getClientVersion(), undefined, config);
             return await runAppTestsOnBrowserStack(args, config);
@@ -265,5 +232,23 @@ export default function addAppAutomationTools(server, config) {
             };
         }
     });
+    tools.setupBrowserStackAppAutomateTests = server.tool("setupBrowserStackAppAutomateTests", SETUP_APP_AUTOMATE_DESCRIPTION, SETUP_APP_AUTOMATE_SCHEMA, async (args) => {
+        try {
+            return await setupAppAutomateHandler(args, config);
+        }
+        catch (error) {
+            const error_message = error instanceof Error ? error.message : "Unknown error";
+            return {
+                content: [
+                    {
+                        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,
+            };
+        }
+    });
     return tools;
 }

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

@@ -311,6 +311,12 @@ Add new scripts to package.json for running tests on BrowserStack:
 }
 \`\`\`
 
+Example : 
+\`\`\`json
+"scripts": {
+  "test:browserstack": "npx browserstack-node-sdk playwright test"
+}
+\`\`\`
 ---STEP---
 
 Export BrowserStack credentials as environment variables:
@@ -319,6 +325,10 @@ Set the following environment variables before running tests.
 export BROWSERSTACK_USERNAME=${username}
 export BROWSERSTACK_ACCESS_KEY=${accessKey}
 \`\`\`
+
+---STEP---
+Run your tests:
+You can now run your tests on BrowserStack using your standard command or Use the commands defined in your package.json file to run the tests.
 `;
 /**
  * ---------- EXPORT CONFIG ----------

package/package.json

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

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

@@ -1,5 +0,0 @@
-export declare enum AppTestPlatform {
-    ESPRESSO = "espresso",
-    APPIUM = "appium",
-    XCUITEST = "xcuitest"
-}