@browserstack/mcp-server 1.2.31 → 1.2.33-beta.1

package/dist/tools/sdk-utils/bstack/commands.js

@@ -10,7 +10,7 @@ const JAVA_FRAMEWORK_MAP = {
     cucumber: "cucumber-testng",
 };
 // Template for Node.js SDK setup instructions
-const NODEJS_SDK_INSTRUCTIONS = (username, accessKey) => `---STEP---
+const NODEJS_SDK_INSTRUCTIONS = () => `---STEP---
 Install BrowserStack Node SDK using command:
 \`\`\`bash
 npm i -D browserstack-node-sdk@latest
@@ -18,7 +18,7 @@ npm i -D browserstack-node-sdk@latest
 ---STEP---
 Run the following command to setup browserstack sdk:
 \`\`\`bash
-npx browserstack-node-sdk setup --username ${username} --key ${accessKey}
+npx browserstack-node-sdk setup --username "<your_browserstack_username>" --key "<your_browserstack_access_key>"
 \`\`\``;
 // Template for Gradle setup instructions (platform-independent)
 const GRADLE_SETUP_INSTRUCTIONS = `
@@ -33,7 +33,7 @@ const GRADLE_SETUP_INSTRUCTIONS = `
    jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
 `;
 // Generates Maven archetype command for Windows platform
-function getMavenCommandForWindows(username, accessKey, mavenFramework) {
+function getMavenCommandForWindows(mavenFramework) {
     return (`mvn archetype:generate -B ` +
         `-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
         `-DarchetypeArtifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
@@ -41,27 +41,27 @@ function getMavenCommandForWindows(username, accessKey, mavenFramework) {
         `-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
         `-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
         `-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
-        `-DBROWSERSTACK_USERNAME="${username}" ` +
-        `-DBROWSERSTACK_ACCESS_KEY="${accessKey}" ` +
+        `-DBROWSERSTACK_USERNAME="<your_browserstack_username>" ` +
+        `-DBROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>" ` +
         `-DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`);
 }
 // Generates Maven archetype command for Unix-like platforms (macOS/Linux)
