Merge branch 'main' into bstack-sdk

Author: tech-sushant

README.md

@@ -138,6 +138,8 @@ Generate test cases from PRDs, convert manual tests to low-code automation, and
 
 ## 🛠️ Installation
 
+[![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)
+
 1. **Create a BrowserStack Account**
 
    - Sign up for [BrowserStack](https://www.browserstack.com/users/sign_up) if you don't have an account already.

package-lock.json

@@ -50,3 +50,4 @@ process.on("exit", () => {
 
 export { setLogger } from "./logger.js";
 export { BrowserStackMcpServer } from "./server-factory.js";
+export { trackMCP } from "./lib/instrumentation.js";

src/index.ts

@@ -2,10 +2,12 @@ import fs from "fs";
 import os from "os";
 import path from "path";
 import { apiClient } from "./apiClient.js";
+import config from "../config.js";
 
 const CACHE_DIR = path.join(os.homedir(), ".browserstack", "combined_cache");
 const CACHE_FILE = path.join(CACHE_DIR, "data.json");
 const TTL_MS = 24 * 60 * 60 * 1000; // 1 day
+const TTL_STARTED_MS = 3 * 60 * 60 * 1000; // 3 Hours
 
 export enum BrowserStackProducts {
   LIVE = "live",
@@ -64,3 +66,29 @@ export async function getDevicesAndBrowsers(
 
   return cache[type];
 }
+
+// Rate limiter for started event (3H)
+export function shouldSendStartedEvent(): boolean {
+  try {
+    if (config && config.REMOTE_MCP) {
+      return false;
+    }
+    if (!fs.existsSync(CACHE_DIR)) {
+      fs.mkdirSync(CACHE_DIR, { recursive: true });
+    }
+    let cache: Record<string, any> = {};
+    if (fs.existsSync(CACHE_FILE)) {
+      const raw = fs.readFileSync(CACHE_FILE, "utf8");
+      cache = JSON.parse(raw || "{}");
+      const last = parseInt(cache.lastStartedEvent, 10);
+      if (!isNaN(last) && Date.now() - last < TTL_STARTED_MS) {
+        return false;
+      }
+    }
+    cache.lastStartedEvent = Date.now();
+    fs.writeFileSync(CACHE_FILE, JSON.stringify(cache, null, 2), "utf8");
+    return true;
+  } catch {
+    return true;
+  }
+}

src/lib/device-cache.ts

@@ -1,5 +1,6 @@
 import { trackMCP } from "./lib/instrumentation.js";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { shouldSendStartedEvent } from "./lib/device-cache.js";
 
 export function setupOnInitialized(server: McpServer, config?: any) {
   const nodeVersion = process.versions.node;
@@ -12,6 +13,8 @@ export function setupOnInitialized(server: McpServer, config?: any) {
   }
 
   server.server.oninitialized = () => {
-    trackMCP("started", server.server.getClientVersion()!, undefined, config);
+    if (shouldSendStartedEvent()) {
+      trackMCP("started", server.server.getClientVersion()!, undefined, config);
+    }
   };
 }

src/oninitialized.ts

@@ -90,11 +90,17 @@ export function resolveVersion(
 export function validateArgs(args: {
   desiredPlatform: string;
   desiredPlatformVersion: string;
-  appPath: string;
+  appPath?: string;
   desiredPhone: string;
+  browserstackAppUrl?: string;
 }): void {
-  const { desiredPlatform, desiredPlatformVersion, appPath, desiredPhone } =
-    args;
+  const {
+    desiredPlatform,
+    desiredPlatformVersion,
+    appPath,
+    desiredPhone,
+    browserstackAppUrl,
+  } = args;
 
   if (!desiredPlatform || !desiredPhone) {
     throw new Error(
@@ -108,16 +114,19 @@ export function validateArgs(args: {
     );
   }
 
-  if (!appPath) {
-    throw new Error("You must provide an appPath.");
+  if (!appPath && !browserstackAppUrl) {
+    throw new Error("Either appPath or browserstackAppUrl must be provided");
   }
 
-  if (desiredPlatform === "android" && !appPath.endsWith(".apk")) {
-    throw new Error("You must provide a valid Android app path (.apk).");
-  }
+  // Only validate app path format if appPath is provided
+  if (appPath) {
+    if (desiredPlatform === "android" && !appPath.endsWith(".apk")) {
+      throw new Error("You must provide a valid Android app path (.apk).");
+    }
 
-  if (desiredPlatform === "ios" && !appPath.endsWith(".ipa")) {
-    throw new Error("You must provide a valid iOS app path (.ipa).");
+    if (desiredPlatform === "ios" && !appPath.endsWith(".ipa")) {
+      throw new Error("You must provide a valid iOS app path (.ipa).");
+    }
   }
 }