@browserstack/mcp-server 1.1.8 → 1.2.0

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,10 +18,21 @@ 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 `Install BrowserStack Node SDK\nusing command | npm i -D browserstack-node-sdk@latest\n| and then run following command to setup browserstack sdk:\n npx setup --username ${process.env.BROWSERSTACK_USERNAME} --key ${process.env.BROWSERSTACK_ACCESS_KEY}\n\n. This will create browserstack.yml file in the project root. Edit the file to add your desired platforms and browsers. If the file is not created :\n`;
+            return `---STEP---
+Install BrowserStack Node SDK using command:
+\`\`\`bash
+npm i -D browserstack-node-sdk@latest
+\`\`\`
+---STEP---
+Run the following command to setup browserstack sdk:
+\`\`\`bash
+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.`;
         case "java": {
             const mavenFramework = getJavaFrameworkForMaven(framework);
             const isWindows = process.platform === "win32";
@@ -29,15 +41,18 @@ export function getSDKPrefixCommand(language, framework) {
                 : `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 `Install BrowserStack Java SDK
+            return `---STEP---
+Install BrowserStack Java SDK
 
 **Maven command for ${framework} (${platformLabel}):**
 Run the command, it is required to generate the browserstack-sdk-archetype-integrate project:
 ${mavenCommand}
+
+Alternative setup for Gradle users:
 ${GRADLE_SETUP_INSTRUCTIONS}`;
         }
         // Add more languages as needed

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

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