-function getMavenCommandForUnix(username, accessKey, mavenFramework) {
+function getMavenCommandForUnix(mavenFramework) {
     return `mvn archetype:generate -B -DarchetypeGroupId=${MAVEN_ARCHETYPE_GROUP_ID} \\
 -DarchetypeArtifactId=${MAVEN_ARCHETYPE_ARTIFACT_ID} -DarchetypeVersion=${MAVEN_ARCHETYPE_VERSION} \\
 -DgroupId=${MAVEN_ARCHETYPE_GROUP_ID} -DartifactId=${MAVEN_ARCHETYPE_ARTIFACT_ID} -Dversion=${MAVEN_ARCHETYPE_VERSION} \\
--DBROWSERSTACK_USERNAME="${username}" \\
--DBROWSERSTACK_ACCESS_KEY="${accessKey}" \\
+-DBROWSERSTACK_USERNAME="<your_browserstack_username>" \\
+-DBROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>" \\
 -DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`;
 }
 // Generates Java SDK setup instructions with Maven/Gradle options
-function getJavaSDKInstructions(framework, username, accessKey) {
+function getJavaSDKInstructions(framework) {
     const mavenFramework = getJavaFrameworkForMaven(framework);
     const isWindows = process.platform === "win32";
     const platformLabel = isWindows ? "Windows" : "macOS/Linux";
     const mavenCommand = isWindows
-        ? getMavenCommandForWindows(username, accessKey, mavenFramework)
-        : getMavenCommandForUnix(username, accessKey, mavenFramework);
+        ? getMavenCommandForWindows(mavenFramework)
+        : getMavenCommandForUnix(mavenFramework);
     return `---STEP---
 Install BrowserStack Java SDK
 
@@ -73,12 +73,12 @@ Alternative setup for Gradle users:
 ${GRADLE_SETUP_INSTRUCTIONS}`;
 }
 // Main function to get SDK setup commands based on language and framework
-export function getSDKPrefixCommand(language, framework, username, accessKey) {
+export function getSDKPrefixCommand(language, framework) {
     switch (language) {
         case "nodejs":
-            return NODEJS_SDK_INSTRUCTIONS(username, accessKey);
+            return NODEJS_SDK_INSTRUCTIONS();
         case "java":
-            return getJavaSDKInstructions(framework, username, accessKey);
+            return getJavaSDKInstructions(framework);
         default:
             return "";
     }

package/dist/tools/sdk-utils/bstack/configUtils.d.ts

@@ -1,8 +1,7 @@
 import { ValidatedEnvironment } from "../common/device-validator.js";
-import { BrowserStackConfig } from "../../../lib/types.js";
 export declare function generateBrowserStackYMLInstructions(config: {
     validatedEnvironments?: ValidatedEnvironment[];
     platforms?: string[];
     enablePercy?: boolean;
     projectName: string;
-}, browserStackConfig: BrowserStackConfig): string;
+}): string;

package/dist/tools/sdk-utils/bstack/configUtils.js

@@ -1,10 +1,6 @@
-import { getBrowserStackAuth } from "../../../lib/get-auth.js";
-export function generateBrowserStackYMLInstructions(config, browserStackConfig) {
+export function generateBrowserStackYMLInstructions(config) {
     const enablePercy = config.enablePercy || false;
     const projectName = config.projectName || "BrowserStack Automate Build";
-    // Get credentials from config
-    const authString = getBrowserStackAuth(browserStackConfig);
-    const [username, accessKey] = authString.split(":");
     // Generate platform configurations using the utility function
     const platformConfigs = generatePlatformConfigs(config);
     const stepTitle = "Create a browserstack.yml file in the project root with your validated device configurations:If already exists, update it with the following content for devices and project details.";
@@ -14,8 +10,8 @@ export function generateBrowserStackYMLInstructions(config, browserStackConfig)
 # BrowserStack Reporting
 # ======================
 
-userName: ${username}
-accessKey: ${accessKey}
+userName: <your_browserstack_username>
+accessKey: <your_browserstack_access_key>
 
 # TODO: Replace these sample values with your actual project details
 projectName: ${projectName}

package/dist/tools/sdk-utils/bstack/constants.d.ts

@@ -6,52 +6,52 @@ export declare const pythonInstructions: () => {
     setup: string;
     run: string;
 };
-export declare const generatePythonFrameworkInstructions: (framework: string) => (username: string, accessKey: string) => {
+export declare const generatePythonFrameworkInstructions: (framework: string) => () => {
     setup: string;
     run: string;
 };
-export declare const robotInstructions: (username: string, accessKey: string) => {
+export declare const robotInstructions: () => {
     setup: string;
     run: string;
 };
-export declare const behaveInstructions: (username: string, accessKey: string) => {
+export declare const behaveInstructions: () => {
     setup: string;
     run: string;
 };
-export declare const pytestInstructions: (username: string, accessKey: string) => {
+export declare const pytestInstructions: () => {
     setup: string;
     run: string;
 };
-export declare const javaInstructions: (username: string, accessKey: string) => {
+export declare const javaInstructions: () => {
     setup: string;
     run: string;
 };
 /**
  * ---------- CSharp INSTRUCTIONS ----------
  */
-export declare const csharpCommonInstructions: (username: string, accessKey: string) => {
+export declare const csharpCommonInstructions: () => {
     setup: string;
     run: string;
 };
-export declare const csharpPlaywrightCommonInstructions: (username: string, accessKey: string) => {
+export declare const csharpPlaywrightCommonInstructions: () => {
     setup: string;
     run: string;
 };
 /**
  * ---------- NODEJS INSTRUCTIONS ----------
  */
-export declare const nodejsInstructions: (username: string, accessKey: string) => {
+export declare const nodejsInstructions: () => {
     setup: string;
     run: string;
 };
 /**
  * ---------- EXPORT CONFIG ----------
  */
-export declare const webdriverioInstructions: (username: string, accessKey: string) => {
+export declare const webdriverioInstructions: () => {
     setup: string;
     run: string;
 };
-export declare const cypressInstructions: (username: string, accessKey: string) => {
+export declare const cypressInstructions: () => {
     setup: string;
     run: string;
 };

package/dist/tools/sdk-utils/bstack/constants.js

@@ -25,7 +25,7 @@ browserstack-sdk pytest <path-to-test-directory>
 `;
     return { setup, run };
 };
-export const generatePythonFrameworkInstructions = (framework) => (username, accessKey) => {
+export const generatePythonFrameworkInstructions = (framework) => () => {
     const setup = `
 ---STEP---
 
@@ -39,7 +39,7 @@ python3 -m pip install browserstack-sdk
 
 Setup the BrowserStack SDK with framework-specific configuration:
 \`\`\`bash
-browserstack-sdk setup --framework "${framework}" --username "${username}" --key "${accessKey}"
+browserstack-sdk setup --framework "${framework}" --username "<your_browserstack_username>" --key "<your_browserstack_access_key>"
 \`\`\`
 `;
     const run = `
@@ -59,7 +59,7 @@ export const pytestInstructions = generatePythonFrameworkInstructions("pytest");
  * ---------- JAVA INSTRUCTIONS ----------
  */
 const argsInstruction = '<argLine>-javaagent:"${com.browserstack:browserstack-java-sdk:jar}"</argLine>';
-export const javaInstructions = (username, accessKey) => {
+export const javaInstructions = () => {
     const setup = `
 ---STEP---
 
@@ -86,8 +86,8 @@ dependencies {
 
 Export your BrowserStack credentials as environment variables:
 \`\`\`bash
-export BROWSERSTACK_USERNAME=${username}
-export BROWSERSTACK_ACCESS_KEY=${accessKey}
+export BROWSERSTACK_USERNAME="<your_browserstack_username>"
+export BROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>"
 \`\`\`
 `;
     const run = `
@@ -108,7 +108,7 @@ gradle clean test
 /**
  * ---------- CSharp INSTRUCTIONS ----------
  */
-export const csharpCommonInstructions = (username, accessKey) => {
+export const csharpCommonInstructions = () => {
     const setup = `
 ---STEP---
 
@@ -128,7 +128,7 @@ dotnet build
 
 Set up BrowserStack SDK with your credentials:
 \`\`\`bash
-dotnet browserstack-sdk setup --userName ${username} --accessKey ${accessKey}
+dotnet browserstack-sdk setup --userName "<your_browserstack_username>" --accessKey "<your_browserstack_access_key>"
 \`\`\`
 
 ---STEP---
@@ -174,7 +174,7 @@ Run the tests:
 `;
     return { setup, run };
 };
-export const csharpPlaywrightCommonInstructions = (username, accessKey) => {
+export const csharpPlaywrightCommonInstructions = () => {
     const setup = `
 ---STEP---
 
@@ -194,7 +194,7 @@ dotnet build
 
 Set up BrowserStack SDK with your credentials:
 \`\`\`bash
-dotnet browserstack-sdk setup --userName ${username} --accessKey ${accessKey}
+dotnet browserstack-sdk setup --userName "<your_browserstack_username>" --accessKey "<your_browserstack_access_key>"
 \`\`\`
 
 ---STEP---
@@ -256,7 +256,7 @@ Run the tests:
 /**
  * ---------- NODEJS INSTRUCTIONS ----------
  */
-export const nodejsInstructions = (username, accessKey) => {
+export const nodejsInstructions = () => {
     const setup = `
 ---STEP---
 
@@ -285,8 +285,8 @@ Example :
 Export BrowserStack credentials as environment variables:
 Set the following environment variables before running tests.
 \`\`\`bash
-export BROWSERSTACK_USERNAME=${username}
-export BROWSERSTACK_ACCESS_KEY=${accessKey}
+export BROWSERSTACK_USERNAME="<your_browserstack_username>"
+export BROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>"
 \`\`\`
 
 ---STEP---
@@ -306,7 +306,7 @@ npm run test:browserstack
 /**
  * ---------- EXPORT CONFIG ----------
  */
-export const webdriverioInstructions = (username, accessKey) => {
+export const webdriverioInstructions = () => {
     const setup = `
 ---STEP---
 
@@ -315,14 +315,14 @@ Export your BrowserStack username and access key as environment variables.
 
 For macOS/Linux:
 \`\`\`bash
-export BROWSERSTACK_USERNAME=${username}
-export BROWSERSTACK_ACCESS_KEY=${accessKey}
+export BROWSERSTACK_USERNAME="<your_browserstack_username>"
+export BROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>"
 \`\`\`
 
 For Windows PowerShell:
 \`\`\`powershell
-$env:BROWSERSTACK_USERNAME=${username}
-$env:BROWSERSTACK_ACCESS_KEY=${accessKey}
+$env:BROWSERSTACK_USERNAME="<your_browserstack_username>"
+$env:BROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>"
 \`\`\`
 
 ---STEP---
@@ -415,7 +415,7 @@ You can now run your tests on BrowserStack using your standard WebdriverIO comma
 `;
     return { setup, run };
 };
-export const cypressInstructions = (username, accessKey) => {
+export const cypressInstructions = () => {
     const setup = `
 ---STEP---
 
@@ -445,8 +445,8 @@ Open the generated \`browserstack.json\` file and update it with your BrowserSta
 \`\`\`json
 {
   "auth": {
-    "username": "${username}",
-    "access_key": "${accessKey}"
+    "username": "<your_browserstack_username>",
+    "access_key": "<your_browserstack_access_key>"
   },
   "browsers": [
     {
@@ -490,21 +490,21 @@ npx browserstack-cypress run --sync
 After the tests complete, you can view the results on your [BrowserStack Automate Dashboard](https://automate.browserstack.com/dashboard/).`;
     return { setup, run };
 };
-const serenityInstructions = (username, accessKey) => {
+const serenityInstructions = () => {
     const setup = `
 ---STEP---
 
 Set BrowserStack credentials as environment variables:
 For macOS/Linux:
 \`\`\`bash
-export BROWSERSTACK_USERNAME=${username}
-export BROWSERSTACK_ACCESS_KEY=${accessKey}
+export BROWSERSTACK_USERNAME="<your_browserstack_username>"
+export BROWSERSTACK_ACCESS_KEY="<your_browserstack_access_key>"
 \`\`\`
 
 For Windows Command Prompt:
 \`\`\`cmd
-set BROWSERSTACK_USERNAME=${username}
-set BROWSERSTACK_ACCESS_KEY=${accessKey}
+set "BROWSERSTACK_USERNAME=<your_browserstack_username>"
+set "BROWSERSTACK_ACCESS_KEY=<your_browserstack_access_key>"
 \`\`\`
 
 ---STEP---
@@ -528,8 +528,8 @@ webdriver {
   driver = remote
   remote.url = "https://hub.browserstack.com/wd/hub"
 }
-browserstack.user="${username}"
-browserstack.key="${accessKey}"
+browserstack.user="<your_browserstack_username>"
+browserstack.key="<your_browserstack_access_key>"
 \`\`\`
 `;
     const run = `

package/dist/tools/sdk-utils/bstack/sdkHandler.js

@@ -1,12 +1,20 @@
-import { getBrowserStackAuth } from "../../../lib/get-auth.js";
 import { getSDKPrefixCommand } from "./commands.js";
 import { generateBrowserStackYMLInstructions } from "./configUtils.js";
 import { getInstructionsForProjectConfiguration } from "../common/instructionUtils.js";
+import { CREDENTIALS_SUBSTITUTION_NOTE } from "../common/credentials.js";
 import { validateDevices } from "../common/device-validator.js";
-export async function runBstackSDKOnly(input, config, isPercyAutomate = false) {
-    const steps = [];
-    const authString = getBrowserStackAuth(config);
-    const [username, accessKey] = authString.split(":");
+export async function runBstackSDKOnly(input, 
+// Retained for tool-handler signature stability (callers pass the per-request
+// config); setup instructions no longer embed credentials, so it is unused here.
+config, isPercyAutomate = false) {
+    void config;
+    const steps = [
+        {
+            type: "instruction",
+            title: "Set your BrowserStack credentials",
+            content: CREDENTIALS_SUBSTITUTION_NOTE,
+        },
+    ];
     const tupleTargets = input.devices?.map((device) => {
         const platform = device.platform.toLowerCase();
         if (platform === "windows" || platform === "macos") {
@@ -32,7 +40,7 @@ export async function runBstackSDKOnly(input, config, isPercyAutomate = false) {
     // Handle frameworks with unique setup instructions that don't use browserstack.yml
     if (input.detectedBrowserAutomationFramework === "cypress" ||
         input.detectedBrowserAutomationFramework === "webdriverio") {
-        const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage, username, accessKey);
+        const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage);
         if (frameworkInstructions) {
             if (frameworkInstructions.setup) {
                 steps.push({
@@ -56,7 +64,7 @@ export async function runBstackSDKOnly(input, config, isPercyAutomate = false) {
         };
     }
     // Default flow using browserstack.yml
-    const sdkSetupCommand = getSDKPrefixCommand(input.detectedLanguage, input.detectedTestingFramework, username, accessKey);
+    const sdkSetupCommand = getSDKPrefixCommand(input.detectedLanguage, input.detectedTestingFramework);
     if (sdkSetupCommand) {
         steps.push({
             type: "instruction",
@@ -64,7 +72,7 @@ export async function runBstackSDKOnly(input, config, isPercyAutomate = false) {
             content: sdkSetupCommand,
         });
     }
-    const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage, username, accessKey);
+    const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage);
     if (frameworkInstructions) {
         if (frameworkInstructions.setup) {
             steps.push({
@@ -78,7 +86,7 @@ export async function runBstackSDKOnly(input, config, isPercyAutomate = false) {
         validatedEnvironments,
         enablePercy: false,
         projectName: input.projectName,
-    }, config);
+    });
     if (ymlInstructions) {
         steps.push({
             type: "instruction",

package/dist/tools/sdk-utils/common/credentials.d.ts

@@ -0,0 +1,3 @@
+export declare const USERNAME_PLACEHOLDER = "<your_browserstack_username>";
+export declare const ACCESS_KEY_PLACEHOLDER = "<your_browserstack_access_key>";
+export declare const CREDENTIALS_SUBSTITUTION_NOTE: string;

package/dist/tools/sdk-utils/common/credentials.js

@@ -0,0 +1,11 @@
+// Single source of truth for the credential placeholders emitted in generated
+// SDK setup instructions, so the web (sdk-utils) and App Automate (appium-sdk)
+// trees cannot drift apart. Real credentials are never embedded — see
+// rules/security.md.
+export const USERNAME_PLACEHOLDER = "<your_browserstack_username>";
+export const ACCESS_KEY_PLACEHOLDER = "<your_browserstack_access_key>";
+// Tells the reader (often a coding agent that runs steps verbatim) to swap the
+// placeholders for real values, so they are not baked into browserstack.yml.
+export const CREDENTIALS_SUBSTITUTION_NOTE = `Replace ${USERNAME_PLACEHOLDER} and ${ACCESS_KEY_PLACEHOLDER} in the steps below ` +
+    `with your BrowserStack credentials from https://www.browserstack.com/accounts/profile/details ` +
+    `(or export them as BROWSERSTACK_USERNAME / BROWSERSTACK_ACCESS_KEY). Do not commit real credentials.`;

package/dist/tools/sdk-utils/common/instructionUtils.d.ts

@@ -2,7 +2,7 @@
  * Core instruction configuration utilities for runTestsOnBrowserStack tool.
  */
 import { SDKSupportedLanguage, SDKSupportedBrowserAutomationFramework, SDKSupportedTestingFramework } from "./types.js";
-export declare const getInstructionsForProjectConfiguration: (detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework, detectedTestingFramework: SDKSupportedTestingFramework, detectedLanguage: SDKSupportedLanguage, username: string, accessKey: string) => {
+export declare const getInstructionsForProjectConfiguration: (detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework, detectedTestingFramework: SDKSupportedTestingFramework, detectedLanguage: SDKSupportedLanguage) => {
     setup: string;
     run: string;
 };

package/dist/tools/sdk-utils/common/instructionUtils.js

@@ -3,7 +3,7 @@
  */
 import { SUPPORTED_CONFIGURATIONS } from "../bstack/frameworks.js";
 const errorMessageSuffix = "Please open an issue at our Github repo: https://github.com/browserstack/browserstack-mcp-server/issues to request support for your project configuration";
-export const getInstructionsForProjectConfiguration = (detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey) => {
+export const getInstructionsForProjectConfiguration = (detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage) => {
     const configuration = SUPPORTED_CONFIGURATIONS[detectedLanguage];
     if (!configuration) {
         throw new Error(`BrowserStack MCP Server currently does not support ${detectedLanguage}, ${errorMessageSuffix}`);
@@ -16,5 +16,5 @@ export const getInstructionsForProjectConfiguration = (detectedBrowserAutomation
     }
     const instructionFunction = configuration[detectedBrowserAutomationFramework][detectedTestingFramework]
         .instructions;
-    return instructionFunction(username, accessKey);
+    return instructionFunction();
 };

package/dist/tools/sdk-utils/common/types.d.ts

@@ -43,7 +43,7 @@ export declare const SDKSupportedLanguages: SDKSupportedLanguageEnum[];
 export type SDKSupportedTestingFramework = keyof typeof SDKSupportedTestingFrameworkEnum;
 export declare const SDKSupportedTestingFrameworks: SDKSupportedTestingFrameworkEnum[];
 export type ConfigMapping = Partial<Record<SDKSupportedLanguageEnum, Partial<Record<SDKSupportedBrowserAutomationFrameworkEnum, Partial<Record<SDKSupportedTestingFrameworkEnum, {
-    instructions: (username: string, accessKey: string) => {
+    instructions: () => {
         setup: string;
         run: string;
     };

package/dist/tools/sdk-utils/handler.js

@@ -55,7 +55,7 @@ export async function setUpPercyHandler(rawInput, config) {
             const percyWithBrowserstackSDKResult = runPercyWithBrowserstackSDK({
                 ...percyInput,
                 devices: [],
-            }, config);
+            });
             const hasPercySDKError = percyWithBrowserstackSDKResult.steps &&
                 percyWithBrowserstackSDKResult.steps.some((step) => step.isError);
             if (!hasPercySDKError) {

package/dist/tools/sdk-utils/percy-bstack/handler.d.ts

@@ -1,4 +1,3 @@
 import { RunTestsInstructionResult } from "../common/types.js";
 import { RunTestsOnBrowserStackInput } from "../common/schema.js";
-import { BrowserStackConfig } from "../../../lib/types.js";
-export declare function runPercyWithBrowserstackSDK(input: RunTestsOnBrowserStackInput, config: BrowserStackConfig): RunTestsInstructionResult;
+export declare function runPercyWithBrowserstackSDK(input: RunTestsOnBrowserStackInput): RunTestsInstructionResult;

package/dist/tools/sdk-utils/percy-bstack/handler.js

@@ -1,12 +1,16 @@
-import { getBrowserStackAuth } from "../../../lib/get-auth.js";
 import { getSDKPrefixCommand } from "../bstack/commands.js";
 import { generateBrowserStackYMLInstructions } from "../bstack/configUtils.js";
 import { getInstructionsForProjectConfiguration } from "../common/instructionUtils.js";
+import { CREDENTIALS_SUBSTITUTION_NOTE } from "../common/credentials.js";
 import { formatPercyInstructions, getPercyInstructions, } from "./instructions.js";
-export function runPercyWithBrowserstackSDK(input, config) {
-    const steps = [];
-    const authString = getBrowserStackAuth(config);
-    const [username, accessKey] = authString.split(":");
+export function runPercyWithBrowserstackSDK(input) {
+    const steps = [
+        {
+            type: "instruction",
+            title: "Set your BrowserStack credentials",
+            content: CREDENTIALS_SUBSTITUTION_NOTE,
+        },
+    ];
     // Check if Percy is supported for this configuration
     const percyResult = getPercyInstructions(input.detectedLanguage, input.detectedBrowserAutomationFramework, input.detectedTestingFramework);
     if (!percyResult) {
@@ -28,7 +32,7 @@ export function runPercyWithBrowserstackSDK(input, config) {
     // Handle frameworks with unique setup instructions that don't use browserstack.yml
     if (input.detectedBrowserAutomationFramework === "cypress" ||
         input.detectedBrowserAutomationFramework === "webdriverio") {
-        const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage, username, accessKey);
+        const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage);
         if (frameworkInstructions && frameworkInstructions.setup) {
             steps.push({
                 type: "instruction",
@@ -55,7 +59,7 @@ export function runPercyWithBrowserstackSDK(input, config) {
         };
     }
     // Default flow using browserstack.yml with Percy
-    const sdkSetupCommand = getSDKPrefixCommand(input.detectedLanguage, input.detectedTestingFramework, username, accessKey);
+    const sdkSetupCommand = getSDKPrefixCommand(input.detectedLanguage, input.detectedTestingFramework);
     if (sdkSetupCommand) {
         steps.push({
             type: "instruction",
@@ -67,7 +71,7 @@ export function runPercyWithBrowserstackSDK(input, config) {
         platforms: input.devices?.map((t) => t.join(" ")) || [],
         enablePercy: true,
         projectName: input.projectName,
-    }, config);
+    });
     if (ymlInstructions) {
         steps.push({
             type: "instruction",
@@ -75,7 +79,7 @@ export function runPercyWithBrowserstackSDK(input, config) {
             content: ymlInstructions,
         });
     }
-    const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage, username, accessKey);
+    const frameworkInstructions = getInstructionsForProjectConfiguration(input.detectedBrowserAutomationFramework, input.detectedTestingFramework, input.detectedLanguage);
     if (frameworkInstructions && frameworkInstructions.setup) {
         steps.push({
             type: "instruction",

package/dist/tools/testmanagement-utils/create-testcase.js

@@ -3,6 +3,7 @@ import { z } from "zod";
 import { formatAxiosError } from "../../lib/error.js";
 import { fetchFormFields, normalizeDefaultFields as normalizeDefaultFieldsFromForm, projectIdentifierToId, } from "./TCG-utils/api.js";
 import { getTMBaseURL } from "../../lib/tm-base-url.js";
+import { wrapRichText, wrapTestCaseSteps } from "./rich-text.js";
 import logger from "../../logger.js";
 // Scalar value, or an array of values for multi-select custom fields.
 export const customFieldValueSchema = z.union([
@@ -189,6 +190,13 @@ async function toV1CustomFields(customFields, numericProjectId, config) {
 export async function createTestCase(params, config) {
     const testCaseParams = { ...params };
     testCaseParams.tags = Array.from(new Set([...(testCaseParams.tags ?? []), "MCP Generated"]));
+    testCaseParams.test_case_steps = wrapTestCaseSteps(testCaseParams.test_case_steps);
+    if (testCaseParams.preconditions !== undefined) {
+        testCaseParams.preconditions = wrapRichText(testCaseParams.preconditions);
+    }
+    if (testCaseParams.description !== undefined) {
+        testCaseParams.description = wrapRichText(testCaseParams.description);
+    }
     if (testCaseParams.priority !== undefined ||
         testCaseParams.case_type !== undefined) {
         const normalized = await normalizeDefaultFields(params.project_identifier, {

package/dist/tools/testmanagement-utils/rich-text.d.ts

@@ -0,0 +1,5 @@
+export declare function wrapRichText(text: string): string;
+export declare function wrapTestCaseSteps<T extends {
+    step: string;
+    result: string;
+}>(steps: T[]): T[];

package/dist/tools/testmanagement-utils/rich-text.js

@@ -0,0 +1,22 @@
+// TM renders these fields as rich text only when the value is HTML;
+const TM_ALLOWED_TAG = /^\s*<(div|img|b|em|i|strong|u|span|abbr|br|cite|code|dd|dfn|dl|dt|kbd|li|mark|ol|p|pre|q|s|samp|small|strike|sub|sup|time|ul|var|table|td|th|thead|tbody|tr|col|colgroup|a)[\s/>]/i;
+const HAS_ENCODABLE_CHARS = /[<>&]/;
+function escapeHtml(text) {
+    return text
+        .replace(/&/g, "&amp;")
+        .replace(/</g, "&lt;")
+        .replace(/>/g, "&gt;");
+}
+export function wrapRichText(text) {
+    if (TM_ALLOWED_TAG.test(text) || !HAS_ENCODABLE_CHARS.test(text)) {
+        return text;
+    }
+    return `<p>${escapeHtml(text)}</p>`;
+}
+export function wrapTestCaseSteps(steps) {
+    return steps.map((s) => ({
+        ...s,
+        step: wrapRichText(s.step),
+        result: wrapRichText(s.result),
+    }));
+}

package/dist/tools/testmanagement-utils/update-testcase.js

@@ -4,6 +4,7 @@ import { formatAxiosError } from "../../lib/error.js";
 import { fetchFormFields, normalizeDefaultFields as normalizeDefaultFieldsFromForm, projectIdentifierToId, } from "./TCG-utils/api.js";
 import { getTMBaseURL } from "../../lib/tm-base-url.js";
 import { getBrowserStackAuth } from "../../lib/get-auth.js";
+import { wrapRichText, wrapTestCaseSteps } from "./rich-text.js";
 import logger from "../../logger.js";
 export const UpdateTestCaseSchema = z.object({
     project_identifier: z
@@ -107,11 +108,11 @@ export async function updateTestCase(params, config) {
     if (params.name !== undefined)
         testCaseBody.name = params.name;
     if (params.description !== undefined)
-        testCaseBody.description = params.description;
+        testCaseBody.description = wrapRichText(params.description);
     if (params.preconditions !== undefined)
-        testCaseBody.preconditions = params.preconditions;
+        testCaseBody.preconditions = wrapRichText(params.preconditions);
     if (params.test_case_steps !== undefined)
-        testCaseBody.test_case_steps = params.test_case_steps;
+        testCaseBody.test_case_steps = wrapTestCaseSteps(params.test_case_steps);
     if (params.owner !== undefined)
         testCaseBody.owner = params.owner;
     if (params.status !== undefined)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.2.31",
+  "version": "1.2.33-beta.1",
   "description": "BrowserStack's Official MCP Server",
   "mcpName": "io.github.browserstack/mcp-server",
   "main": "dist/index.js",