refactor: update formatToolResult to accept runType parameter and enhance critical message for non-percy-web runs

Author: tech-sushant

src/tools/sdk-utils/common/schema.ts

@@ -28,9 +28,7 @@ export const SetUpPercyParamsShape = {
 export const RunTestsOnBrowserStackParamsShape = {
   projectName: z
     .string()
-    .describe(
-      "A single name for your project to organize all your tests. This is required for Percy.",
-    ),
+    .describe("A single name for your project to organize all your tests."),
   detectedLanguage: z.nativeEnum(SDKSupportedLanguageEnum),
   detectedBrowserAutomationFramework: z.nativeEnum(
     SDKSupportedBrowserAutomationFrameworkEnum,

src/tools/sdk-utils/common/utils.ts

@@ -47,6 +47,7 @@ export function checkPercyIntegrationSupport(input: {
 
 export async function formatToolResult(
   resultPromise: Promise<RunTestsInstructionResult> | RunTestsInstructionResult,
+  runType?: "percy-web" | "bstack" | "percy-bstack" | "percy-automate",
 ): Promise<CallToolResult> {
   const { steps, requiresPercy, missingDependencies, shouldSkipFormatting } =
     await resultPromise;
@@ -75,6 +76,13 @@ export async function formatToolResult(
     { type: "text" as const, text: verificationMessage },
   ];
 
+  if (runType != "percy-web") {
+    finalContent.push({
+      type: "text",
+      text: "CRITICAL: After the build is run, you MUST explicitly ask the user if they want to perform RCA (Root Cause Analysis) for any failed tests. This step is mandatory and should not be skipped.",
+    });
+  }
+
   return {
     content: finalContent,
     isError: steps.some((s) => s.isError),

src/tools/sdk-utils/handler.ts

@@ -69,7 +69,7 @@ export async function setUpPercyHandler(
       );
 
       const result = runPercyWeb(percyInput, percyToken);
-      return await formatToolResult(result);
+      return await formatToolResult(result, "percy-web");
     } else if (input.integrationType === PercyIntegrationTypeEnum.AUTOMATE) {
       // First try Percy with BrowserStack SDK
       const percyWithBrowserstackSDKResult = runPercyWithBrowserstackSDK(