@browserstack/mcp-server 1.1.9 → 1.2.0

package/dist/tools/getFailureLogs.js

@@ -5,7 +5,7 @@ import { retrieveNetworkFailures, retrieveSessionFailures, retrieveConsoleFailur
 import { retrieveDeviceLogs, retrieveAppiumLogs, retrieveCrashLogs, } from "./failurelogs-utils/app-automate.js";
 import { AppAutomateLogType, AutomateLogType, SessionType, } from "../lib/constants.js";
 // Main log fetcher function
-export async function getFailureLogs(args) {
+export async function getFailureLogs(args, config) {
     const results = [];
     const errors = [];
     let validLogTypes = [];
@@ -53,32 +53,32 @@ export async function getFailureLogs(args) {
         for (const logType of validLogTypes) {
             switch (logType) {
                 case AutomateLogType.NetworkLogs: {
-                    response = await retrieveNetworkFailures(args.sessionId);
+                    response = await retrieveNetworkFailures(args.sessionId, config);
                     results.push({ type: "text", text: response });
                     break;
                 }
                 case AutomateLogType.SessionLogs: {
-                    response = await retrieveSessionFailures(args.sessionId);
+                    response = await retrieveSessionFailures(args.sessionId, config);
                     results.push({ type: "text", text: response });
                     break;
                 }
                 case AutomateLogType.ConsoleLogs: {
-                    response = await retrieveConsoleFailures(args.sessionId);
+                    response = await retrieveConsoleFailures(args.sessionId, config);
                     results.push({ type: "text", text: response });
                     break;
                 }
                 case AppAutomateLogType.DeviceLogs: {
-                    response = await retrieveDeviceLogs(args.sessionId, args.buildId);
+                    response = await retrieveDeviceLogs(args.sessionId, args.buildId, config);
                     results.push({ type: "text", text: response });
                     break;
                 }
                 case AppAutomateLogType.AppiumLogs: {
-                    response = await retrieveAppiumLogs(args.sessionId, args.buildId);
+                    response = await retrieveAppiumLogs(args.sessionId, args.buildId, config);
                     results.push({ type: "text", text: response });
                     break;
                 }
                 case AppAutomateLogType.CrashLogs: {
-                    response = await retrieveCrashLogs(args.sessionId, args.buildId);
+                    response = await retrieveCrashLogs(args.sessionId, args.buildId, config);
                     results.push({ type: "text", text: response });
                     break;
                 }
@@ -98,7 +98,7 @@ export async function getFailureLogs(args) {
     return { content: results };
 }
 // Register tool with the MCP server
-export default function registerGetFailureLogs(server) {
+export default function registerGetFailureLogs(server, config) {
     server.tool("getFailureLogs", "Fetch various types of logs from a BrowserStack session. Supports both automate and app-automate sessions.", {
         sessionType: z
             .enum([SessionType.Automate, SessionType.AppAutomate])
@@ -122,12 +122,12 @@ export default function registerGetFailureLogs(server) {
             .describe("The types of logs to fetch."),
     }, async (args) => {
         try {
-            trackMCP("getFailureLogs", server.server.getClientVersion());
-            return await getFailureLogs(args);
+            trackMCP("getFailureLogs", server.server.getClientVersion(), undefined, config);
+            return await getFailureLogs(args, config);
         }
         catch (error) {
             const message = error instanceof Error ? error.message : String(error);
-            trackMCP("getFailureLogs", server.server.getClientVersion(), error);
+            trackMCP("getFailureLogs", server.server.getClientVersion(), error, config);
             logger.error("Failed to fetch logs: %s", message);
             return {
                 content: [

package/dist/tools/live-utils/desktop-filter.d.ts

@@ -0,0 +1,2 @@
+import { DesktopSearchArgs, DesktopEntry } from "./types.js";
+export declare function filterDesktop(args: DesktopSearchArgs): Promise<DesktopEntry>;

package/dist/tools/live-utils/mobile-filter.d.ts

@@ -0,0 +1,2 @@
+import { MobileSearchArgs, MobileEntry } from "./types.js";
+export declare function filterMobile(args: MobileSearchArgs): Promise<MobileEntry>;

package/dist/tools/live-utils/start-session.d.ts

@@ -0,0 +1,6 @@
+import { DesktopSearchArgs, MobileSearchArgs } from "./types.js";
+import { BrowserStackConfig } from "../../lib/types.js";
+/**
+ * Entrypoint: detects platformType & delegates.
+ */
+export declare function startBrowserSession(args: DesktopSearchArgs | MobileSearchArgs, config: BrowserStackConfig): Promise<string>;

package/dist/tools/live-utils/start-session.js

@@ -4,13 +4,18 @@ import { filterDesktop } from "./desktop-filter.js";
 import { filterMobile } from "./mobile-filter.js";
 import { PlatformType, } from "./types.js";
 import { isLocalURL, ensureLocalBinarySetup, killExistingBrowserStackLocalProcesses, } from "../../lib/local.js";
+import { getBrowserStackAuth } from "../../lib/get-auth.js";
+import envConfig from "../../config.js";
 /**
  * Prepares local tunnel setup based on URL type
  */
-async function prepareLocalTunnel(url) {
+async function prepareLocalTunnel(url, username, password) {
     const isLocal = isLocalURL(url);
+    if (isLocal && envConfig.REMOTE_MCP) {
+        throw new Error("Local URLs are not supported in this remote mcp. Please use a public URL.");
+    }
     if (isLocal) {
-        await ensureLocalBinarySetup();
+        await ensureLocalBinarySetup(username, password);
     }
     else {
         await killExistingBrowserStackLocalProcesses();
@@ -20,15 +25,23 @@ async function prepareLocalTunnel(url) {
 /**
  * Entrypoint: detects platformType & delegates.
  */
-export async function startBrowserSession(args) {
+export async function startBrowserSession(args, config) {
     const entry = args.platformType === PlatformType.DESKTOP
         ? await filterDesktop(args)
         : await filterMobile(args);
-    const isLocal = await prepareLocalTunnel(args.url);
+    // Get credentials from config
+    const authString = getBrowserStackAuth(config);
+    const [username, password] = authString.split(":");
+    if (!username || !password) {
+        throw new Error("BrowserStack credentials are not set. Please configure them in the server settings.");
+    }
+    const isLocal = await prepareLocalTunnel(args.url, username, password);
     const url = args.platformType === PlatformType.DESKTOP
         ? buildDesktopUrl(args, entry, isLocal)
         : buildMobileUrl(args, entry, isLocal);
-    openBrowser(url);
+    if (!envConfig.REMOTE_MCP) {
+        openBrowser(url);
+    }
     return entry.notes ? `${url}, ${entry.notes}` : url;
 }
 function buildDesktopUrl(args, e, isLocal) {

package/dist/tools/live-utils/types.d.ts

@@ -0,0 +1,33 @@
+export interface DesktopSearchArgs {
+    platformType: "desktop";
+    url: string;
+    os: string;
+    osVersion: string;
+    browser: string;
+    browserVersion: string;
+}
+export interface DesktopEntry {
+    os: string;
+    os_version: string;
+    browser: string;
+    browser_version: string;
+    notes?: string;
+}
+export interface MobileSearchArgs {
+    platformType: "mobile";
+    url: string;
+    os: string;
+    osVersion: string;
+    device: string;
+    browser: string;
+}
+export interface MobileEntry {
+    os: string;
+    os_version: string;
+    display_name: string;
+    notes?: string;
+}
+export declare enum PlatformType {
+    DESKTOP = "desktop",
+    MOBILE = "mobile"
+}

package/dist/tools/live.d.ts

@@ -0,0 +1,3 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { BrowserStackConfig } from "../lib/types.js";
+export default function addBrowserLiveTools(server: McpServer, config: BrowserStackConfig): void;

package/dist/tools/live.js

@@ -28,7 +28,7 @@ const LiveArgsSchema = z.object(LiveArgsShape);
 /**
  * Launches a desktop browser session
  */
-async function launchDesktopSession(args) {
+async function launchDesktopSession(args, config) {
     if (!args.desiredBrowser)
         throw new Error("You must provide a desiredBrowser");
     if (!args.desiredBrowserVersion)
@@ -40,12 +40,12 @@ async function launchDesktopSession(args) {
         osVersion: args.desiredOSVersion,
         browser: args.desiredBrowser,
         browserVersion: args.desiredBrowserVersion,
-    });
+    }, config);
 }
 /**
  * Launches a mobile browser session
  */
-async function launchMobileSession(args) {
+async function launchMobileSession(args, config) {
     if (!args.desiredDevice)
         throw new Error("You must provide a desiredDevice");
     return startBrowserSession({
@@ -55,18 +55,18 @@ async function launchMobileSession(args) {
         os: args.desiredOS,
         osVersion: args.desiredOSVersion,
         device: args.desiredDevice,
-    });
+    }, config);
 }
 /**
  * Handles the core logic for running a browser session
  */
-async function runBrowserSession(rawArgs) {
+async function runBrowserSession(rawArgs, config) {
     // Validate and narrow
     const args = LiveArgsSchema.parse(rawArgs);
     // Branch desktop vs mobile and delegate
     const launchUrl = args.platformType === PlatformType.DESKTOP
-        ? await launchDesktopSession(args)
-        : await launchMobileSession(args);
+        ? await launchDesktopSession(args, config)
+        : await launchMobileSession(args, config);
     return {
         content: [
             {
@@ -76,15 +76,15 @@ async function runBrowserSession(rawArgs) {
         ],
     };
 }
-export default function addBrowserLiveTools(server) {
+export default function addBrowserLiveTools(server, config) {
     server.tool("runBrowserLiveSession", "Launch a BrowserStack Live session (desktop or mobile).", LiveArgsShape, async (args) => {
         try {
-            trackMCP("runBrowserLiveSession", server.server.getClientVersion());
-            return await runBrowserSession(args);
+            trackMCP("runBrowserLiveSession", server.server.getClientVersion(), undefined, config);
+            return await runBrowserSession(args, config);
         }
         catch (error) {
             logger.error("Live session failed: %s", error);
-            trackMCP("runBrowserLiveSession", server.server.getClientVersion(), error);
+            trackMCP("runBrowserLiveSession", server.server.getClientVersion(), error, config);
             return {
                 content: [
                     {

package/dist/tools/observability.d.ts

@@ -0,0 +1,5 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { BrowserStackConfig } from "../lib/types.js";
+export declare function getFailuresInLastRun(buildName: string, projectName: string, config: BrowserStackConfig): Promise<CallToolResult>;
+export default function addObservabilityTools(server: McpServer, config: BrowserStackConfig): void;

package/dist/tools/observability.js

@@ -2,19 +2,22 @@ import { z } from "zod";
 import { getLatestO11YBuildInfo } from "../lib/api.js";
 import { trackMCP } from "../lib/instrumentation.js";
 import logger from "../logger.js";
-export async function getFailuresInLastRun(buildName, projectName) {
-    const buildsData = await getLatestO11YBuildInfo(buildName, projectName);
-    const observabilityUrl = buildsData.observability_url;
+export async function getFailuresInLastRun(buildName, projectName, config) {
+    const buildsData = await getLatestO11YBuildInfo(buildName, projectName, config);
+    if (!buildsData.data) {
+        throw new Error("No observability URL found in build data, this is likely because the build is not yet available on BrowserStack Observability.");
+    }
+    const observabilityUrl = buildsData.data.observability_url;
     if (!observabilityUrl) {
         throw new Error("No observability URL found in build data, this is likely because the build is not yet available on BrowserStack Observability.");
     }
     let overview = "No overview available";
-    if (buildsData.unique_errors?.overview?.insight) {
-        overview = buildsData.unique_errors.overview.insight;
+    if (buildsData.data.unique_errors?.overview?.insight) {
+        overview = buildsData.data.unique_errors.overview.insight;
     }
     let details = "No error details available";
-    if (buildsData.unique_errors?.top_unique_errors?.length > 0) {
-        details = buildsData.unique_errors.top_unique_errors
+    if (buildsData.data.unique_errors?.top_unique_errors?.length > 0) {
+        details = buildsData.data.unique_errors.top_unique_errors
             .map((error) => error.error)
             .filter(Boolean)
             .join("\n");
@@ -28,7 +31,7 @@ export async function getFailuresInLastRun(buildName, projectName) {
         ],
     };
 }
-export default function addObservabilityTools(server) {
+export default function addObservabilityTools(server, config) {
     server.tool("getFailuresInLastRun", "Use this tool to debug failures in the last run of the test suite on BrowserStack. Use only when browserstack.yml file is present in the project root.", {
         buildName: z
             .string()
@@ -38,12 +41,12 @@ export default function addObservabilityTools(server) {
             .describe("Name of the project to get failures for. This is the 'projectName' key in the browserstack.yml file. If not sure, ask the user for the project name."),
     }, async (args) => {
         try {
-            trackMCP("getFailuresInLastRun", server.server.getClientVersion());
-            return await getFailuresInLastRun(args.buildName, args.projectName);
+            trackMCP("getFailuresInLastRun", server.server.getClientVersion(), undefined, config);
+            return await getFailuresInLastRun(args.buildName, args.projectName, config);
         }
         catch (error) {
             logger.error("Failed to get failures in the last run: %s", error);
-            trackMCP("getFailuresInLastRun", server.server.getClientVersion(), error);
+            trackMCP("getFailuresInLastRun", server.server.getClientVersion(), error, config);
             return {
                 content: [
                     {

package/dist/tools/sdk-utils/commands.d.ts

@@ -0,0 +1,3 @@
+import { SDKSupportedLanguage } from "./types.js";
+export declare function getSDKPrefixCommand(language: SDKSupportedLanguage, framework: string, username: string, accessKey: string): string;
+export declare function getJavaFrameworkForMaven(framework: string): string;

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

@@ -4,6 +4,7 @@ const JAVA_FRAMEWORK_MAP = {
     junit5: "junit5",
     junit4: "junit4",
     cucumber: "cucumber-testng",
+    serenity: "serenity",
 };
 // Common Gradle setup instructions (platform-independent)
 const GRADLE_SETUP_INSTRUCTIONS = `
@@ -17,7 +18,7 @@ const GRADLE_SETUP_INSTRUCTIONS = `
 3. Add javaagent to gradle tasks:
    jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
 `;
-export function getSDKPrefixCommand(language, framework) {
+export function getSDKPrefixCommand(language, framework, username, accessKey) {
     switch (language) {
         case "nodejs":
             return `---STEP---
@@ -28,7 +29,7 @@ npm i -D browserstack-node-sdk@latest
 ---STEP---
 Run the following command to setup browserstack sdk:
 \`\`\`bash
-npx setup --username ${process.env.BROWSERSTACK_USERNAME} --key ${process.env.BROWSERSTACK_ACCESS_KEY}
+npx setup --username ${username} --key ${accessKey}
 \`\`\`
 ---STEP---
 Edit the browserstack.yml file that was created in the project root to add your desired platforms and browsers.`;
@@ -40,8 +41,8 @@ Edit the browserstack.yml file that was created in the project root to add your
                 : `mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \\
 -DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.0 \\
 -DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.0 \\
--DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" \\
--DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" \\
+-DBROWSERSTACK_USERNAME="${username}" \\
+-DBROWSERSTACK_ACCESS_KEY="${accessKey}" \\
 -DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`;
             const platformLabel = isWindows ? "Windows" : "macOS/Linux";
             return `---STEP---

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

@@ -0,0 +1,2 @@
+import { ConfigMapping } from "./types.js";
+export declare const SUPPORTED_CONFIGURATIONS: ConfigMapping;

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

@@ -1,8 +1,7 @@
-import config from "../../config.js";
 /**
  * ---------- PYTHON INSTRUCTIONS ----------
  */
-const pythonInstructions = `
+const pythonInstructions = (username, accessKey) => `
 ---STEP---
 
 Install the BrowserStack SDK:
@@ -14,7 +13,7 @@ python3 -m pip install browserstack-sdk
 
 Setup the BrowserStack SDK with your credentials:
 \`\`\`bash
-browserstack-sdk setup --username "${config.browserstackUsername}" --key "${config.browserstackAccessKey}"
+browserstack-sdk setup --username "${username}" --key "${accessKey}"
 \`\`\`
 
 ---STEP---
@@ -24,10 +23,11 @@ Run your tests on BrowserStack:
 browserstack-sdk python <path-to-test-file>
 \`\`\`
 `;
-const generatePythonFrameworkInstructions = (framework) => `
+const generatePythonFrameworkInstructions = (framework) => (username, accessKey) => `
 ---STEP---
 
 Install the BrowserStack SDK:
+
 \`\`\`bash
 python3 -m pip install browserstack-sdk
 \`\`\`
@@ -36,7 +36,7 @@ python3 -m pip install browserstack-sdk
 
 Setup the BrowserStack SDK with framework-specific configuration:
 \`\`\`bash
-browserstack-sdk setup --framework "${framework}" --username "${config.browserstackUsername}" --key "${config.browserstackAccessKey}"
+browserstack-sdk setup --framework "${framework}" --username "${username}" --key "${accessKey}"
 \`\`\`
 
 ---STEP---
@@ -53,7 +53,7 @@ const pytestInstructions = generatePythonFrameworkInstructions("pytest");
  * ---------- JAVA INSTRUCTIONS ----------
  */
 const argsInstruction = '<argLine>-javaagent:"${com.browserstack:browserstack-java-sdk:jar}"</argLine>';
-const javaInstructions = `
+const javaInstructions = (username, accessKey) => `
 ---STEP---
 
 Add the BrowserStack Java SDK dependency to your \`pom.xml\`:
@@ -79,8 +79,8 @@ dependencies {
 
 Export your BrowserStack credentials as environment variables:
 \`\`\`bash
-export BROWSERSTACK_USERNAME=${config.browserstackUsername}
-export BROWSERSTACK_ACCESS_KEY=${config.browserstackAccessKey}
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
 \`\`\`
 
 ---STEP---
@@ -95,10 +95,66 @@ Or for Gradle:
 gradle clean test
 \`\`\`
 `;
+const serenityInstructions = (username, accessKey) => `
+---STEP---
+
+Set BrowserStack credentials as environment variables:
+For macOS/Linux:
+\`\`\`bash
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\`
+
+For Windows Command Prompt:
+\`\`\`cmd
+set BROWSERSTACK_USERNAME=${username}
+set BROWSERSTACK_ACCESS_KEY=${accessKey}
+\`\`\`
+
+---STEP---
+
+Add serenity-browserstack dependency in pom.xml:
+Add the following dependency to your pom.xml file and save it:
+\`\`\`xml
+<dependency>
+  <groupId>net.serenity-bdd</groupId>
+  <artifactId>serenity-browserstack</artifactId>
+  <version>3.3.4</version>
+</dependency>
+\`\`\`
+
+---STEP---
+
+Set up serenity.conf file:
+Create or update your serenity.conf file in the project root with the following configuration:
+\`\`\`
+webdriver {
+  driver = remote
+  remote.url = "https://hub.browserstack.com/wd/hub"
+}
+browserstack.user="${username}"
+browserstack.key="${accessKey}"
+\`\`\`
+
+---STEP---
+
+Run your Serenity tests:
+You can continue running your tests as you normally would. For example:
+
+Using Maven:
+\`\`\`bash
+mvn clean verify
+\`\`\`
+
+Using Gradle:
+\`\`\`bash
+gradle clean test
+\`\`\`
+`;
 /**
  * ---------- CSharp INSTRUCTIONS ----------
  */
-const csharpCommonInstructions = `
+const csharpCommonInstructions = (username, accessKey) => `
 ---STEP---
 
 Install BrowserStack TestAdapter NuGet package:
@@ -117,7 +173,7 @@ dotnet build
 
 Set up BrowserStack SDK with your credentials:
 \`\`\`bash
-dotnet browserstack-sdk setup --userName ${config.browserstackUsername} --accessKey ${config.browserstackAccessKey}
+dotnet browserstack-sdk setup --userName ${username} --accessKey ${accessKey}
 \`\`\`
 
 ---STEP---
@@ -160,7 +216,7 @@ Run the tests:
   dotnet test
   \`\`\`
 `;
-const csharpPlaywrightCommonInstructions = `
+const csharpPlaywrightCommonInstructions = (username, accessKey) => `
 ---STEP---
 
 Install BrowserStack TestAdapter NuGet package:
@@ -179,7 +235,7 @@ dotnet build
 
 Set up BrowserStack SDK with your credentials:
 \`\`\`bash
-dotnet browserstack-sdk setup --userName ${config.browserstackUsername} --accessKey ${config.browserstackAccessKey}
+dotnet browserstack-sdk setup --userName ${username} --accessKey ${accessKey}
 \`\`\`
 
 ---STEP---
@@ -238,7 +294,7 @@ Run the tests:
 /**
  * ---------- NODEJS INSTRUCTIONS ----------
  */
-const nodejsInstructions = `
+const nodejsInstructions = (username, accessKey) => `
 ---STEP---
 
 Ensure \`browserstack-node-sdk\` is present in package.json with the latest version:
@@ -259,11 +315,15 @@ Add new scripts to package.json for running tests on BrowserStack:
 
 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 CONFIG ----------
  */
-const webdriverioInstructions = `
+const webdriverioInstructions = (username, accessKey) => `
 ---STEP---
 
 Set BrowserStack Credentials:
@@ -271,14 +331,14 @@ Export your BrowserStack username and access key as environment variables.
 
 For macOS/Linux:
 \`\`\`bash
-export BROWSERSTACK_USERNAME= ${config.browserstackUsername}
-export BROWSERSTACK_ACCESS_KEY= ${config.browserstackAccessKey}
+export BROWSERSTACK_USERNAME=${username}
+export BROWSERSTACK_ACCESS_KEY=${accessKey}
 \`\`\`
 
 For Windows PowerShell:
 \`\`\`powershell
-$env:BROWSERSTACK_USERNAME=${config.browserstackUsername}
-$env:BROWSERSTACK_ACCESS_KEY=${config.browserstackAccessKey}
+$env:BROWSERSTACK_USERNAME=${username}
+$env:BROWSERSTACK_ACCESS_KEY=${accessKey}
 \`\`\`
 
 ---STEP---
@@ -368,7 +428,7 @@ exports.config.capabilities.forEach(function (caps) {
 Run your tests:
 You can now run your tests on BrowserStack using your standard WebdriverIO command.
 `;
-const cypressInstructions = `
+const cypressInstructions = (username, accessKey) => `
 ---STEP---
 
 Install the BrowserStack Cypress CLI:
@@ -397,8 +457,8 @@ Open the generated \`browserstack.json\` file and update it with your BrowserSta
 \`\`\`json
 {
   "auth": {
-    "username": "${config.browserstackUsername}",
-    "access_key": "${config.browserstackAccessKey}"
+    "username": "${username}",
+    "access_key": "${accessKey}"
   },
   "browsers": [
     {
@@ -462,6 +522,7 @@ export const SUPPORTED_CONFIGURATIONS = {
             cucumber: { instructions: javaInstructions },
             junit4: { instructions: javaInstructions },
             junit5: { instructions: javaInstructions },
+            serenity: { instructions: serenityInstructions },
         },
     },
     csharp: {

package/dist/tools/sdk-utils/instructions.d.ts

@@ -0,0 +1,6 @@
+import { SDKSupportedLanguage } from "./types.js";
+import { SDKSupportedBrowserAutomationFramework } from "./types.js";
+import { SDKSupportedTestingFramework } from "./types.js";
+export declare const getInstructionsForProjectConfiguration: (detectedBrowserAutomationFramework: SDKSupportedBrowserAutomationFramework, detectedTestingFramework: SDKSupportedTestingFramework, detectedLanguage: SDKSupportedLanguage, username: string, accessKey: string) => string;
+export declare function generateBrowserStackYMLInstructions(desiredPlatforms: string[], enablePercy?: boolean): string;
+export declare function formatInstructionsWithNumbers(instructionText: string, separator?: string): string;

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

@@ -1,6 +1,6 @@
 import { SUPPORTED_CONFIGURATIONS } from "./constants.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) => {
+export const getInstructionsForProjectConfiguration = (detectedBrowserAutomationFramework, detectedTestingFramework, detectedLanguage, username, accessKey) => {
     const configuration = SUPPORTED_CONFIGURATIONS[detectedLanguage];
     if (!configuration) {
         throw new Error(`BrowserStack MCP Server currently does not support ${detectedLanguage}, ${errorMessageSuffix}`);
@@ -11,17 +11,19 @@ export const getInstructionsForProjectConfiguration = (detectedBrowserAutomation
     if (!configuration[detectedBrowserAutomationFramework][detectedTestingFramework]) {
         throw new Error(`BrowserStack MCP Server currently does not support ${detectedTestingFramework} for ${detectedBrowserAutomationFramework} on ${detectedLanguage}, ${errorMessageSuffix}`);
     }
-    return configuration[detectedBrowserAutomationFramework][detectedTestingFramework].instructions;
+    const instructionFunction = configuration[detectedBrowserAutomationFramework][detectedTestingFramework]
+        .instructions;
+    return instructionFunction(username, accessKey);
 };
 export function generateBrowserStackYMLInstructions(desiredPlatforms, enablePercy = false) {
     let ymlContent = `
 # ======================
 # BrowserStack Reporting
 # ======================
-# A single name for your project to organize all your tests. This is required for Percy.
-projectName: BrowserStack SDK Tests
-# A name for the group of tests you are running
-buildName: mcp-run
+# Project and build names help organize your test runs in BrowserStack dashboard and Percy.
+# TODO: Replace these sample values with your actual project details
+projectName: Sample Project
+buildName: Sample Build
 
 # =======================================
 # Platforms (Browsers / Devices to test)

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

@@ -0,0 +1,3 @@
+import { PercyConfigMapping } from "./types.js";
+export declare const nodejsSeleniumInstructions = "\nImport the BrowserStack Percy SDK in your test script:\nAdd the Percy import to your test file.\n\n---STEP---\n\nAdd screenshot capture method at required points:\nUse the `percy.snapshot(driver, name)` method at points in your test script where you want to capture screenshots.\n\n```javascript\nconst { percy } = require('browserstack-node-sdk');\ndescribe(\"sample Test\", () => {\n  // ... other imports and setup\n  \n  test(\"my test\", async () => {\n    // ....\n    await percy.snapshot(driver, \"My Snapshot\")\n    // ....\n  });\n})\n```\n";
+export declare const PERCY_INSTRUCTIONS: PercyConfigMapping;

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

@@ -153,6 +153,7 @@ export const PERCY_INSTRUCTIONS = {
             cucumber: { script_updates: javaSeleniumInstructions },
             junit4: { script_updates: javaSeleniumInstructions },
             junit5: { script_updates: javaSeleniumInstructions },
+            serenity: { script_updates: javaSeleniumInstructions },
         },
     },
     csharp: {

package/dist/tools/sdk-utils/percy/instructions.d.ts

@@ -0,0 +1,10 @@
+import { SDKSupportedBrowserAutomationFramework, SDKSupportedLanguage, SDKSupportedTestingFramework } from "../types.js";
+import { PercyInstructions } from "./types.js";
+/**
+ * Retrieves Percy-specific instructions for a given language and framework.
+ */
+export declare function getPercyInstructions(language: SDKSupportedLanguage, automationFramework: SDKSupportedBrowserAutomationFramework, testingFramework: SDKSupportedTestingFramework): PercyInstructions | null;
+/**
+ * Formats the retrieved Percy instructions into a user-friendly string.
+ */
+export declare function formatPercyInstructions(instructions: PercyInstructions): string;

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

@@ -0,0 +1,5 @@
+import { SDKSupportedBrowserAutomationFramework, SDKSupportedLanguage, SDKSupportedTestingFramework } from "../types.js";
+export interface PercyInstructions {
+    script_updates: string;
+}
+export type PercyConfigMapping = Partial<Record<SDKSupportedLanguage, Partial<Record<SDKSupportedBrowserAutomationFramework, Partial<Record<SDKSupportedTestingFramework, PercyInstructions>>>>>>;