enhance Percy integration support

Author: tech-sushant

src/tools/add-percy-snapshots.ts

@@ -15,6 +15,7 @@ async function updateTestsWithPercyCommands(args: {
   if (!filePaths) {
     throw new Error(`No test files found in memory for UUID: ${uuid}`);
   }
+
   if (index < 0 || index >= filePaths.length) {
     throw new Error(
       `Invalid index: ${index}. There are ${filePaths.length} files for UUID: ${uuid}`,

src/tools/percy-snapshot-utils/utils.ts

@@ -18,7 +18,7 @@ export async function updateFileAndStep(
     type: "text",
     text: `Step 1 : You need to add percy snapshot commands in some key test cases in the file ${file} use the following instructions: \n${instruction}`,
   });
-    
+
   content.push({
     type: "text",
     text: `Step 2 : Confirm that Percy snapshot commands have been added at all key points of visual change in the file ${file}.`,
@@ -30,5 +30,13 @@ export async function updateFileAndStep(
       text: `Step 3 : Call the tool updateTestFileWithInstructions with index as ${nextIndex} out of ${total}`,
     });
   }
+
+  if (nextIndex === total) {
+    content.push({
+      type: "text",
+      text: `Step 4: Percy snapshot commands have been added to all files. You can now run the Percy build using the above command.`,
+    });
+  }
+
   return content;
 }

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

@@ -8,14 +8,14 @@ export const RUN_ON_BROWSERSTACK_DESCRIPTION =
   "Set up and run automated web-based tests on BrowserStack using the BrowserStack SDK. Use this tool for functional or integration test setup on BrowserStack only. For any visual testing or Percy integration, use the dedicated Percy setup tool. Example prompts: run this test on browserstack; set up this project for browserstack.";
 
 export const SIMULATE_PERCY_CHANGE_DESCRIPTION =
-  "This tool helps new users simulate a Percy visual change by guiding them to make a visible UI modification, rerun Percy, and verify that the change is detected.";
+  "This tool helps new users simulate a Percy visual change by guiding them to make a visible UI modification, rerun Percy, and verify that the change is detected. Only Percy web is supported";
 
 export const PERCY_REPLACE_REGEX =
-  /MANDATORY: Aggressive, Exhaustive Percy Snapshot Integration[\s\S]*?Iteratively update every relevant test file in the directory and all subdirectories, adding Percy integration to each, one file at a time, until all are complete\./;
+  /Invoke listTestFiles\(\) with the provided directories[\s\S]*?- DO NOT STOP until you add commands in all the files or you reach end of the files\./;
 
 export const PERCY_SNAPSHOT_INSTRUCTION = `
 Invoke listTestFiles() with the provided directories from user to gather all test files in memory and obtain the generated UUID ---STEP---
-Process files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions as param:
+Process files in STRICT sequential order using tool addPercySnapshotCommands() with below instructions:
 - Start with index 0
 - Then index 1  
 - Then index 2
@@ -78,6 +78,8 @@ STEP 4: Run a second Percy build.
 
 STEP 5: Compare the two Percy builds to see the detected visual difference.
 
+STEP 6: Now ask user if they want to setup percy for full project coverage? If yes, call the tool "setupPercyVisualTesting" tool to enable complete coverage for the entire project.
+
 CONSTRAINTS:
 - Do NOT run any builds until explicitly instructed in the steps.
 - Do NOT add new snapshot names—only use existing ones.

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

@@ -108,3 +108,21 @@ Percy Mode: ${context.percyMode ?? "automate"}
 SDK Version: ${context.sdkVersion ?? "N/A"}
 Please open an issue on GitHub if the problem persists.`;
 }
+
+export function percyUnsupportedResult(
+  integrationType: PercyIntegrationTypeEnum,
+  supportCheck?: { errorMessage?: string },
+): CallToolResult {
+  const defaultMessage = `Percy ${integrationType} integration is not supported for this configuration.`;
+
+  return {
+    content: [
+      {
+        type: "text",
+        text: supportCheck?.errorMessage || defaultMessage,
+      },
+    ],
+    isError: true,
+    shouldSkipFormatting: true,
+  };
+}

src/tools/sdk-utils/handler.ts

@@ -2,7 +2,10 @@ import {
   SetUpPercySchema,
   RunTestsOnBrowserStackSchema,
 } from "./common/schema.js";
-import { getBootstrapFailedMessage } from "./common/utils.js";
+import {
+  getBootstrapFailedMessage,
+  percyUnsupportedResult,
+} from "./common/utils.js";
 import { formatToolResult } from "./common/utils.js";
 import { BrowserStackConfig } from "../../lib/types.js";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
@@ -61,27 +64,23 @@ export async function setUpPercyHandler(
       folderPaths: input.folderPaths || [],
     };
 
+    // Check for Percy Web integration support
     if (input.integrationType === PercyIntegrationTypeEnum.WEB) {
       const supportCheck = checkPercyIntegrationSupport(percyInput);
       if (!supportCheck.supported) {
-        return {
-          content: [
-            {
-              type: "text",
-              text:
-                supportCheck.errorMessage ||
-                "Percy Web integration is not supported for this configuration.",
-            },
-          ],
-          isError: true,
-          shouldSkipFormatting: true,
-        };
+        return percyUnsupportedResult(
+          PercyIntegrationTypeEnum.WEB,
+          supportCheck,
+        );
       }
+
+      // Fetch the Percy token
       const percyToken = await fetchPercyToken(
         input.projectName,
         authorization,
         { type: PercyIntegrationTypeEnum.WEB },
       );
+
       const result = runPercyWeb(percyInput, percyToken);
       return await formatToolResult(result);
     } else if (input.integrationType === PercyIntegrationTypeEnum.AUTOMATE) {
@@ -115,18 +114,10 @@ export async function setUpPercyHandler(
           integrationType: PercyIntegrationTypeEnum.AUTOMATE,
         });
         if (!supportCheck.supported) {
-          return {
-            content: [
-              {
-                type: "text",
-                text:
-                  supportCheck.errorMessage ||
-                  "Percy Automate integration is not supported for this configuration.",
-              },
-            ],
-            isError: true,
-            shouldSkipFormatting: true,
-          };
+          return percyUnsupportedResult(
+            PercyIntegrationTypeEnum.AUTOMATE,
+            supportCheck,
+          );
         }
         // SDK setup instructions (for Automate, without Percy)
         const sdkInput = {
@@ -148,6 +139,7 @@ export async function setUpPercyHandler(
           percyInput,
           percyToken,
         );
+
         // Combine steps: warning, SDK steps, Percy Automate steps
         const steps = [
           {
@@ -159,6 +151,8 @@ export async function setUpPercyHandler(
           ...(sdkResult.steps || []),
           ...(percyAutomateResult.steps || []),
         ];
+
+        // Combine all steps into the final result
         return await formatToolResult({
           ...percyAutomateResult,
           steps,

src/tools/sdk-utils/percy-web/constants.ts

@@ -538,7 +538,6 @@ class PercyPlaywrightExample
 \`\`\`
 `;
 
-
 export const pythonInstructions = `
 Install Percy dependencies
   - Install Percy CLI:
@@ -979,4 +978,4 @@ Run Percy with your tests
     npx percy exec -- dotnet test
 
 ${percyReviewSnapshotsStep}
-`;
+`;