# WebDriverIO MCP Server A Model Context Protocol (MCP) server that enables AI assistants to interact with web browsers, local Electron applications, and mobile applications using WebdriverIO. Automate Chrome, Firefox, Edge, Safari, Electron, iOS, and Android through a unified interface. ## Installation [![mcp MCP server](https://glama.ai/mcp/servers/webdriverio/mcp/badges/score.svg)](https://glama.ai/mcp/servers/webdriverio/mcp) Add the following configuration to your MCP client settings: **Standard config** (works in most clients): ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": [ "-y", "@wdio/mcp@latest" ] } } } ``` [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install%20Server-0098FF?style=flat-square)](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522wdio-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540wdio%252Fmcp%2540latest%2522%255D%257D) [![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install%20Server-24bfa5?style=flat-square)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522wdio-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540wdio%252Fmcp%2540latest%2522%255D%257D) [Install in Cursor](https://cursor.com/en/install-mcp?name=WebDriverIO&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB3ZGlvL21jcEBsYXRlc3QiXX0%3D)
Claude Desktop Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS), `%APPDATA%\Claude\claude_desktop_config.json` (Windows), or `~/.config/Claude/claude_desktop_config.json` (Linux): ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": [ "-y", "@wdio/mcp@latest" ] } } } ```
Claude Code ```bash claude mcp add wdio-mcp -- npx -y @wdio/mcp@latest ```
Cline Add to your VS Code `settings.json` or `cline_mcp_settings.json` file: ```json { "mcpServers": { "wdio-mcp": { "type": "stdio", "command": "npx", "args": [ "-y", "@wdio/mcp@latest" ] } } } ```
Cursor Go to `Cursor Settings` → `MCP` → `Add new MCP Server`, or create `.cursor/mcp.json`: ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": [ "-y", "@wdio/mcp@latest" ] } } } ```
Codex Use the Codex CLI: ```bash codex mcp add wdio-mcp npx "@wdio/mcp@latest" ``` Or edit `~/.codex/config.toml`: ```toml [mcp_servers.wdio-mcp] command = "npx" args = ["@wdio/mcp@latest"] ```
Goose Go to `Advanced settings` → `Extensions` → `Add custom extension`, or run: ```bash goose configure ``` Or edit `~/.config/goose/config.yaml`: ```yaml extensions: wdio-mcp: name: WebDriverIO MCP cmd: npx args: [ -y, "@wdio/mcp@latest" ] enabled: true type: stdio ```
Windsurf Edit `~/.codeium/windsurf/mcp_config.json`: ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": [ "-y", "@wdio/mcp@latest" ] } } } ```
Zed Edit Zed settings (`~/.config/zed/settings.json`): ```json { "context_servers": { "wdio-mcp": { "source": "custom", "command": "npx", "args": [ "-y", "@wdio/mcp@latest" ] } } } ```
VS Code (Copilot) ```bash code --add-mcp '{"name":"wdio-mcp","command":"npx","args":["-y","@wdio/mcp@latest"]}' ```
---- > ⚠️ **Restart Required**: After adding the configuration, fully restart your MCP client to apply the changes. ### Option 2: Global Installation If you prefer to install globally: ```bash npm install -g @wdio/mcp ``` Then use `wdio-mcp` as the command: ```json { "mcpServers": { "wdio-mcp": { "command": "wdio-mcp" } } } ``` 📖 **Need help?** Follow the [MCP install guide](https://modelcontextprotocol.io/quickstart/user). ### HTTP Transport (for non-subprocess clients) By default the server uses **stdio** (subprocess) transport. For clients that cannot launch subprocesses (e.g. llama.cpp, OpenAI Codex secure mode), enable HTTP transport: ```bash npx @wdio/mcp --http --port 3000 ``` | Flag | Default | Description | |--------------------|------------------------------------|---------------------------------------------------------| | `--http` | — | Enable HTTP transport mode | | `--port` | `3000` | Port to listen on | | `--allowedHosts` | `localhost,127.0.0.1,::1` | Allowed `Host` header values (DNS rebinding protection) | | `--allowedOrigins` | _(none — browser clients blocked)_ | Allowed `Origin` values for CORS. Use `*` to allow all. | Then point your MCP client at `http://localhost:3000/mcp`. ### Prerequisites For Mobile App Automation - **Appium Server**: Install globally with `npm install -g appium` - **Platform Drivers**: - iOS: `appium driver install xcuitest` (requires Xcode on macOS) - Android: `appium driver install uiautomator2` (requires Android Studio) - **Devices/Emulators**: - iOS Simulator (macOS) or physical device - Android Emulator or physical device - **For iOS Real Devices**: You'll need the device's UDID (Unique Device Identifier) - **Find UDID on macOS**: Connect device → Open Finder → Select device → Click device name/model to reveal UDID - **Find UDID on Windows**: Connect device → iTunes or Apple Devices app → Click device icon → Click "Serial Number" to reveal UDID - **Xcode method**: Window → Devices and Simulators → Select device → UDID shown as "Identifier" Start the Appium server before using mobile features: ```bash appium # Server runs at http://127.0.0.1:4723 by default ``` ## Cloud Providers Run browser and mobile app tests on cloud real devices and browsers without any local setup. Currently supports [BrowserStack](https://www.browserstack.com/), [Sauce Labs](https://saucelabs.com/), [LambdaTest](https://www.lambdatest.com/), [TestingBot](https://testingbot.com/), and [Digital.ai Testing](https://digital.ai/products/continuous-testing/). ### Prerequisites Set your provider credentials as environment variables or in your MCP client config:
BrowserStack ```bash export BROWSERSTACK_USERNAME=your_username export BROWSERSTACK_ACCESS_KEY=your_access_key ``` ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": ["-y", "@wdio/mcp@latest"], "env": { "BROWSERSTACK_USERNAME": "your_username", "BROWSERSTACK_ACCESS_KEY": "your_access_key" } } } } ```
Sauce Labs ```bash export SAUCE_USERNAME=your_username export SAUCE_ACCESS_KEY=your_access_key ``` ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": ["-y", "@wdio/mcp@latest"], "env": { "SAUCE_USERNAME": "your_username", "SAUCE_ACCESS_KEY": "your_access_key" } } } } ``` | `SAUCE_USERNAME` | Sauce Labs username (required) | | `SAUCE_ACCESS_KEY` | Sauce Labs access key (required) | The data center is set per-session via the `region` parameter in `start_session` (defaults to `eu-central-1`).
LambdaTest (TestMu) ```bash export TESTMU_USERNAME=your_username export TESTMU_ACCESS_KEY=your_access_key ``` ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": ["-y", "@wdio/mcp@latest"], "env": { "TESTMU_USERNAME": "your_username", "TESTMU_ACCESS_KEY": "your_access_key" } } } } ``` | `TESTMU_USERNAME` | LambdaTest username (required) | | `TESTMU_ACCESS_KEY` | LambdaTest access key (required) |
TestingBot ```bash export TESTINGBOT_KEY=your_key export TESTINGBOT_SECRET=your_secret ``` ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": ["-y", "@wdio/mcp@latest"], "env": { "TESTINGBOT_KEY": "your_key", "TESTINGBOT_SECRET": "your_secret" } } } } ``` | `TESTINGBOT_KEY` | TestingBot key (required) | | `TESTINGBOT_SECRET` | TestingBot secret (required) |
Digital.ai Testing ```bash export DIGITALAI_CLOUD_URL=https://your-cloud.example.com export DIGITALAI_ACCESS_KEY=your_access_key ``` ```json { "mcpServers": { "wdio-mcp": { "command": "npx", "args": ["-y", "@wdio/mcp@latest"], "env": { "DIGITALAI_CLOUD_URL": "https://your-cloud.example.com", "DIGITALAI_ACCESS_KEY": "your_access_key" } } } } ``` | `DIGITALAI_CLOUD_URL` | Digital.ai cloud host, e.g. `https://your-cloud.example.com` (required) | | `DIGITALAI_ACCESS_KEY` | Digital.ai access key (required) | The access key is sent via the `digitalai:options` capability (mobile) or the flat `digitalai:accessKey` capability (web). **Report pass/fail status:** WebdriverIO defaults to the BiDi protocol, over which Digital.ai's cloud cannot observe command failures — so reports default to "Passed". To make the cloud reflect actual pass/fail, opt in to classic WebDriver per session: ```js start_session({ provider: 'digitalai', platform: 'browser', browser: 'chrome', os: 'Windows 10', capabilities: { 'wdio:enforceWebDriverClassic': true } }) ``` (Pure client-side assertion failures still report as "Passed" — only failures that reach the cloud as WebDriver command errors are detected.) **Mobile (Appium):** configure your Digital.ai project for **Appium-server execution** and pick its default Appium version via the project's **"Manage default Appium server version"** setting — the version is chosen at the project level (and tracks the versions your cloud supports), so this MCP does not pin one. See [Appium Server Test Execution](https://docs.digital.ai/continuous-testing/docs/te/test-execution-home/mobile-android-and-ios/appium/appium-server-test-execution).
### Browser Sessions Run a browser on a specific OS/version combination: ```javascript // BrowserStack start_session({ provider: 'browserstack', platform: 'browser', browser: 'chrome', // chrome | firefox | edge | safari browserVersion: 'latest', // default: latest os: 'Windows', // e.g. "Windows", "OS X" osVersion: '11', // e.g. "11", "Sequoia" reporting: { project: 'My Project', build: 'v1.2.0', session: 'Login flow' } }) // Sauce Labs start_session({ provider: 'saucelabs', platform: 'browser', browser: 'chrome', os: 'Windows', // combined with osVersion → platformName osVersion: '11', // e.g. "11", "15" (numbered Mac naming) region: 'eu-central-1', // default: eu-central-1 reporting: { build: 'v1.2.0', session: 'Login flow' } }) // LambdaTest start_session({ provider: 'testmu', platform: 'browser', browser: 'chrome', os: 'Windows', // combined with osVersion → platformName osVersion: '11', // e.g. "11", "Sequoia" (optional) reporting: { project: 'My Project', build: 'v1.2.0', session: 'Login flow' } }) // TestingBot start_session({ provider: 'testingbot', platform: 'browser', browser: 'chrome', os: 'Windows', // combined with osVersion → platformName (default: Windows 11) osVersion: '11', reporting: { build: 'v1.2.0', session: 'Login flow' } }) // Digital.ai start_session({ provider: 'digitalai', platform: 'browser', browser: 'chrome', os: 'Windows', // combined with osVersion → digitalai:osName (optional) osVersion: '11', reporting: { session: 'Login flow' // → digitalai:testName (flat capability, not nested) } }) ``` > **Provider-specific `os` / `osVersion` behavior:** > - **BrowserStack** — `os` and `osVersion` map to separate `bstack:options.os` / `bstack:options.osVersion` fields. > - **Sauce Labs / LambdaTest / TestingBot** — `os` and `osVersion` are combined into the W3C `platformName` capability (e.g., `os: 'Windows'` + `osVersion: '11'` → `platformName: 'Windows 11'`). These providers use `platformName` values like `"Windows 11"`, `"MacOS Sequoia"`, or `"Linux"`. TestingBot defaults to `Windows 11` when `os` is omitted. > - **Digital.ai** — `os` and `osVersion` are combined into the flat `digitalai:osName` capability (NOT `platformName`), e.g. `os: 'Windows'` + `osVersion: '11'` → `digitalai:osName: 'Windows 11'`. ### Mobile App Sessions Test on cloud real devices. First upload your app (or use an existing app URL): ```javascript // BrowserStack: returns bs:// URL upload_app({ provider: 'browserstack', path: '/path/to/app.apk' }) // Sauce Labs: returns storage:filename= reference upload_app({ provider: 'saucelabs', path: '/path/to/app.apk' }) // LambdaTest: returns lt:// URL upload_app({ provider: 'testmu', path: '/path/to/app.apk' }) // TestingBot: returns tb:// URL upload_app({ provider: 'testingbot', path: '/path/to/app.apk' }) // Digital.ai: returns cloud: reference upload_app({ provider: 'digitalai', path: '/path/to/app.apk' }) // Start a session start_session({ provider: 'browserstack', platform: 'android', app: 'bs://abc123...', deviceName: 'Samsung Galaxy S23', platformVersion: '13.0' }) // Sauce Labs native app start_session({ provider: 'saucelabs', platform: 'android', app: 'storage:filename=myapp.apk', deviceName: 'Samsung.*', platformVersion: '16' }) // LambdaTest native app start_session({ provider: 'testmu', platform: 'android', app: 'lt://abc123...', deviceName: 'Pixel 7', platformVersion: '13' }) // TestingBot native app start_session({ provider: 'testingbot', platform: 'android', app: 'tb://abc123...', deviceName: 'Pixel 7', platformVersion: '13' }) // Digital.ai native app — devices are selected via a deviceQuery start_session({ provider: 'digitalai', platform: 'android', app: 'cloud:com.example.app', deviceQuery: "@os='android' and @version='14' and @name='.*Pixel.*'" // or omit deviceQuery and pass deviceName / platformVersion to build one }) ``` ### Mobile Browser Sessions Run a browser on a cloud mobile device — real device or emulator/simulator — without uploading an app: ```javascript // BrowserStack — Chrome on Android emulator start_session({ provider: 'browserstack', platform: 'android', browser: 'chrome', deviceName: 'Google Pixel 7', platformVersion: '13' }) // Sauce Labs — Safari on iOS simulator start_session({ provider: 'saucelabs', platform: 'ios', browser: 'safari', deviceName: 'iPhone 15', platformVersion: '18', region: 'eu-central-1' }) // LambdaTest — Chrome on Android emulator start_session({ provider: 'testmu', platform: 'android', browser: 'chrome', deviceName: 'Pixel 7', platformVersion: '13' }) // TestingBot — Chrome on Android emulator start_session({ provider: 'testingbot', platform: 'android', browser: 'chrome', deviceName: 'Pixel 7', platformVersion: '13' }) // Digital.ai — Chrome on an Android device (real or emulator; selected via a deviceQuery) start_session({ provider: 'digitalai', platform: 'android', browser: 'chrome', deviceName: 'Pixel 7', platformVersion: '13' // or omit deviceName / platformVersion and pass deviceQuery directly, e.g. // deviceQuery: "@os='android' and @emulator='true'" to force an emulator }) ``` > **Note:** Mobile browser sessions do not require `app`, `appPath`, or `noReset`. The provider launches a browser directly on the selected device — real or emulator/simulator. Use `list_apps` to see previously uploaded apps: ```javascript list_apps({ provider: 'browserstack' }) list_apps({ provider: 'saucelabs', sortBy: 'app_name' }) list_apps({ provider: 'testmu' }) list_apps({ provider: 'testingbot' }) list_apps({ provider: 'digitalai' }) list_apps({ provider: 'browserstack', organizationWide: true }) ``` ### Local Tunnel To test against URLs that are only accessible on your local machine or internal network, enable a local tunnel: ```javascript // Auto-start tunnel (provider manages lifecycle) start_session({ provider: 'saucelabs', platform: 'browser', tunnel: true // auto-starts tunnel before session }) // Use an already-running tunnel start_session({ provider: 'saucelabs', platform: 'browser', tunnel: 'external' // uses existing tunnel }) ``` The `tunnel` parameter replaces the deprecated `browserstackLocal`, `saucelabsLocal`, and `testmuLocal` params. Set it to `true` to auto-start the tunnel (stopped automatically after the session), or `'external'` to use a tunnel already running on your machine. > **Note**: With `tunnel: true` the provider downloads and manages the tunnel binary for you. For `tunnel: 'external'` you run it yourself — the `wdio://saucelabs/local-binary`, `wdio://testmu/local-binary`, and `wdio://testingbot/local-binary` resources provide download URLs and setup instructions. The TestingBot Tunnel is a single cross-platform Java JAR (requires Java 11+) rather than a per-platform binary. ### Reporting Labels All session types support `reporting` labels that appear in the provider dashboard: | Field | Description | |---------------------|-----------------------------------------| | `reporting.project` | Group sessions under a project name | | `reporting.build` | Tag sessions with a build/version label | | `reporting.session` | Name for the individual test session | ### Cloud Provider Tools | Tool | Description | |--------------|-------------------------------------------------------------------------------| | `upload_app` | Upload a local `.apk` or `.ipa` to the provider; returns an app URL/reference | | `list_apps` | List apps previously uploaded to the provider's app storage | Both tools require a `provider` parameter (`'browserstack'`, `'saucelabs'`, `'testmu'`, `'testingbot'`, or `'digitalai'`). ## Features ### Browser Automation - **Session Management**: Start and close browser sessions (Chrome, Firefox, Edge, Safari) with headless/headed modes - **Navigation & Interaction**: Navigate URLs, click elements, fill forms, and retrieve content - **Page Analysis**: Get visible elements, accessibility trees, take screenshots - **Cookie Management**: Get, set, and delete cookies - **Scrolling**: Smooth scrolling with configurable distances - **Attach to running Chrome**: Connect to an existing Chrome window via `--remote-debugging-port` — ideal for testing authenticated or pre-configured sessions - **Connect to existing WebDriver endpoints**: Reuse an already-running Selenium-compatible WebDriver endpoint, such as a framework-managed browser or a desktop webview automation bridge (like Tauri) - **Device emulation**: Apply mobile/tablet presets (iPhone 15, Pixel 7, etc.) to simulate responsive layouts without a physical device - **Session Recording**: All tool calls are automatically recorded and exportable as runnable WebdriverIO JS ### Mobile App Automation (iOS/Android) - **Native App Testing**: Test iOS (.app/.ipa) and Android (.apk) apps via Appium - **Touch Gestures**: Tap, swipe, long-press, drag-and-drop - **App Lifecycle**: Launch, background, terminate, check app state - **Context Switching**: Seamlessly switch between native and webview contexts for hybrid apps - **Device Control**: Rotate, lock/unlock, geolocation, keyboard control, notifications - **Cross-Platform Selectors**: Accessibility IDs, XPath, UiAutomator (Android), Predicates (iOS) ## Available Tools The server lists only the tools that fit the current session: browser sessions get the page tools below, mobile sessions the gestures and device tools, Electron sessions the Electron tools. Rarely used groups (mocks, cookies, device emulation, extensions, attaching, the raw element list, cloud app uploads) are listed after the agent calls `enable_tools`, so their definitions aren't sent with every request. Set `WDIO_MCP_TOOLS=all` to list everything up front. | Tool | Description | |----------------|-------------------------------------------------------------------------------------------------------------------| | `enable_tools` | Add a group of tools: `mocks`, `cookies`, `device`, `extensions`, `attach`, `elements`, `cloud-apps` | ### Session Management | Tool | Description | |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `start_session` | Start a browser, local Electron application, or mobile app session; `attach: true` retains the existing Chrome CDP connection mode | | `attach_session` | Attach to an existing remote WebDriver/Appium session by ID without creating a new session | | `launch_chrome` | Launch a new Chrome instance with remote debugging enabled (for use with `start_session({ attach: true })`) | | `close_session` | Close or detach from the current session (supports `detach: true` to disconnect without terminating) | | `emulate_device` | Emulate a mobile/tablet device preset (viewport, DPR, UA, touch); requires BiDi session | | `open_web_extension` | Install a web extension through WebDriver BiDi and open one of its extension pages so normal page tools can drive its UI | ### Navigation & Page Interaction (Web & Mobile) | Tool | Description | |--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `navigate` | Navigate to a URL. In browsers the result shows the new page's interactive elements with refs | | `snapshot` | The page as an accessibility tree with refs (`button "Save" [ref=e3]`), interactive elements by default (plain text is dropped, `full: true` shows it); pass refs to `perform_actions` for several steps; `find` returns only the parts containing a text (link targets included), `full: true` adds all text, `viewport: true` keeps only what is on screen. Works for apps too (the screen's accessibility tree). | | `get_elements` | Get visible, interactable elements with bounds. Supports `inViewportOnly` (default: true) and `includeContainers` (default: false). Mobile and Electron; listed after `enable_tools({ groups: ['elements'] })`, use `snapshot` first | | `get_accessibility_tree` | Get the accessibility tree with roles, names, and selectors. Electron-only; browsers use `snapshot` | | `get_screenshot` | Take a screenshot of the current page or screen (base64-encoded, auto-resized to max 2000px / 1MB) | | `get_tabs` | List all open browser tabs with handle, title, URL, and active status. Browser-only. | | `scroll` | Scroll in a direction (up/down) by specified pixels. Browser-only. | | `execute_script` | Execute arbitrary JavaScript in the browser, or Appium mobile commands on devices | | `execute_electron_script` | Execute privileged JavaScript in the Electron main process (Electron sessions only) | | `trigger_electron_deeplink` | Trigger an Electron deeplink whose scheme was explicitly configured at session start | | `mock` | Configure a session-scoped mock: an Electron main-process API function or a browser network request | | `get_mock_calls` | Inspect call arguments (Electron) or intercepted request records (browser) for a session-scoped mock | | `manage_mock` | Clear, reset, or restore a session-scoped mock | | `switch_tab` | Switch to a different browser tab by handle or 0-based index. Browser-only. | | `switch_frame` | Switch into an iframe by CSS/XPath selector, or back to the top-level frame if no selector is given. Browser-only. | ### Element Interaction (Web & Mobile) | Tool | Description | |-------------------|-----------------------------------------------------------------------------------------------------| | `click_element` | Click an element | | `set_value` | Replace the text of an input or textarea | | `select_option` | Select an option of a `