@browserstack/mcp-server 1.0.13 → 1.0.14

package/dist/tools/testmanagement-utils/upload-file.js

@@ -0,0 +1,101 @@
+import { z } from "zod";
+import axios from "axios";
+import FormData from "form-data";
+import fs from "fs";
+import path from "path";
+import { v4 as uuidv4 } from "uuid";
+import config from "../../config.js";
+import { signedUrlMap } from "../../lib/inmemory-store.js";
+import { projectIdentifierToId } from "./TCG-utils/api.js";
+/**
+ * Schema for the upload file tool
+ */
+export const UploadFileSchema = z.object({
+    project_identifier: z
+        .string()
+        .describe("ID of the project where the file should be uploaded. Do not assume it, always ask user for it."),
+    file_path: z
+        .string()
+        .describe("Full path to the file that should be uploaded"),
+});
+/**
+ * Uploads a file to BrowserStack Test Management and returns the signed URL.
+ */
+export async function uploadFile(args) {
+    const { project_identifier, file_path } = args;
+    try {
+        // Validate file exists
+        if (!fs.existsSync(file_path)) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `File ${file_path} does not exist.`,
+                        isError: true,
+                    },
+                ],
+                isError: true,
+            };
+        }
+        // Get the project ID
+        const projectIdResponse = await projectIdentifierToId(project_identifier);
+        const formData = new FormData();
+        formData.append("attachments[]", fs.createReadStream(file_path));
+        const uploadUrl = `https://test-management.browserstack.com/api/v1/projects/${projectIdResponse}/generic/attachments/ai_uploads`;
+        const response = await axios.post(uploadUrl, formData, {
+            headers: {
+                ...formData.getHeaders(),
+                "API-TOKEN": `${config.browserstackUsername}:${config.browserstackAccessKey}`,
+                accept: "application/json, text/plain, */*",
+            },
+        });
+        if (response.status >= 200 &&
+            response.status < 300 &&
+            response.data.generic_attachment) {
+            const attachments = response.data.generic_attachment.map((attachment) => {
+                // Generate a unique ID for each attachment
+                const fileId = uuidv4();
+                // Store the download URL in the signedUrlMap
+                const data = {
+                    fileId: attachment.id,
+                    downloadUrl: attachment.download_url,
+                };
+                signedUrlMap.set(fileId, data);
+                return {
+                    name: attachment.name,
+                    documentID: fileId,
+                    contentType: attachment.content_type,
+                    size: attachment.size,
+                    projectReferenceId: projectIdResponse,
+                };
+            });
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully uploaded ${path.basename(file_path)} to BrowserStack Test Management.`,
+                    },
+                    {
+                        type: "text",
+                        text: JSON.stringify(attachments, null, 2),
+                    },
+                ],
+            };
+        }
+        else {
+            throw new Error(`Unexpected response: ${JSON.stringify(response.data)}`);
+        }
+    }
+    catch (error) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Failed to upload file: ${error instanceof Error ? error.message : "Unknown error"}. Please check your credentials and try again.`,
+                    isError: true,
+                },
+            ],
+            isError: true,
+        };
+    }
+}

package/dist/tools/testmanagement.js

@@ -1,37 +1,28 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProjectOrFolderTool = createProjectOrFolderTool;
-exports.createTestCaseTool = createTestCaseTool;
-exports.listTestCasesTool = listTestCasesTool;
-exports.createTestRunTool = createTestRunTool;
-exports.listTestRunsTool = listTestRunsTool;
-exports.updateTestRunTool = updateTestRunTool;
-exports.addTestResultTool = addTestResultTool;
-exports.default = addTestManagementTools;
-const instrumentation_1 = require("../lib/instrumentation");
-const logger_1 = __importDefault(require("../logger"));
-const create_project_folder_1 = require("./testmanagement-utils/create-project-folder");
-const create_testcase_1 = require("./testmanagement-utils/create-testcase");
+import { trackMCP } from "../lib/instrumentation.js";
+import logger from "../logger.js";
+import { createProjectOrFolder, CreateProjFoldSchema, } from "./testmanagement-utils/create-project-folder.js";
+import { createTestCase as createTestCaseAPI, sanitizeArgs, CreateTestCaseSchema, } from "./testmanagement-utils/create-testcase.js";
 let serverInstance;
