Skip to content

Commit 36fbc2f

Browse files
authored
Merge pull request #86 from tushar-sanap/doc-update
Doc update and added prompt examples for new tools
2 parents b445504 + 452c1fa commit 36fbc2f

File tree

1 file changed

+71
-35
lines changed

1 file changed

+71
-35
lines changed

README.md

Lines changed: 71 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
</div>
1414

15-
<p align="center">One Platform For All Your Testing Needs</p>
15+
<p align="center">Comprehensive Test Platform</p>
1616

1717
<div align="center">
1818
<a href="https://glama.ai/mcp/servers/@browserstack/mcp-server">
@@ -21,26 +21,23 @@
2121
</div>
2222

2323
<div>
24-
<a href="https://www.youtube.com/watch?v=sLA7K9v7qZc">
24+
<a href="https://www.youtube.com/watch?v=sLA7K9v7qZc&list=PL1vH6dHT3H7oy8w9CY6L_nxGxCc89VXMX&index=5">
2525
<img src="assets/thumbnail.webp">
2626
</a>
2727
</div>
2828

29-
Enable every developer and tester in your team, whether they are testing manually, starting their automation journey, or scaling test automation.
30-
BrowserStack MCP Server allows you to use our cutting-edge [Test Platform](https://www.browserstack.com/test-platform) directly from your favourite AI tools.
31-
32-
### Why BrowserStack ?
33-
34-
<p align="center">
35-
<img src="assets/overview.png" alt="overview">
36-
</p>
29+
Manage test cases, execute manual or automated tests, debug issues, and even fix code—directly within tools like Cursor, Claude, or any MCP-enabled client, using plain English.
30+
#### Test from anywhere:
31+
Easily connect the BrowserStack Test Platform to your favourite AI tools, such as IDEs, LLMs, or agentic workflows.
32+
#### Reduced context switching:
33+
Stay in flow—keep all project context in one place and trigger actions directly from your IDE or LLM.
3734

3835
## 💡 Usage Examples
3936

4037
### 📱 Manual App Testing
4138

42-
Use the following prompts to use your **mobile apps** on BrowserStack's extensive cloud of real devices. Stop using emulators!
43-
39+
Test mobile apps on real devices across the latest OS versions. Reproduce bugs and debug crashes without setup hassles.
40+
Below are some sample prompts to use your mobile apps on BrowserStack's extensive cloud of real devices
4441
```bash
4542
# Open app on specific device
4643
"open my app on a iPhone 15 Pro Max"
@@ -49,7 +46,6 @@ Use the following prompts to use your **mobile apps** on BrowserStack's extensiv
4946
"My app crashed on Android 14 device, can you help me debug?"
5047
```
5148

52-
5349
- Unlike emulators, test your app's real-world performance on actual devices. With advanced [App-Profiling features](https://www.browserstack.com/docs/app-live/app-performance-testing), you can debug crashes and performance issues in real-time.
5450
- Access all major devices and OS versions from our [device grid](https://www.browserstack.com/list-of-browsers-and-platforms/app_live), We have strict SLAs to provision our global datacenters with newly released devices on [launch day](https://www.browserstack.com/blog/browserstack-launches-iphone-15-on-day-0-behind-the-scenes/).
5551

@@ -58,36 +54,49 @@ Use the following prompts to use your **mobile apps** on BrowserStack's extensiv
5854
Similar to the app testing, you can use the following prompts to test your **websites** on BrowserStack's extensive cloud of real browsers and devices. Don't have Edge browser installed on your machine ? We've got you covered!
5955

6056
```bash
61-
# Test your local websites
57+
# Test your websites
6258
"open my website hosted on localhost:3001 on Edge"
59+
"open browserstack.com on latest version of Chrome"
6360
```
6461

6562
- Test websites across different browsers and devices. We support [every major browser](https://www.browserstack.com/list-of-browsers-and-platforms/live) across every major OS.
6663
- Seamlessly test websites hosted locally on your machine, no need to deploy to a remote server!
6764

6865
### 🧪 Automated Testing (Playwright, Selenium, A11y and more..)
6966

70-
Use the following prompts to run/debug/fix your **automated tests** on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform).
67+
Auto-analyze, diagnose, and even fix broken test scripts right in your IDE or LLM. Instantly fetch logs, identify root causes, and apply context-aware fixes. No more debugging loops.
68+
Below are few example prompts to run/debug/fix your automated tests on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform).
7169

7270
```bash
73-
# Port test suite to BrowserStack
74-
"run my test suite on BrowserStack infra"
71+
#Port test suite to BrowserStack
72+
"Setup test suite to run on BrowserStack infra"
7573

76-
# Debug test failures
77-
"My test suite failed, can you help me fix the new failures?"
74+
#Run tests on BrowserStack
75+
“Run my tests on BrowserStack”
7876

79-
# Accessibility testing
80-
"check for accessibility issues on my www.mywebsite.com"
81-
```
77+
#AI powered debugging of test failures
78+
"My App Automate tests have failed, can you help me fix the new failures?"
8279

80+
```
8381
- Fix test failures reported by your CI/CD pipeline by utilising our industry leading [Test Observability](https://www.browserstack.com/docs/test-observability) features. Find more info [here](https://www.browserstack.com/docs/test-observability/features/smart-tags).
8482
- Run tests written in Jest, Playwright, Selenium, and more on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform)
85-
- **Accessibility Testing**: Ensure WCAG and ADA compliance with our [Accessibility Testing](https://www.browserstack.com/accessibility-testing) tool
8683

84+
### 🌐 Accessibility
85+
86+
Catch accessibility issues early with automated, local a11y scans. Get one-click, AI-suggested fixes. No docs hunting, no CI surprises. Ensure WCAG and ADA compliance with our Accessibility Testing tool
87+
88+
```bash
89+
#Scan accessibility issues while development
90+
"Scan & help fix accessibility issues for my website running locally on localhost:3000"
91+
92+
#Scan accessibility issues on production site
93+
“Run accessibility scan & identify issues on my website - www.bstackdemo.com”
94+
95+
```
8796

8897
### 📋 Test Management
8998

90-
Use the following prompts to utilise capabilities of BrowserStack's [Test Management](https://www.browserstack.com/test-management) with MCP server.
99+
Create and manage test cases, create test plans and trigger test runs using natural language. Below are a few example prompts to utilise capabilities of BrowserStack's [Test Management](https://www.browserstack.com/test-management) with MCP server.
91100

92101
```bash
93102
# Create project & folder structure
@@ -106,16 +115,32 @@ Use the following prompts to utilise capabilities of BrowserStack's [Test Manage
106115
"update test results as passed for Login tests test run from My Demo Project"
107116
```
108117

118+
### 🧪 Access BrowserStack AI agnets
119+
120+
Generate test cases from PRDs, convert manual tests to low-code automation, and auto-heal flaky scripts powered by BrowserStack’s AI agents, seamlessly integrated into your workflow. Below are few example prompts to access Browserstack AI agents
121+
122+
```bash
123+
#Test case generator agent
124+
"With Browserstack AI, create relevant test cases for my PRD located at /usr/file/location"
125+
126+
127+
#Low code authoring agent
128+
“With Browserstack AI, automate my manual test case X, added in Test Management”
129+
130+
131+
#Self healing agent
132+
“Help fix flaky tests in my test script with Browserstack AI self healing”
133+
```
134+
135+
109136
## 🛠️ Installation
110137
111138
1. **Create a BrowserStack Account**
112139
113140
- Sign up for [BrowserStack](https://www.browserstack.com/users/sign_up) if you don't have an account already.
114141
115142
- ℹ️ If you have an open-source project, we'll be able to provide you with a [free plan](https://www.browserstack.com/open-source).
116-
<div align="center">
117-
<img src="assets/open-source-plan.png" alt="Open Source Plan">
118-
</div>
143+
119144
120145
- 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).
121146
@@ -175,6 +200,25 @@ Use the following prompts to utilise capabilities of BrowserStack's [Test Manage
175200
}
176201
}
177202
```
203+
- Cline
204+
205+
Click the “MCP Servers” icon in the navigation bar
206+
Select the “Installed” tab. Click the “Configure MCP Servers” button at the bottom of the pane.
207+
208+
```json
209+
{
210+
"mcpServers": {
211+
"browserstack": {
212+
"command": "npx",
213+
"args": ["-y", "@browserstack/mcp-server@latest"],
214+
"env": {
215+
"BROWSERSTACK_USERNAME": "<username>",
216+
"BROWSERSTACK_ACCESS_KEY": "<access_key>"
217+
}
218+
}
219+
}
220+
}
221+
```
178222
179223
### Installing via Smithery
180224
@@ -203,17 +247,9 @@ We welcome contributions! Please open an issue to discuss any changes you'd like
203247
204248
For support, please:
205249
206-
- Check our [documentation](https://www.browserstack.com/docs)
207250
- Open an issue in our [GitHub repository](https://github.com/browserstack/mcp-server) if you face any issues related to the MCP Server.
208251
- Contact our [support team](https://www.browserstack.com/contact) for any other queries.
209252
210253
## 🚀 More Features Coming Soon
211254
212255
Stay tuned for exciting updates! Have any suggestions? Please open an issue to discuss.
213-
214-
## 🔗 Resources
215-
216-
- [BrowserStack Test Platform](https://www.browserstack.com/test-platform)
217-
- [MCP Protocol Documentation](https://modelcontextprotocol.io)
218-
- [Device Grid](https://www.browserstack.com/list-of-browsers-and-platforms/app_live)
219-
- [Accessibility Testing](https://www.browserstack.com/accessibility-testing)

0 commit comments

Comments
 (0)