@browserstack/mcp-server 1.0.14 → 1.0.15

package/dist/index.js

@@ -6,7 +6,6 @@ import "dotenv/config";
 import logger from "./logger.js";
 import addSDKTools from "./tools/bstack-sdk.js";
 import addAppLiveTools from "./tools/applive.js";
-import addObservabilityTools from "./tools/observability.js";
 import addBrowserLiveTools from "./tools/live.js";
 import addAccessibilityTools from "./tools/accessibility.js";
 import addTestManagementTools from "./tools/testmanagement.js";
@@ -18,7 +17,6 @@ function registerTools(server) {
     addSDKTools(server);
     addAppLiveTools(server);
     addBrowserLiveTools(server);
-    addObservabilityTools(server);
     addAccessibilityTools(server);
     addTestManagementTools(server);
     addAppAutomationTools(server);

package/dist/tools/accessibility.js

@@ -1,30 +1,63 @@
 import { z } from "zod";
-import { startAccessibilityScan, } from "./accessiblity-utils/accessibility.js";
+import { AccessibilityScanner } from "./accessiblity-utils/scanner.js";
+import { AccessibilityReportFetcher } from "./accessiblity-utils/report-fetcher.js";
 import { trackMCP } from "../lib/instrumentation.js";
-async function runAccessibilityScan(name, pageURL) {
-    const response = await startAccessibilityScan(name, [pageURL]);
-    const scanId = response.data?.id;
-    const scanRunId = response.data?.scanRunId;
-    if (!scanId || !scanRunId) {
-        throw new Error("Unable to start a accessibility scan, please try again later or open an issue on GitHub if the problem persists");
+import { parseAccessibilityReportFromCSV } from "./accessiblity-utils/report-parser.js";
+const scanner = new AccessibilityScanner();
+const reportFetcher = new AccessibilityReportFetcher();
+async function runAccessibilityScan(name, pageURL, context) {
+    // Start scan
+    const startResp = await scanner.startScan(name, [pageURL]);
+    const scanId = startResp.data.id;
+    const scanRunId = startResp.data.scanRunId;
+    // Notify scan start
+    await context.sendNotification({
+        method: "notifications/progress",
+        params: {
+            progressToken: context._meta?.progressToken ?? "NOT_FOUND",
+            message: `Accessibility scan "${name}" started`,
+            progress: 0,
+            total: 100,
+        },
+    });
+    // Wait until scan completes
+    const status = await scanner.waitUntilComplete(scanId, scanRunId, context);
+    if (status !== "completed") {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ Accessibility scan "${name}" failed with status: ${status} , check the BrowserStack dashboard for more details [https://scanner.browserstack.com/site-scanner/scan-details/${name}].`,
+                    isError: true,
+                },
+            ],
+            isError: true,
+        };
     }
+    // Fetch CSV report link
+    const reportLink = await reportFetcher.getReportLink(scanId, scanRunId);
+    const { records } = await parseAccessibilityReportFromCSV(reportLink);
     return {
         content: [
             {
                 type: "text",
-                text: `Successfully queued accessibility scan, you will get a report via email within 5 minutes.`,
+                text: `✅ Accessibility scan "${name}" completed. check the BrowserStack dashboard for more details [https://scanner.browserstack.com/site-scanner/scan-details/${name}].`,
+            },
+            {
+                type: "text",
+                text: `Scan results: ${JSON.stringify(records, null, 2)}`,
             },
         ],
     };
 }
 export default function addAccessibilityTools(server) {
-    server.tool("startAccessibilityScan", "Use this tool to start an accessibility scan for a list of URLs on BrowserStack.", {
+    server.tool("startAccessibilityScan", "Start an accessibility scan via BrowserStack and retrieve a local CSV report path.", {
         name: z.string().describe("Name of the accessibility scan"),
         pageURL: z.string().describe("The URL to scan for accessibility issues"),
-    }, async (args) => {
+    }, async (args, context) => {
         try {
             trackMCP("startAccessibilityScan", server.server.getClientVersion());
-            return await runAccessibilityScan(args.name, args.pageURL);
+            return await runAccessibilityScan(args.name, args.pageURL, context);
         }
         catch (error) {
             trackMCP("startAccessibilityScan", server.server.getClientVersion(), error);

package/dist/tools/accessiblity-utils/report-fetcher.js

@@ -0,0 +1,28 @@
+import axios from "axios";
+import config from "../../config.js";
+export class AccessibilityReportFetcher {
+    auth = {
+        username: config.browserstackUsername,
+        password: config.browserstackAccessKey,
+    };
+    async getReportLink(scanId, scanRunId) {
+        // Initiate CSV link generation
+        const initUrl = `https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/issues?scan_run_id=${scanRunId}`;
+        const initResp = await axios.get(initUrl, {
+            auth: this.auth,
+        });
+        if (!initResp.data.success) {
+            throw new Error(`Failed to initiate report: ${initResp.data.error || initResp.data.data.message}`);
+        }
+        const taskId = initResp.data.data.task_id;
+        // Fetch the generated CSV link
+        const reportUrl = `https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/issues?task_id=${encodeURIComponent(taskId)}`;
+        const reportResp = await axios.get(reportUrl, {
+            auth: this.auth,
+        });
+        if (!reportResp.data.success) {
+            throw new Error(`Failed to fetch report: ${reportResp.data.error}`);
+        }
+        return reportResp.data.data.reportLink;
+    }
+}

package/dist/tools/accessiblity-utils/report-parser.js

@@ -0,0 +1,51 @@
+import fetch from "node-fetch";
+import { parse } from "csv-parse/sync";
+export async function parseAccessibilityReportFromCSV(reportLink, { maxCharacterLength = 10_000, nextPage = 0 } = {}) {
+    // 1) Download & parse
+    const res = await fetch(reportLink);
+    if (!res.ok)
+        throw new Error(`Failed to download report: ${res.statusText}`);
+    const text = await res.text();
+    const all = parse(text, {
+        columns: true,
+        skip_empty_lines: true,
+    }).map((row) => ({
+        issue_type: row["Issue type"],
+        component: row["Component"],
+        issue_description: row["Issue description"],
+        HTML_snippet: row["HTML snippet"],
+        how_to_fix: row["How to fix this issue"],
+        severity: (row["Severity"] || "unknown").trim(),
+    }));
+    // 2) Sort by severity
+    const order = {
+        critical: 0,
+        serious: 1,
+        moderate: 2,
+        minor: 3,
+    };
+    all.sort((a, b) => (order[a.severity] ?? 99) - (order[b.severity] ?? 99));
+    // 3) Walk to the starting offset
+    let charCursor = 0;
+    let idx = 0;
+    for (; idx < all.length; idx++) {
+        const len = JSON.stringify(all[idx]).length;
+        if (charCursor + len > nextPage)
+            break;
+        charCursor += len;
+    }
+    // 4) Collect up to maxCharacterLength
+    const page = [];
+    for (let i = idx; i < all.length; i++) {
+        const recStr = JSON.stringify(all[i]);
+        if (charCursor - nextPage + recStr.length > maxCharacterLength)
+            break;
+        page.push(all[i]);
+        charCursor += recStr.length;
+    }
+    const hasMore = idx + page.length < all.length;
+    return {
+        records: page,
+        next_page: hasMore ? charCursor : null,
+    };
+}

package/dist/tools/accessiblity-utils/scanner.js

@@ -0,0 +1,80 @@
+import axios from "axios";
+import config from "../../config.js";
+export class AccessibilityScanner {
+    auth = {
+        username: config.browserstackUsername,
+        password: config.browserstackAccessKey,
+    };
+    async startScan(name, urlList) {
+        try {
+            const { data } = await axios.post("https://api-accessibility.browserstack.com/api/website-scanner/v1/scans", { name, urlList, recurring: false }, { auth: this.auth });
+            if (!data.success)
+                throw new Error(`Unable to start scan: ${data.errors?.join(", ")}`);
+            return data;
+        }
+        catch (err) {
+            if (axios.isAxiosError(err) && err.response?.data) {
+                const msg = err.response.data.error ||
+                    err.response.data.message ||
+                    err.message;
+                throw new Error(`Failed to start scan: ${msg}`);
+            }
+            throw err;
+        }
+    }
+    async pollStatus(scanId, scanRunId) {
+        try {
+            const { data } = await axios.get(`https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/${scanRunId}/status`, { auth: this.auth });
+            if (!data.success)
+                throw new Error(`Failed to get status: ${data.errors?.join(", ")}`);
+            return data;
+        }
+        catch (err) {
+            if (axios.isAxiosError(err) && err.response?.data) {
+                const msg = err.response.data.message || err.message;
+                throw new Error(`Failed to get scan status: ${msg}`);
+            }
+            throw err;
+        }
+    }
+    async waitUntilComplete(scanId, scanRunId, context) {
+        return new Promise((resolve, reject) => {
+            let timepercent = 0;
+            let dotCount = 1;
+            const interval = setInterval(async () => {
+                try {
+                    const statusResp = await this.pollStatus(scanId, scanRunId);
+                    const status = statusResp.data.status;
+                    timepercent += 1.67;
+                    const progress = status === "completed" ? 100 : timepercent;
+                    const dots = ".".repeat(dotCount);
+                    dotCount = (dotCount % 4) + 1;
+                    const message = status === "completed" || status === "failed"
+                        ? `Scan completed with status: ${status}`
+                        : `Scan in progress${dots}`;
+                    await context.sendNotification({
+                        method: "notifications/progress",
+                        params: {
+                            progressToken: context._meta?.progressToken ?? "NOT_FOUND",
+                            message: message,
+                            progress: progress,
+                            total: 100,
+                        },
+                    });
+                    if (status === "completed" || status === "failed") {
+                        clearInterval(interval);
+                        resolve(status);
+                    }
+                }
+                catch (e) {
+                    clearInterval(interval);
+                    reject(e);
+                }
+            }, 5000);
+            setTimeout(() => {
+                clearInterval(interval);
+                reject(new Error("Scan timed out after 5 minutes"));
+            }, 5 * 60 * 1000);
+        });
+    }
+}

package/dist/tools/testmanagement.js

@@ -175,13 +175,13 @@ export async function addTestResultTool(args) {
 /**
  * Uploads files such as PDRs or screenshots to BrowserStack Test Management and get file mapping ID back.
  */
-export async function uploadFileTestManagementTool(args) {
+export async function uploadProductRequirementFileTool(args) {
     try {
-        trackMCP("uploadFileTestManagement", serverInstance.server.getClientVersion());
+        trackMCP("uploadProductRequirementFile", serverInstance.server.getClientVersion());
         return await uploadFile(args);
     }
     catch (err) {
-        trackMCP("uploadFileTestManagement", serverInstance.server.getClientVersion(), err);
+        trackMCP("uploadProductRequirementFile", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -228,6 +228,6 @@ export default function addTestManagementTools(server) {
     server.tool("listTestRuns", "List test runs in a project with optional filters (date ranges, assignee, state, etc.)", ListTestRunsSchema.shape, listTestRunsTool);
     server.tool("updateTestRun", "Update a test run in BrowserStack Test Management.", UpdateTestRunSchema.shape, updateTestRunTool);
     server.tool("addTestResult", "Add a test result to a specific test run via BrowserStack Test Management API.", AddTestResultSchema.shape, addTestResultTool);
-    server.tool("uploadFileTestManagement", "Upload files such as PDRs or PDFs to BrowserStack Test Management and get file mapping ID back. Its Used for generating test cases from file.", UploadFileSchema.shape, uploadFileTestManagementTool);
+    server.tool("uploadProductRequirementFile", "Upload files such as PDRs or PDFs to BrowserStack Test Management and get file mapping ID back. Its Used for generating test cases from file.", UploadFileSchema.shape, uploadProductRequirementFileTool);
     server.tool("createTestCasesFromFile", "Create test cases from a file in BrowserStack Test Management.", CreateTestCasesFromFileSchema.shape, createTestCasesFromFileTool);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "BrowserStack's Official MCP Server",
   "main": "dist/index.js",
   "repository": {
@@ -34,10 +34,11 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.10.1",
+    "@modelcontextprotocol/sdk": "^1.11.4",
     "@types/form-data": "^2.5.2",
     "axios": "^1.8.4",
     "browserstack-local": "^1.5.6",
+    "csv-parse": "^5.6.0",
     "dotenv": "^16.5.0",
     "form-data": "^4.0.2",
     "pino": "^9.6.0",
@@ -49,6 +50,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.25.0",
+    "@types/csv-parse": "^1.1.12",
     "@types/node": "^22.14.1",
     "@types/uuid": "^10.0.0",
     "eslint": "^9.25.0",

package/dist/tools/accessiblity-utils/accessibility.js

@@ -1,74 +0,0 @@
-import axios from "axios";
-import config from "../../config.js";
-import { AxiosError } from "axios";
-export async function startAccessibilityScan(name, urlList) {
-    try {
-        const response = await axios.post("https://api-accessibility.browserstack.com/api/website-scanner/v1/scans", {
-            name,
-            urlList,
-            recurring: false,
-        }, {
-            auth: {
-                username: config.browserstackUsername,
-                password: config.browserstackAccessKey,
-            },
-        });
-        if (!response.data.success) {
-            throw new Error(`Unable to create an accessibility scan: ${response.data.errors?.join(", ")}`);
-        }
-        return response.data;
-    }
-    catch (error) {
-        if (error instanceof AxiosError) {
-            if (error.response?.data?.error) {
-                throw new Error(`Failed to start accessibility scan: ${error.response?.data?.error}`);
-            }
-            else {
-                throw new Error(`Failed to start accessibility scan: ${error.response?.data?.message || error.message}`);
-            }
-        }
-        throw error;
-    }
-}
-export async function pollScanStatus(scanId, scanRunId) {
-    try {
-        const response = await axios.get(`https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/${scanId}/scan_runs/${scanRunId}/status`, {
-            auth: {
-                username: config.browserstackUsername,
-                password: config.browserstackAccessKey,
-            },
-        });
-        if (!response.data.success) {
-            throw new Error(`Failed to get scan status: ${response.data.errors?.join(", ")}`);
-        }
-        return response.data.data?.status || "unknown";
-    }
-    catch (error) {
-        if (error instanceof AxiosError) {
-            throw new Error(`Failed to get scan status: ${error.response?.data?.message || error.message}`);
-        }
-        throw error;
-    }
-}
-export async function waitUntilScanComplete(scanId, scanRunId) {
-    return new Promise((resolve, reject) => {
-        const interval = setInterval(async () => {
-            try {
-                const status = await pollScanStatus(scanId, scanRunId);
-                if (status === "completed") {
-                    clearInterval(interval);
-                    resolve();
-                }
-            }
-            catch (error) {
-                clearInterval(interval);
-                reject(error);
-            }
-        }, 5000); // Poll every 5 seconds
-        // Set a timeout of 5 minutes
-        setTimeout(() => {
-            clearInterval(interval);
-            reject(new Error("Scan timed out after 5 minutes"));
-        }, 5 * 60 * 1000);
-    });
-}