-const list_testcases_1 = require("./testmanagement-utils/list-testcases");
-const create_testrun_1 = require("./testmanagement-utils/create-testrun");
-const list_testruns_1 = require("./testmanagement-utils/list-testruns");
-const update_testrun_1 = require("./testmanagement-utils/update-testrun");
-const add_test_result_1 = require("./testmanagement-utils/add-test-result");
+import { listTestCases, ListTestCasesSchema, } from "./testmanagement-utils/list-testcases.js";
+import { CreateTestRunSchema, createTestRun, } from "./testmanagement-utils/create-testrun.js";
+import { ListTestRunsSchema, listTestRuns, } from "./testmanagement-utils/list-testruns.js";
+import { UpdateTestRunSchema, updateTestRun, } from "./testmanagement-utils/update-testrun.js";
+import { addTestResult, AddTestResultSchema, } from "./testmanagement-utils/add-test-result.js";
+import { UploadFileSchema, uploadFile, } from "./testmanagement-utils/upload-file.js";
+import { createTestCasesFromFile } from "./testmanagement-utils/testcase-from-file.js";
+import { CreateTestCasesFromFileSchema } from "./testmanagement-utils/TCG-utils/types.js";
+//TODO: Moving the traceMCP and catch block to the parent(server) function
 /**
  * Wrapper to call createProjectOrFolder util.
  */
