Skip to content

Commit d2ad99b

Browse files
committed
fix: added and updated tools in Readme
1 parent 5e2020b commit d2ad99b

1 file changed

Lines changed: 197 additions & 22 deletions

File tree

README.md

Lines changed: 197 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,9 @@ Select the “Installed” tab. Click the “Configure MCP Servers” button at
292292
293293
### 💡 List of BrowserStack MCP Tools
294294
295-
As of now we support 20 tools.
295+
As of now we support 44 tools.
296+
297+
> **Remote MCP note:** Tools marked _(not available in Remote MCP)_ rely on local file/process state and are disabled in the multi-tenant [Remote MCP Server](#-remote-mcp-server). They are available in the local (npx) setup.
296298
297299
---
298300
@@ -313,60 +315,109 @@ As of now we support 20 tools.
313315
Add a test case named 'Invalid Login Scenario' to the Login folder in the 'Shopping App' project with PR-53617, Folder ID: 117869
314316
```
315317
316-
3. `listTestCases` — List test cases for a project (supports filters like priority, status, tags).
318+
3. `updateTestCase` — Update an existing test case. Any subset of fields may be changed (name, priority, status, steps, tags, etc.); only supplied fields are modified.
319+
**Prompt example**
320+
321+
```text
322+
Update test case TC-482 in the 'Shopping App' project and set its priority to high
323+
```
324+
325+
4. `listTestCases` — List test cases for a project, optionally scoped to a folder (supports filters like case_type, priority, and pagination).
317326
**Prompt example**
318327
319328
```text
320329
List all high-priority test cases in the 'Shopping App' project with project_identifier: PR-59457
321330
```
322331
323-
4. `createTestRun` — Create a test run (suite) for selected test cases in a project.
332+
5. `listFolders` — List folders in a Test Management project (returns each folder's id, name, case counts, and sub-folder counts). Pass a parent_id to list sub-folders.
333+
**Prompt example**
334+
335+
```text
336+
List all folders in the 'Shopping App' project with project_identifier: PR-59457
337+
```
338+
339+
6. `listTestCaseTemplates` — List test-case templates with their numeric template_id, for use with `createTestCase` to apply a custom template.
340+
**Prompt example**
341+
342+
```text
343+
List the available test case templates in the 'Shopping App' project
344+
```
345+
346+
7. `createTestRun` — Create a test run (suite) for selected test cases in a project.
324347
**Prompt example**
325348
326349
```text
327350
Create a test run for the Login folder in the 'Shopping App' project and name it 'Release v1.0 Login Flow'
328351
```
329352
330-
5. `listTestRuns` — List test runs for a project (filter by dates, assignee, state).
353+
8. `listTestRuns` — List test runs for a project (filter by dates, assignee, state).
331354
**Prompt example**
332355
333356
```text
334357
List all test runs from the 'Shopping App' project that were executed last week and are currently marked in-progress
335358
```
336359
337-
6. `updateTestRun` — Update a test run's name/state and/or add test cases to it.
360+
9. `updateTestRun` — Update a test run's name/state and/or add test cases to it.
338361
**Prompt example**
339362
340363
```text
341364
Update test run ID 1043 in the 'Shopping App' project and mark it as complete with the note 'Regression cycle done'
342365
```
343366
344-
7. `addTestResult` — Add a manual execution result (passed/failed/blocked/skipped) for a test case within a run.
367+
10. `addTestResult` — Add a manual execution result (passed/failed/blocked/skipped) for a test case within a run.
345368
**Prompt example**
346369
347370
```text
348371
Mark the test case 'Invalid Login Scenario' as passed in test run ID 1043 of the 'Shopping App' project
349372
```
350373
351-
8. `createTestCasesFromFile`Bulk-create test cases from an uploaded file (e.g., PDF).
374+
11. `createTestCasesFromFile` — Generate test cases in bulk from an uploaded file using the Test Case Generator AI Agent. _(not available in Remote MCP)_
352375
**Prompt example**
353376
354377
```text
355378
Upload test cases from '/Users/xyz/testcases.pdf' to the 'Shopping App' project in Test Management
356379
```
357380
381+
12. `listTestPlans` — List test plans (TP-*) in a project, with name, status, dates, and active/closed run counts. Supports pagination.
382+
**Prompt example**
383+
384+
```text
385+
List all test plans in the 'Shopping App' project with project_identifier: PR-59457
386+
```
387+
388+
13. `getTestPlan` — Fetch a test plan by identifier (TP-*) with its metadata, linked test runs, total test-case count, and status summary.
389+
**Prompt example**
390+
391+
```text
392+
Get the details of test plan TP-120 in the 'Shopping App' project
393+
```
394+
395+
14. `listSubTestPlans` — List sub-test-plans (STP-*) under a parent test plan (TP-*). Supports pagination.
396+
**Prompt example**
397+
398+
```text
399+
List sub-test-plans under test plan TP-120 in the 'Shopping App' project
400+
```
401+
402+
15. `getSubTestPlan` — Fetch a sub-test-plan (STP-*) under a parent plan, with its metadata and linked test runs.
403+
**Prompt example**
404+
405+
```text
406+
Get sub-test-plan STP-45 under test plan TP-120 in the 'Shopping App' project
407+
```
408+
358409
---
359410
360411
## ⚙️ BrowserStack SDK Setup / Automate Test
361412
362-
9. `setupBrowserStackAutomateTests` — Integrate BrowserStack SDK and run web tests on BrowserStack (optionally enable Percy).
413+
16. `setupBrowserStackAutomateTests` — Integrate BrowserStack SDK and run web tests on BrowserStack. For visual testing/Percy, use the dedicated Percy tools.
363414
**Prompt example**
364415
365416
```text
366-
Run my Selenium-JUnit5 tests written in Java on Chrome and Firefox. Enable Percy for visual testing.
417+
Run my Selenium-JUnit5 tests written in Java on Chrome and Firefox.
367418
```
368419
369-
10. `fetchAutomationScreenshots` — Fetch screenshots captured during a given Automate/App Automate session.
420+
17. `fetchAutomationScreenshots` — Fetch screenshots captured during a given Automate/App Automate session.
370421
**Prompt example**
371422
372423
```text
@@ -377,18 +428,25 @@ As of now we support 20 tools.
377428
378429
## 🔍 Observability
379430
380-
11. `getFailureLogs` — Retrieve error logs for Automate/App Automate sessions (optionally by Build ID for App Automate).
431+
18. `getFailureLogs` — Retrieve error logs for Automate/App Automate sessions (optionally by Build ID for App Automate).
381432
**Prompt example**
382433
383434
```text
384435
Get the error logs from the session ID: 21a864032a7459f1e7634222249b316759d6827f, Build ID: dt7ung4wmjittzff8kksrjadjax9gzvbscoyf9qn of App Automate test session
385436
```
386437
438+
19. `fetchBuildInsights` — Fetch insights about a BrowserStack build by combining build details and quality-gate results.
439+
**Prompt example**
440+
441+
```text
442+
Get the build insights for build UUID <your-build-uuid> on BrowserStack
443+
```
444+
387445
---
388446
389447
## 📱 App Live
390448
391-
12. `runAppLiveSession` — Start a manual app testing session on a real device in the cloud.
449+
20. `runAppLiveSession` — Start a manual app testing session on a real device in the cloud.
392450
**Prompt example**
393451
394452
```text
@@ -399,7 +457,7 @@ As of now we support 20 tools.
399457
400458
## 💻 Live
401459
402-
13. `runBrowserLiveSession` — Start a Live session for website testing on desktop or mobile browsers.
460+
21. `runBrowserLiveSession` — Start a Live session for website testing on desktop or mobile browsers.
403461
**Prompt example**
404462
405463
```text
@@ -410,62 +468,179 @@ As of now we support 20 tools.
410468
411469
## 📲 App Automate
412470
413-
14. `takeAppScreenshot` — Launch the app on a specified device and captures a quick verification screenshot. This tool is just to verify whether your app has been launched.
471+
22. `takeAppScreenshot` — Launch the app on a specified device and capture a quick verification screenshot to confirm your app has launched.
414472
**Prompt example**
415473
416474
```text
417475
Take a screenshot of my app on Google Pixel 6 with Android 12 while testing on App Automate. App file path: /Users/xyz/app-debug.apk
418476
```
419477
420-
15. `runAppTestsOnBrowserStack` — Run automated mobile tests (Espresso/XCUITest, etc.) on real devices.
478+
23. `runAppTestsOnBrowserStack` — Run pre-built native mobile test suites (Espresso/XCUITest) by direct upload of compiled .apk/.ipa test files.
421479
**Prompt example**
422480
423481
```text
424482
Run Espresso tests from /tests/checkout.zip on Galaxy S21 and Pixel 6 with Android 12. App path is /apps/beta-release.apk under project 'Checkout Flow'
425483
```
426484
485+
24. `setupBrowserStackAppAutomateTests` — Set up BrowserStack App Automate SDK integration for Appium-based mobile app testing.
486+
**Prompt example**
487+
488+
```text
489+
Set up my Appium test suite to run on BrowserStack App Automate
490+
```
491+
427492
---
428493
429494
## ♿ Accessibility
430495
431-
16. `accessibilityExpert` — Ask A11y Expert (WCAG 2.0/2.1/2.2, mobile/web usability, best practices).
496+
25. `accessibilityExpert` — Ask the A11y Expert (WCAG 2.0/2.1/2.2, mobile/web usability, best practices).
432497
**Prompt example**
433498
434499
```text
435500
What WCAG guidelines apply to form field error messages on mobile web?
436501
```
437502
438-
17. `startAccessibilityScan` — Start a web accessibility scan and return the result link.
503+
26. `startAccessibilityScan` — Start a web accessibility scan and retrieve a local CSV report path.
439504
**Prompt example**
440505
441506
```text
442507
Run accessibility scan for "www.example.com"
443508
```
444509
510+
27. `createAccessibilityAuthConfig` — Create an authentication configuration (form-based or basic) for accessibility scans behind a login.
511+
**Prompt example**
512+
513+
```text
514+
Create a basic-auth accessibility config named 'site-login' for https://www.example.com with username testuser and password <password>
515+
```
516+
517+
28. `getAccessibilityAuthConfig` — Retrieve an existing accessibility authentication configuration by ID.
518+
**Prompt example**
519+
520+
```text
521+
Get accessibility auth config with ID <config-id>
522+
```
523+
524+
29. `fetchAccessibilityIssues` — Fetch accessibility issues from a completed scan, with pagination support.
525+
**Prompt example**
526+
527+
```text
528+
Fetch the accessibility issues for scan ID <scan-id> and scan run ID <scan-run-id>
529+
```
530+
531+
---
532+
533+
## 🎨 Percy Visual Testing
534+
535+
30. `percyVisualTestIntegrationAgent` — Integrate Percy visual testing into a new project and demonstrate visual change detection with a step-by-step simulation.
536+
**Prompt example**
537+
538+
```text
539+
Integrate Percy for this project
540+
```
541+
542+
31. `expandPercyVisualTesting` — Set up or expand Percy visual testing coverage for existing projects (Percy Web Standalone and Percy Automate).
543+
**Prompt example**
544+
545+
```text
546+
Expand Percy coverage for this project
547+
```
548+
549+
32. `addPercySnapshotCommands` — Add Percy snapshot commands to the specified test files. _(not available in Remote MCP)_
550+
**Prompt example**
551+
552+
```text
553+
Add Percy snapshot commands to my Cypress test files
554+
```
555+
556+
33. `listTestFiles` — List all test files for a given set of directories. _(not available in Remote MCP)_
557+
**Prompt example**
558+
559+
```text
560+
List the test files under my ./tests directory
561+
```
562+
563+
34. `runPercyScan` — Run a Percy visual test scan. _(not available in Remote MCP)_
564+
**Prompt example**
565+
566+
```text
567+
Run this Percy build
568+
```
569+
570+
35. `fetchPercyChanges` — Retrieve and summarize visual changes detected by Percy AI between the latest and previous builds.
571+
**Prompt example**
572+
573+
```text
574+
Summarize the visual changes Percy detected in my latest build
575+
```
576+
577+
36. `managePercyBuildApproval` — Approve or reject a Percy build.
578+
**Prompt example**
579+
580+
```text
581+
Approve the latest Percy build
582+
```
583+
445584
---
446585
447586
## 🤖 BrowserStack AI Agents
448587
449-
18. `fetchSelfHealedSelectors`Retrieve AI self-healed selectors to fix flaky tests due to DOM changes.
588+
37. `uploadProductRequirementFile` — Upload a PRD/screenshot/PDF and get a file mapping ID (used with `createTestCasesFromFile`). _(not available in Remote MCP)_
450589
**Prompt example**
451590
452591
```text
453-
Fetch and fix flaky test selectors in Automate session ID session_9482 using MCP
592+
Upload PRD from /Users/xyz/Desktop/login-flow.pdf and use BrowserStack AI to generate test cases
454593
```
455594
456-
19. `createLCASteps` — Generate Low Code Automation steps from a manual test case in Test Management.
595+
38. `createLCASteps` — Generate Low Code Automation (LCA) steps from a manual test case in Test Management.
457596
**Prompt example**
458597
459598
```text
460599
Convert the manual test case 'Add to Cart' in the 'Shopping App' project into LCA steps
461600
```
462601
463-
20. `uploadProductRequirementFile`Upload a PRD/screenshot/PDF and get a file mapping ID (used with `createTestCasesFromFile`).
602+
39. `fetchSelfHealedSelectors` — Retrieve AI self-healed selectors (plus test source) to fix flaky tests caused by DOM changes.
464603
**Prompt example**
465604
466605
```text
467-
Upload PRD from /Users/xyz/Desktop/login-flow.pdf and use BrowserStack AI to generate test cases
606+
Fetch and fix flaky test selectors in Automate session ID session_9482 using MCP
607+
```
608+
609+
40. `prepareSelfHealingPlan` — Build a self-healing edit plan that bundles locator pairs with test source for your LLM to apply. Does NOT modify files itself.
610+
**Prompt example**
611+
612+
```text
613+
Prepare a self-healing plan from the self-healed selectors for my build
614+
```
615+
616+
41. `fetchRCA` — Fetch AI Root Cause Analysis for your failed Automate/App-Automate tests (by numeric test ID). Suggests fixes only; never auto-applies.
617+
**Prompt example**
618+
619+
```text
620+
Fetch the root cause analysis for failed test IDs 101 and 102 on BrowserStack
468621
```
622+
623+
42. `getBuildId` — Get the BrowserStack build ID for a given project and build name, scoped to your builds.
624+
**Prompt example**
625+
626+
```text
627+
Get the build ID for build 'nightly-regression' in project 'Checkout Flow'
628+
```
629+
630+
43. `listBuildId` — Get the latest build ID for a project and build name, across all users (no user filter).
631+
**Prompt example**
632+
633+
```text
634+
Get the latest build ID for build 'nightly-regression' in project 'Checkout Flow'
635+
```
636+
637+
44. `listTestIds` — List test IDs from a BrowserStack Automate build, filtered by status (passed/failed/pending/skipped).
638+
**Prompt example**
639+
640+
```text
641+
List the failed test IDs from build UUID <your-build-uuid> on BrowserStack
642+
```
643+
469644
## 🚀 Remote MCP Server
470645
471646
Remote MCP comes with all the functionalities of an MCP server without the hassles of complex setup or local installation.

0 commit comments

Comments
 (0)