Merge branch 'browserstack:main' into main

Author: ruturaj-browserstack

README.md

@@ -84,6 +84,28 @@ Use the following prompts to run/debug/fix your **automated tests** on BrowserSt
 - Run tests written in Jest, Playwright, Selenium, and more on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform)
 - **Accessibility Testing**: Ensure WCAG and ADA compliance with our [Accessibility Testing](https://www.browserstack.com/accessibility-testing) tool
 
+
+### 📋 Test Management 
+
+Use the following prompts to utilise capabilities of BrowserStack's [Test Management](https://www.browserstack.com/test-management) with MCP server.
+
+```bash
+# Create project & folder structure
+"create new Test management project named My Demo Project with two sub folders - Login & Checkout"
+
+# Add test cases
+"add invalid login test case in Test Management project named My Demo Project"
+
+# List added test cases 
+"list high priority Login test cases from Test Management project - My Demo Project"
+
+# Create test run
+"create a test run for Login tests from Test Management project - My Demo Project"
+
+# Update test results
+"update test results as passed for Login tests test run from My Demo Project"
+```
+
 ## 🛠️ Installation
 
 1. **Create a BrowserStack Account**

package-lock.json

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

package.json

@@ -18,7 +18,7 @@ export class Config {
 const config = new Config(
   process.env.BROWSERSTACK_USERNAME!,
   process.env.BROWSERSTACK_ACCESS_KEY!,
-  process.env.DEV_MODE === "true"
+  process.env.DEV_MODE === "true",
 );
 
 export default config;

src/config.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 { trackMCP } from "./lib/instrumentation";
 
 function registerTools(server: McpServer) {
   addSDKTools(server);
@@ -42,6 +43,7 @@ async function main() {
   await server.connect(transport);
 
   logger.info("MCP server started successfully");
+  trackMCP("started", server.server.getClientVersion()!);
 }
 
 main().catch(console.error);

src/index.ts

@@ -20,7 +20,6 @@ export function trackMCP(
   clientInfo: { name?: string; version?: string },
   error?: unknown,
 ): void {
-  
   if (config.DEV_MODE) {
     logger.info("Tracking MCP is disabled in dev mode");
     return;

src/lib/instrumentation.ts

@@ -0,0 +1,75 @@
+import axios from "axios";
+import config from "../../config";
+import { z } from "zod";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { formatAxiosError } from "../../lib/error";
+
+/**
+ * Schema for adding a test result to a test run.
+ */
+export const AddTestResultSchema = z.object({
+  project_identifier: z
+    .string()
+    .describe("Identifier of the project (e.g., PR-12345)"),
+  test_run_id: z.string().describe("Identifier of the test run (e.g., TR-678)"),
+  test_result: z.object({
+    status: z
+      .string()
+      .describe("Status of the test result, e.g., 'passed', 'failed'."),
+    description: z
+      .string()
+      .optional()
+      .describe("Optional description of the test result."),
+  }),
+  test_case_id: z
+    .string()
+    .describe("Identifier of the test case, e.g., 'TC-13'."),
+});
+
+export type AddTestResultArgs = z.infer<typeof AddTestResultSchema>;
+
+/**
+ * Adds a test result to a specific test run via BrowserStack Test Management API.
+ */
+export async function addTestResult(
+  rawArgs: AddTestResultArgs,
+): Promise<CallToolResult> {
+  try {
+    const args = AddTestResultSchema.parse(rawArgs);
+    const url = `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(
+      args.project_identifier,
+    )}/test-runs/${encodeURIComponent(args.test_run_id)}/results`;
+
+    const body = {
+      test_result: args.test_result,
+      test_case_id: args.test_case_id,
+    } as any;
+
+    const response = await axios.post(url, body, {
+      auth: {
+        username: config.browserstackUsername,
+        password: config.browserstackAccessKey,
+      },
+      headers: { "Content-Type": "application/json" },
+    });
+
+    const data = response.data;
+    if (!data.success) {
+      throw new Error(
+        `API returned unsuccessful response: ${JSON.stringify(data)}`,
+      );
+    }
+
+    return {
+      content: [
+        {
+          type: "text",
+          text: `Successfully added test result with ID=${data["test-result"].id}`,
+        },
+        { type: "text", text: JSON.stringify(data["test-result"], null, 2) },
+      ],
+    };
+  } catch (err: any) {
+    return formatAxiosError(err, "Failed to add test result to test run");
+  }
+}

src/tools/testmanagement-utils/add-test-result.ts

@@ -14,7 +14,6 @@ import {
   CreateTestCaseSchema,
 } from "./testmanagement-utils/create-testcase";
 
-
 let serverInstance: McpServer;
 
 import {
@@ -37,8 +36,10 @@ import {
   updateTestRun,
 } from "./testmanagement-utils/update-testrun";
 
-
-//TODO: Moving the traceMCP and catch block to the parent(server) function
+import {
+  addTestResult,
+  AddTestResultSchema,
+} from "./testmanagement-utils/add-test-result";
 
 /**
  * Wrapper to call createProjectOrFolder util.
@@ -111,8 +112,10 @@ export async function listTestCasesTool(
   args: z.infer<typeof ListTestCasesSchema>,
 ): Promise<CallToolResult> {
   try {
+    trackMCP("listTestCases", serverInstance.server.getClientVersion()!);
     return await listTestCases(args);
   } catch (err) {
+    trackMCP("listTestCases", serverInstance.server.getClientVersion()!, err);
     return {
       content: [
         {
@@ -135,8 +138,10 @@ export async function createTestRunTool(
   args: z.infer<typeof CreateTestRunSchema>,
 ): Promise<CallToolResult> {
   try {
+    trackMCP("createTestRun", serverInstance.server.getClientVersion()!);
     return await createTestRun(args);
   } catch (err) {
+    trackMCP("createTestRun", serverInstance.server.getClientVersion()!, err);
     return {
       content: [
         {
@@ -159,8 +164,10 @@ export async function listTestRunsTool(
   args: z.infer<typeof ListTestRunsSchema>,
 ): Promise<CallToolResult> {
   try {
+    trackMCP("listTestRuns", serverInstance.server.getClientVersion()!);
     return await listTestRuns(args);
   } catch (err) {
+    trackMCP("listTestRuns", serverInstance.server.getClientVersion()!, err);
     return {
       content: [
         {
@@ -185,8 +192,10 @@ export async function updateTestRunTool(
   args: z.infer<typeof UpdateTestRunSchema>,
 ): Promise<CallToolResult> {
   try {
+    trackMCP("updateTestRun", serverInstance.server.getClientVersion()!);
     return await updateTestRun(args);
   } catch (err) {
+    trackMCP("updateTestRun", serverInstance.server.getClientVersion()!, err);
     return {
       content: [
         {
@@ -202,6 +211,32 @@ export async function updateTestRunTool(
   }
 }
 
+/**
+ * Adds a test result to a specific test run via BrowserStack Test Management API.
+ */
+export async function addTestResultTool(
+  args: z.infer<typeof AddTestResultSchema>,
+): Promise<CallToolResult> {
+  try {
+    trackMCP("addTestResult", serverInstance.server.getClientVersion()!);
+    return await addTestResult(args);
+  } catch (err) {
+    trackMCP("addTestResult", serverInstance.server.getClientVersion()!, err);
+    return {
+      content: [
+        {
+          type: "text",
+          text: `Failed to add test result: ${
+            err instanceof Error ? err.message : "Unknown error"
+          }. Please open an issue on GitHub if the problem persists`,
+          isError: true,
+        },
+      ],
+      isError: true,
+    };
+  }
+}
+
 /**
  * Registers both project/folder and test-case tools.
  */
@@ -247,4 +282,10 @@ export default function addTestManagementTools(server: McpServer) {
     UpdateTestRunSchema.shape,
     updateTestRunTool,
   );
+  server.tool(
+    "addTestResult",
+    "Add a test result to a specific test run via BrowserStack Test Management API.",
+    AddTestResultSchema.shape,
+    addTestResultTool,
+  );
 }