-async function createProjectOrFolderTool(args) {
+export async function createProjectOrFolderTool(args) {
     try {
-        (0, instrumentation_1.trackMCP)("createProjectOrFolder", serverInstance.server.getClientVersion());
-        return await (0, create_project_folder_1.createProjectOrFolder)(args);
+        trackMCP("createProjectOrFolder", serverInstance.server.getClientVersion());
+        return await createProjectOrFolder(args);
     }
     catch (err) {
-        logger_1.default.error("Failed to create project/folder: %s", err);
-        (0, instrumentation_1.trackMCP)("createProjectOrFolder", serverInstance.server.getClientVersion(), err);
+        logger.error("Failed to create project/folder: %s", err);
+        trackMCP("createProjectOrFolder", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -47,16 +38,16 @@ async function createProjectOrFolderTool(args) {
 /**
  * Creates a test case in BrowserStack Test Management.
  */
-async function createTestCaseTool(args) {
+export async function createTestCaseTool(args) {
     // Sanitize input arguments
-    const cleanedArgs = (0, create_testcase_1.sanitizeArgs)(args);
+    const cleanedArgs = sanitizeArgs(args);
     try {
-        (0, instrumentation_1.trackMCP)("createTestCase", serverInstance.server.getClientVersion());
-        return await (0, create_testcase_1.createTestCase)(cleanedArgs);
+        trackMCP("createTestCase", serverInstance.server.getClientVersion());
+        return await createTestCaseAPI(cleanedArgs);
     }
     catch (err) {
-        logger_1.default.error("Failed to create test case: %s", err);
-        (0, instrumentation_1.trackMCP)("createTestCase", serverInstance.server.getClientVersion(), err);
+        logger.error("Failed to create test case: %s", err);
+        trackMCP("createTestCase", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -72,13 +63,13 @@ async function createTestCaseTool(args) {
 /**
  * Lists test cases in a project with optional filters (status, priority, custom fields, etc.)
  */
-async function listTestCasesTool(args) {
+export async function listTestCasesTool(args) {
     try {
-        (0, instrumentation_1.trackMCP)("listTestCases", serverInstance.server.getClientVersion());
-        return await (0, list_testcases_1.listTestCases)(args);
+        trackMCP("listTestCases", serverInstance.server.getClientVersion());
+        return await listTestCases(args);
     }
     catch (err) {
-        (0, instrumentation_1.trackMCP)("listTestCases", serverInstance.server.getClientVersion(), err);
+        trackMCP("listTestCases", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -94,13 +85,13 @@ async function listTestCasesTool(args) {
 /**
  * Creates a test run in BrowserStack Test Management.
  */
-async function createTestRunTool(args) {
+export async function createTestRunTool(args) {
     try {
-        (0, instrumentation_1.trackMCP)("createTestRun", serverInstance.server.getClientVersion());
-        return await (0, create_testrun_1.createTestRun)(args);
+        trackMCP("createTestRun", serverInstance.server.getClientVersion());
+        return await createTestRun(args);
     }
     catch (err) {
-        (0, instrumentation_1.trackMCP)("createTestRun", serverInstance.server.getClientVersion(), err);
+        trackMCP("createTestRun", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -116,13 +107,13 @@ async function createTestRunTool(args) {
 /**
  * Lists test runs in a project with optional filters (date ranges, assignee, state, etc.)
  */
-async function listTestRunsTool(args) {
+export async function listTestRunsTool(args) {
     try {
-        (0, instrumentation_1.trackMCP)("listTestRuns", serverInstance.server.getClientVersion());
-        return await (0, list_testruns_1.listTestRuns)(args);
+        trackMCP("listTestRuns", serverInstance.server.getClientVersion());
+        return await listTestRuns(args);
     }
     catch (err) {
-        (0, instrumentation_1.trackMCP)("listTestRuns", serverInstance.server.getClientVersion(), err);
+        trackMCP("listTestRuns", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -140,13 +131,13 @@ async function listTestRunsTool(args) {
  * This function allows for partial updates to an existing test run.
  * It takes the project identifier and test run ID as parameters.
  */
-async function updateTestRunTool(args) {
+export async function updateTestRunTool(args) {
     try {
-        (0, instrumentation_1.trackMCP)("updateTestRun", serverInstance.server.getClientVersion());
-        return await (0, update_testrun_1.updateTestRun)(args);
+        trackMCP("updateTestRun", serverInstance.server.getClientVersion());
+        return await updateTestRun(args);
     }
     catch (err) {
-        (0, instrumentation_1.trackMCP)("updateTestRun", serverInstance.server.getClientVersion(), err);
+        trackMCP("updateTestRun", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -162,13 +153,13 @@ async function updateTestRunTool(args) {
 /**
  * Adds a test result to a specific test run via BrowserStack Test Management API.
  */
-async function addTestResultTool(args) {
+export async function addTestResultTool(args) {
     try {
-        (0, instrumentation_1.trackMCP)("addTestResult", serverInstance.server.getClientVersion());
-        return await (0, add_test_result_1.addTestResult)(args);
+        trackMCP("addTestResult", serverInstance.server.getClientVersion());
+        return await addTestResult(args);
     }
     catch (err) {
-        (0, instrumentation_1.trackMCP)("addTestResult", serverInstance.server.getClientVersion(), err);
+        trackMCP("addTestResult", serverInstance.server.getClientVersion(), err);
         return {
             content: [
                 {
@@ -181,16 +172,62 @@ 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) {
+    try {
+        trackMCP("uploadFileTestManagement", serverInstance.server.getClientVersion());
+        return await uploadFile(args);
+    }
+    catch (err) {
+        trackMCP("uploadFileTestManagement", serverInstance.server.getClientVersion(), err);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Failed to upload file: ${err instanceof Error ? err.message : "Unknown error"}. Please open an issue on GitHub if the problem persists`,
+                    isError: true,
+                },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Creates test cases from a file in BrowserStack Test Management.
+ */
+export async function createTestCasesFromFileTool(args, context) {
+    try {
+        trackMCP("createTestCasesFromFile", serverInstance.server.getClientVersion());
+        return await createTestCasesFromFile(args, context);
+    }
+    catch (err) {
+        trackMCP("createTestCasesFromFile", serverInstance.server.getClientVersion(), err);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Failed to create test cases from file: ${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.
  */
-function addTestManagementTools(server) {
+export default function addTestManagementTools(server) {
     serverInstance = server;
-    server.tool("createProjectOrFolder", "Create a project and/or folder in BrowserStack Test Management.", create_project_folder_1.CreateProjFoldSchema.shape, createProjectOrFolderTool);
-    server.tool("createTestCase", "Use this tool to create a test case in BrowserStack Test Management.", create_testcase_1.CreateTestCaseSchema.shape, createTestCaseTool);
-    server.tool("listTestCases", "List test cases in a project with optional filters (status, priority, custom fields, etc.)", list_testcases_1.ListTestCasesSchema.shape, listTestCasesTool);
-    server.tool("createTestRun", "Create a test run in BrowserStack Test Management.", create_testrun_1.CreateTestRunSchema.shape, createTestRunTool);
-    server.tool("listTestRuns", "List test runs in a project with optional filters (date ranges, assignee, state, etc.)", list_testruns_1.ListTestRunsSchema.shape, listTestRunsTool);
-    server.tool("updateTestRun", "Update a test run in BrowserStack Test Management.", update_testrun_1.UpdateTestRunSchema.shape, updateTestRunTool);
-    server.tool("addTestResult", "Add a test result to a specific test run via BrowserStack Test Management API.", add_test_result_1.AddTestResultSchema.shape, addTestResultTool);
+    server.tool("createProjectOrFolder", "Create a project and/or folder in BrowserStack Test Management.", CreateProjFoldSchema.shape, createProjectOrFolderTool);
+    server.tool("createTestCase", "Use this tool to create a test case in BrowserStack Test Management.", CreateTestCaseSchema.shape, createTestCaseTool);
+    server.tool("listTestCases", "List test cases in a project with optional filters (status, priority, custom fields, etc.)", ListTestCasesSchema.shape, listTestCasesTool);
+    server.tool("createTestRun", "Create a test run in BrowserStack Test Management.", CreateTestRunSchema.shape, createTestRunTool);
+    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("createTestCasesFromFile", "Create test cases from a file in BrowserStack Test Management.", CreateTestCasesFromFileSchema.shape, createTestCasesFromFileTool);
 }

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "BrowserStack's Official MCP Server",
   "main": "dist/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/browserstack/mcp-server.git"
   },
+  "type": "module",
   "scripts": {
     "build": "npm run lint && npm run format && npm test && tsc",
     "start": "node dist/index.js",
     "dev": "tsx watch --clear-screen=false src/index.ts",
-    "test": "jest",
+    "test": "vitest run",
     "lint": "eslint . --ext .ts",
     "format": "prettier --write \"src/**/*.ts\""
   },
@@ -41,18 +42,21 @@
     "form-data": "^4.0.2",
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0",
+    "sharp": "^0.34.1",
+    "uuid": "^11.1.0",
+    "webdriverio": "^9.13.0",
     "zod": "^3.24.3"
   },
   "devDependencies": {
     "@eslint/js": "^9.25.0",
-    "@types/jest": "^29.5.14",
     "@types/node": "^22.14.1",
+    "@types/uuid": "^10.0.0",
     "eslint": "^9.25.0",
-    "jest": "^29.7.0",
     "prettier": "^3.5.3",
-    "ts-jest": "^29.3.2",
     "tsx": "^4.19.3",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.30.1"
+    "typescript-eslint": "^8.30.1",
+    "vite": "^6.3.5",
+    "vitest": "^3.1.3"
   }
 }