Feat: Integrate MCP Instrumentation tracking across various tools

Author: tech-sushant

src/index.ts

@@ -12,6 +12,7 @@ import addBrowserLiveTools from "./tools/live";
 import addAccessibilityTools from "./tools/accessibility";
 import addAutomateTools from "./tools/automate";
 import addTestManagementTools from "./tools/testmanagement";
+import { createCustomInitializeHandler } from "./lib/utils";
 
 function registerTools(server: McpServer) {
   addSDKTools(server);
@@ -31,6 +32,19 @@ const server: McpServer = new McpServer({
 
 registerTools(server);
 
+let clientName: string | undefined;
+
+function setClientName(name: string) {
+  clientName = name;
+}
+
+const origInitializeHandler =
+  server.server["_requestHandlers"].get("initialize");
+server.server["_requestHandlers"].set(
+  "initialize",
+  createCustomInitializeHandler(origInitializeHandler, logger, setClientName),
+);
+
 async function main() {
   logger.info(
     "Launching BrowserStack MCP server, version %s",
@@ -50,3 +64,5 @@ main().catch(console.error);
 process.on("exit", () => {
   logger.flush();
 });
+
+export { clientName };

src/lib/instrumentation.ts

@@ -0,0 +1,53 @@
+import logger from "../logger";
+import config from "../config";
+import packageJson from "../../package.json";
+import axios from "axios";
+import { clientName } from "../index";
+
+interface MCPEventPayload {
+  event_type: string;
+  event_properties: {
+    mcp_version: string;
+    tool_name: string;
+    mcp_client: string;
+  };
+}
+
+export function trackMCPEvent(toolName: string): void {
+  const instrumentationEndpoint = "https://api.browserstack.com/sdk/v1/event";
+  const mcpClient = clientName || "unknown";
+
+  const event: MCPEventPayload = {
+    event_type: "MCPInstrumentation",
+    event_properties: {
+      mcp_version: packageJson.version,
+      tool_name: toolName,
+      mcp_client: mcpClient,
+    },
+  };
+
+  axios
+    .post(instrumentationEndpoint, event, {
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Basic ${Buffer.from(
+          `${config.browserstackUsername}:${config.browserstackAccessKey}`,
+        ).toString("base64")}`,
+      },
+      timeout: 2000,
+    })
+    .then((response) => {
+      logger.info("MCP event tracked successfully", {
+        toolName,
+        response,
+      });
+    })
+    .catch((error: unknown) => {
+      logger.warn(
+        `Failed to track MCP event: ${error instanceof Error ? error.message : String(error)}`,
+        {
+          toolName,
+        },
+      );
+    });
+}

src/lib/utils.ts

@@ -24,3 +24,22 @@ export interface HarEntry {
   serverIPAddress?: string;
   time?: number;
 }
+
+export function createCustomInitializeHandler(
+  origHandler: (request: any, extra: any) => Promise<any>,
+  logger: any,
+  setClientName: (name: string) => void,
+) {
+  return async function (this: any, request: any, extra: any) {
+    const clientInfo = request.params.clientInfo;
+    if (clientInfo && clientInfo.name) {
+      setClientName(clientInfo.name);
+      logger.info(
+        `Client connected: ${clientInfo.name} (version: ${clientInfo.version})`,
+      );
+    } else {
+      logger.info("Client connected: unknown client");
+    }
+    return origHandler.call(this, request, extra);
+  };
+}

src/tools/accessibility.ts

@@ -5,6 +5,7 @@ import {
   startAccessibilityScan,
   AccessibilityScanResponse,
 } from "./accessiblity-utils/accessibility";
+import { trackMCPEvent } from "../lib/instrumentation";
 
 async function runAccessibilityScan(
   name: string,
@@ -55,6 +56,7 @@ export default function addAccessibilityTools(server: McpServer) {
       pageURL: z.string().describe("The URL to scan for accessibility issues"),
     },
     async (args) => {
+      trackMCPEvent("startAccessibilityScan")
       return runAccessibilityScan(args.name, args.pageURL);
     },
   );

src/tools/applive.ts

@@ -4,6 +4,7 @@ import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import fs from "fs";
 import { startSession } from "./applive-utils/start-session";
 import logger from "../logger";
+import { trackMCPEvent } from "../lib/instrumentation";
 
 /**
  * Launches an App Live Session on BrowserStack.
@@ -89,6 +90,7 @@ export default function addAppLiveTools(server: McpServer) {
     },
     async (args) => {
       try {
+        trackMCPEvent("runAppLiveSession");
         return startAppLiveSession(args);
       } catch (error) {
         return {

src/tools/automate.ts

@@ -3,6 +3,7 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import logger from "../logger";
 import { retrieveNetworkFailures } from "../lib/api";
+import { trackMCPEvent } from "../lib/instrumentation";
 
 /**
  * Fetches failed network requests from a BrowserStack Automate session.
@@ -57,6 +58,9 @@ export default function addAutomateTools(server: McpServer) {
     {
       sessionId: z.string().describe("The Automate session ID."),
     },
-    getNetworkFailures,
+    async (args) => {
+      trackMCPEvent("getNetworkFailures");
+      return getNetworkFailures(args);
+    },
   );
 }

src/tools/bstack-sdk.ts

@@ -10,6 +10,7 @@ import {
   generateBrowserStackYMLInstructions,
   getInstructionsForProjectConfiguration,
 } from "./sdk-utils/instructions";
+import { trackMCPEvent } from "../lib/instrumentation";
 
 /**
  * BrowserStack SDK hooks into your test framework to seamlessly run tests on BrowserStack.
@@ -80,6 +81,7 @@ export default function addSDKTools(server: McpServer) {
       const desiredPlatforms = args.desiredPlatforms;
 
       try {
+        trackMCPEvent("runTestsOnBrowserStack");
         return bootstrapProjectWithSDK({
           detectedBrowserAutomationFramework,
           detectedTestingFramework,

src/tools/live.ts

@@ -4,6 +4,7 @@ import { z } from "zod";
 import logger from "../logger";
 import { startBrowserSession } from "./live-utils/start-session";
 import { PlatformType } from "./live-utils/types";
+import { trackMCPEvent } from "../lib/instrumentation";
 
 // Define the schema shape
 const LiveArgsShape = {
@@ -118,6 +119,7 @@ export default function addBrowserLiveTools(server: McpServer) {
     LiveArgsShape,
     async (args) => {
       try {
+        trackMCPEvent("runBrowserLiveSession");
         const result = await runBrowserSession(args);
         return result;
       } catch (error: any) {

src/tools/observability.ts

@@ -2,6 +2,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { getLatestO11YBuildInfo } from "../lib/api";
+import { trackMCPEvent } from "../lib/instrumentation";
 
 export async function getFailuresInLastRun(
   buildName: string,
@@ -57,6 +58,7 @@ export default function addObservabilityTools(server: McpServer) {
     },
     async (args) => {
       try {
+        trackMCPEvent("getFailuresInLastRun");
         return getFailuresInLastRun(args.buildName, args.projectName);
       } catch (error) {
         return {

src/tools/testmanagement.ts

@@ -1,6 +1,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { trackMCPEvent } from "../lib/instrumentation";
 import {
   createProjectOrFolder,
   CreateProjFoldSchema,
@@ -19,6 +20,7 @@ export async function createProjectOrFolderTool(
   args: z.infer<typeof CreateProjFoldSchema>,
 ): Promise<CallToolResult> {
   try {
+    trackMCPEvent("createProjectOrFolder");
     return await createProjectOrFolder(args);
   } catch (err) {
     return {
@@ -45,6 +47,7 @@ export async function createTestCaseTool(
   // Sanitize input arguments
   const cleanedArgs = sanitizeArgs(args);
   try {
+    trackMCPEvent("createTestCase");
     return await createTestCaseAPI(cleanedArgs);
   } catch (err) {
     return {