You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+225Lines changed: 225 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,10 @@ Manage, execute, debug tests, and even fix code using plain English prompts.
35
35
#### Reduced context switching:
36
36
Stay in flow—keep all project context in one place and trigger actions directly from your IDE or LLM.
37
37
38
+
## ⚡️ One Click MCP Setup
39
+
40
+
[](http://mcp.browserstack.com/one-click-setup?client=vscode) [](http://mcp.browserstack.com/one-click-setup?client=cursor)
41
+
38
42
## 💡 Usage Examples
39
43
40
44
### 📱 Manual App Testing
@@ -138,8 +142,13 @@ Generate test cases from PRDs, convert manual tests to low-code automation, and
138
142
139
143
## 🛠️ Installation
140
144
145
+
### **One Click MCP Setup**
146
+
141
147
[](http://mcp.browserstack.com/one-click-setup?client=vscode) [](http://mcp.browserstack.com/one-click-setup?client=cursor)
142
148
149
+
150
+
### **Alternate ways to Setup MCP server**
151
+
143
152
1. **Create a BrowserStack Account**
144
153
145
154
- Sign up for [BrowserStack](https://www.browserstack.com/users/sign_up) if you don't have an account already.
@@ -150,9 +159,21 @@ Generate test cases from PRDs, convert manual tests to low-code automation, and
150
159
- Once you have an account (and purchased appropriate plan), note down your `username` and `access_key` from [Account Settings](https://www.browserstack.com/accounts/profile/details).
151
160
152
161
2. Ensure you are using Node version >= `18.0`. Check your node version using `node --version`. Recommended version: `v22.15.0` (LTS)
In the root directory of your project, look fora folder named .vscode. This folder is usually hidden so you will need to find it as mentionedin the expand.
169
+
170
+
- If this folder doesn't exist, create it.
171
+
172
+
- Inside the .vscode folder, create a new file named mcp.json
173
+
174
+
- Add the Configuration: Open the mcp.json file and then add the following JSON content.
175
+
176
+
- Replace the username and <access_key> with your BrowserStack credentials.
156
177
157
178
```json
158
179
{
@@ -172,6 +193,30 @@ Generate test cases from PRDs, convert manual tests to low-code automation, and
172
193
- In VSCode, make sure to click on `Start` button in the MCP Server to start the server.
173
194

174
195
196
+
197
+
#### ** Alternate way to setup MCP on VSCode Copilot
@@ -233,6 +278,186 @@ To install BrowserStack Test Platform Server for Claude Desktop automatically vi
233
278
npx -y @smithery/cli install @browserstack/mcp-server --client claude
234
279
```
235
280
281
+
282
+
### 💡 List of BrowserStack MCP Tools
283
+
284
+
As of now we support 20 tools.
285
+
286
+
287
+
---
288
+
289
+
## 🧾 Test Management
290
+
291
+
1. `createProjectOrFolder` — Create a Test Management project and/or folders to organize test cases. Returns with Folder ID, Project ID and Test Management Link to access the TM Project Dashboard.
292
+
**Prompt example**
293
+
294
+
```text
295
+
Create a new Test Management project named 'Shopping App' with two folders - Login and Checkout
296
+
```
297
+
298
+
299
+
2. `createTestCase` — Add a manual test case under a specific project/folder (uses project identifier like PR-xxxxx and a folder ID).
300
+
**Prompt example**
301
+
302
+
```text
303
+
Add a test case named 'Invalid Login Scenario' to the Login folder in the 'Shopping App' project with PR-53617, Folder ID: 117869
304
+
```
305
+
306
+
3. `listTestCases` — List test cases for a project (supports filters like priority, status, tags).
307
+
**Prompt example**
308
+
309
+
```text
310
+
List all high-priority test cases in the 'Shopping App' project with project_identifier: PR-59457
311
+
```
312
+
313
+
4. `createTestRun` — Create a test run (suite) for selected test cases in a project.
314
+
**Prompt example**
315
+
316
+
```text
317
+
Create a test run for the Login folder in the 'Shopping App' project and name it 'Release v1.0 Login Flow'
318
+
```
319
+
320
+
5. `listTestRuns` — List test runs for a project (filter by dates, assignee, state).
321
+
**Prompt example**
322
+
323
+
```text
324
+
List all test runs from the 'Shopping App' project that were executed last week and are currently marked in-progress
325
+
```
326
+
327
+
6. `updateTestRun` — Partially update a test run (status, tags, notes, associated test cases).
328
+
**Prompt example**
329
+
330
+
```text
331
+
Update test run ID 1043 in the 'Shopping App' project and mark it as complete with the note 'Regression cycle done'
332
+
```
333
+
334
+
7. `addTestResult` — Add a manual execution result (passed/failed/blocked/skipped) for a test case within a run.
335
+
**Prompt example**
336
+
337
+
```text
338
+
Mark the test case 'Invalid Login Scenario' as passed in test run ID 1043 of the 'Shopping App' project
339
+
```
340
+
341
+
8. `createTestCasesFromFile` — Bulk-create test cases from an uploaded file (e.g., PDF).
342
+
**Prompt example**
343
+
344
+
```text
345
+
Upload test cases from '/Users/xyz/testcases.pdf' to the 'Shopping App' project in Test Management
346
+
```
347
+
348
+
---
349
+
350
+
## ⚙️ BrowserStack SDK Setup / Automate Test
351
+
352
+
9. `setupBrowserStackAutomateTests` — Integrate BrowserStack SDK and run web tests on BrowserStack (optionally enable Percy).
353
+
**Prompt example**
354
+
355
+
```text
356
+
Run my Selenium-JUnit5 tests written in Java on Chrome and Firefox. Enable Percy for visual testing.
357
+
```
358
+
359
+
10. `fetchAutomationScreenshots` — Fetch screenshots captured during a given Automate/App Automate session.
360
+
**Prompt example**
361
+
362
+
```text
363
+
Get screenshots from Automate session ID abc123xyz for my desktop test run
364
+
```
365
+
366
+
---
367
+
368
+
## 🔍 Observability
369
+
370
+
11. `getFailureLogs` — Retrieve error logs for Automate/App Automate sessions (optionally by Build ID for App Automate).
371
+
**Prompt example**
372
+
373
+
```text
374
+
Get the error logs from the session ID: 21a864032a7459f1e7634222249b316759d6827f, Build ID: dt7ung4wmjittzff8kksrjadjax9gzvbscoyf9qn of App Automate test session
375
+
```
376
+
377
+
---
378
+
379
+
## 📱 App Live
380
+
381
+
12. `runAppLiveSession` — Start a manual app testing session on a real device in the cloud.
382
+
**Prompt example**
383
+
384
+
```text
385
+
Open my app on iPhone 15 Pro Max with iOS 17. App path is /Users/xyz/app.ipa
386
+
```
387
+
388
+
---
389
+
390
+
## 💻 Live
391
+
392
+
13. `runBrowserLiveSession` — Start a Live session for website testing on desktop or mobile browsers.
393
+
**Prompt example**
394
+
395
+
```text
396
+
Open www.google.com on the latest version of Microsoft Edge on Windows 11
397
+
```
398
+
399
+
---
400
+
401
+
## 📲 App Automate
402
+
403
+
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.
404
+
**Prompt example**
405
+
406
+
```text
407
+
Take a screenshot of my app on Google Pixel 6 with Android 14 while testing on App Automate. App file path: /Users/xyz/app-debug.apk
408
+
```
409
+
410
+
15. `runAppTestsOnBrowserStack` — Run automated mobile tests (Espresso/XCUITest, etc.) on real devices.
411
+
**Prompt example**
412
+
413
+
```text
414
+
Run Espresso tests from /tests/checkout.zip on Galaxy S21 and Pixel 6 with Android 14. App path is /apps/beta-release.apk under project 'Checkout Flow'
0 commit comments