diff --git a/README.md b/README.md index 2353f7d8..b1fe8ef7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ -

One Platform For All Your Testing Needs

+

Comprehensive Test Platform

@@ -21,26 +21,23 @@
- +
-Enable every developer and tester in your team, whether they are testing manually, starting their automation journey, or scaling test automation. -BrowserStack MCP Server allows you to use our cutting-edge [Test Platform](https://www.browserstack.com/test-platform) directly from your favourite AI tools. - -### Why BrowserStack ? - -

- overview -

+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. +#### Test from anywhere: +Easily connect the BrowserStack Test Platform to your favourite AI tools, such as IDEs, LLMs, or agentic workflows. +#### Reduced context switching: +Stay in flow—keep all project context in one place and trigger actions directly from your IDE or LLM. ## 💡 Usage Examples ### 📱 Manual App Testing -Use the following prompts to use your **mobile apps** on BrowserStack's extensive cloud of real devices. Stop using emulators! - +Test mobile apps on real devices across the latest OS versions. Reproduce bugs and debug crashes without setup hassles. +Below are some sample prompts to use your mobile apps on BrowserStack's extensive cloud of real devices ```bash # Open app on specific device "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 "My app crashed on Android 14 device, can you help me debug?" ``` - - 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. - 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/). @@ -58,8 +54,9 @@ Use the following prompts to use your **mobile apps** on BrowserStack's extensiv 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! ```bash -# Test your local websites +# Test your websites "open my website hosted on localhost:3001 on Edge" +"open browserstack.com on latest version of Chrome" ``` - 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. @@ -67,27 +64,39 @@ Similar to the app testing, you can use the following prompts to test your **web ### 🧪 Automated Testing (Playwright, Selenium, A11y and more..) -Use the following prompts to run/debug/fix your **automated tests** on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform). +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. +Below are few example prompts to run/debug/fix your automated tests on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform). ```bash -# Port test suite to BrowserStack -"run my test suite on BrowserStack infra" +#Port test suite to BrowserStack +"Setup test suite to run on BrowserStack infra" -# Debug test failures -"My test suite failed, can you help me fix the new failures?" +#Run tests on BrowserStack +“Run my tests on BrowserStack” -# Accessibility testing -"check for accessibility issues on my www.mywebsite.com" -``` +#AI powered debugging of test failures +"My App Automate tests have failed, can you help me fix the new failures?" +``` - 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). - Run tests written in Jest, Playwright, Selenium, and more on BrowserStack's [Test Platform](https://www.browserstack.com/test-platform) -- **Accessibility Testing**: Ensure WCAG and ADA compliance with our [Accessibility Testing](https://www.browserstack.com/accessibility-testing) tool +### 🌐 Accessibility + +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 + +```bash +#Scan accessibility issues while development +"Scan & help fix accessibility issues for my website running locally on localhost:3000" + +#Scan accessibility issues on production site +“Run accessibility scan & identify issues on my website - www.bstackdemo.com” + +``` ### 📋 Test Management -Use the following prompts to utilise capabilities of BrowserStack's [Test Management](https://www.browserstack.com/test-management) with MCP server. +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. ```bash # Create project & folder structure @@ -106,6 +115,24 @@ Use the following prompts to utilise capabilities of BrowserStack's [Test Manage "update test results as passed for Login tests test run from My Demo Project" ``` +### 🧪 Access BrowserStack AI agnets + +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 + +```bash +#Test case generator agent +"With Browserstack AI, create relevant test cases for my PRD located at /usr/file/location" + + +#Low code authoring agent +“With Browserstack AI, automate my manual test case X, added in Test Management” + + +#Self healing agent +“Help fix flaky tests in my test script with Browserstack AI self healing” +``` + + ## 🛠️ Installation 1. **Create a BrowserStack Account** @@ -113,9 +140,7 @@ Use the following prompts to utilise capabilities of BrowserStack's [Test Manage - Sign up for [BrowserStack](https://www.browserstack.com/users/sign_up) if you don't have an account already. - ℹ️ If you have an open-source project, we'll be able to provide you with a [free plan](https://www.browserstack.com/open-source). -
- Open Source Plan -
+ - 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). @@ -175,6 +200,25 @@ Use the following prompts to utilise capabilities of BrowserStack's [Test Manage } } ``` + - Cline + +Click the “MCP Servers” icon in the navigation bar +Select the “Installed” tab. Click the “Configure MCP Servers” button at the bottom of the pane. + + ```json + { + "mcpServers": { + "browserstack": { + "command": "npx", + "args": ["-y", "@browserstack/mcp-server@latest"], + "env": { + "BROWSERSTACK_USERNAME": "", + "BROWSERSTACK_ACCESS_KEY": "" + } + } + } + } + ``` ### Installing via Smithery @@ -203,17 +247,9 @@ We welcome contributions! Please open an issue to discuss any changes you'd like For support, please: -- Check our [documentation](https://www.browserstack.com/docs) - Open an issue in our [GitHub repository](https://github.com/browserstack/mcp-server) if you face any issues related to the MCP Server. - Contact our [support team](https://www.browserstack.com/contact) for any other queries. ## 🚀 More Features Coming Soon Stay tuned for exciting updates! Have any suggestions? Please open an issue to discuss. - -## 🔗 Resources - -- [BrowserStack Test Platform](https://www.browserstack.com/test-platform) -- [MCP Protocol Documentation](https://modelcontextprotocol.io) -- [Device Grid](https://www.browserstack.com/list-of-browsers-and-platforms/app_live) -- [Accessibility Testing](https://www.browserstack.com/accessibility-testing)