Skip to content

Commit 8fcf71b

Browse files
committed
docs: Update README with MCP clients
1 parent 304e7c6 commit 8fcf71b

1 file changed

Lines changed: 159 additions & 17 deletions

File tree

README.md

Lines changed: 159 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,198 @@
11
# WebDriverIO MCP Server
22

3-
A Model Context Protocol (MCP) server that enables Claude Desktop to interact with web browsers and mobile applications
3+
A Model Context Protocol (MCP) server that enables AI assistants to interact with web browsers and mobile applications
44
using WebDriverIO. Automate Chrome, Firefox, Edge, and Safari browsers plus iOS and Android apps—all through a unified interface.
55

66
## Installation
77

8-
### Setup
8+
[![mcp MCP server](https://glama.ai/mcp/servers/webdriverio/mcp/badges/score.svg)](https://glama.ai/mcp/servers/webdriverio/mcp)
99

10-
**Option 1: Configure Claude Desktop or Claude Code (Recommended)**
10+
Add the following configuration to your MCP client settings:
1111

12-
Add the following configuration to your Claude MCP settings:
12+
**Standard config** (works in most clients):
1313

1414
```json
1515
{
1616
"mcpServers": {
1717
"wdio-mcp": {
1818
"command": "npx",
19-
"args": [
20-
"-y",
21-
"@wdio/mcp"
22-
]
19+
"args": ["-y", "@wdio/mcp@latest"]
2320
}
2421
}
2522
}
2623
```
2724

28-
**Option 2: Global Installation**
25+
[![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)
26+
[![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)
27+
[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=WebDriverIO&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB3ZGlvL21jcEBsYXRlc3QiXX0%3D)
28+
29+
<details>
30+
<summary>Claude Desktop</summary>
31+
32+
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):
33+
34+
```json
35+
{
36+
"mcpServers": {
37+
"wdio-mcp": {
38+
"command": "npx",
39+
"args": ["-y", "@wdio/mcp@latest"]
40+
}
41+
}
42+
}
43+
```
44+
</details>
45+
46+
<details>
47+
<summary>Claude Code</summary>
2948

3049
```bash
31-
npm i -g @wdio/mcp
50+
claude mcp add wdio-mcp -- npx -y @wdio/mcp@latest
3251
```
52+
</details>
53+
54+
<details>
55+
<summary>Cline</summary>
3356

34-
Then configure MCP:
57+
Add to your VS Code `settings.json` or `cline_mcp_settings.json` file:
3558

3659
```json
3760
{
3861
"mcpServers": {
3962
"wdio-mcp": {
40-
"command": "wdio-mcp"
63+
"type": "stdio",
64+
"command": "npx",
65+
"args": ["-y", "@wdio/mcp@latest"]
4166
}
4267
}
4368
}
4469
```
70+
</details>
71+
72+
<details>
73+
<summary>Cursor</summary>
4574

46-
> **Note:** The npm package is `@wdio/mcp`, but the executable binary is `wdio-mcp`.
75+
Go to `Cursor Settings``MCP``Add new MCP Server`, or create `.cursor/mcp.json`:
76+
77+
```json
78+
{
79+
"mcpServers": {
80+
"wdio-mcp": {
81+
"command": "npx",
82+
"args": ["-y", "@wdio/mcp@latest"]
83+
}
84+
}
85+
}
86+
```
87+
</details>
88+
89+
<details>
90+
<summary>Codex</summary>
91+
92+
Use the Codex CLI:
93+
94+
```bash
95+
codex mcp add wdio-mcp npx "@wdio/mcp@latest"
96+
```
97+
98+
Or edit `~/.codex/config.toml`:
99+
100+
```toml
101+
[mcp_servers.wdio-mcp]
102+
command = "npx"
103+
args = ["@wdio/mcp@latest"]
104+
```
105+
</details>
106+
107+
<details>
108+
<summary>Goose</summary>
109+
110+
Go to `Advanced settings``Extensions``Add custom extension`, or run:
111+
112+
```bash
113+
goose configure
114+
```
115+
116+
Or edit `~/.config/goose/config.yaml`:
117+
118+
```yaml
119+
extensions:
120+
wdio-mcp:
121+
name: WebDriverIO MCP
122+
cmd: npx
123+
args: [-y, "@wdio/mcp@latest"]
124+
enabled: true
125+
type: stdio
126+
```
127+
</details>
47128
48-
**Restart Claude Desktop**
129+
<details>
130+
<summary>Windsurf</summary>
49131
50-
⚠️ You may need to fully restart Claude Desktop. On Windows, use Task Manager to ensure it's completely closed before
51-
restarting.
132+
Edit `~/.codeium/windsurf/mcp_config.json`:
133+
134+
```json
135+
{
136+
"mcpServers": {
137+
"wdio-mcp": {
138+
"command": "npx",
139+
"args": ["-y", "@wdio/mcp@latest"]
140+
}
141+
}
142+
}
143+
```
144+
</details>
145+
146+
<details>
147+
<summary>Zed</summary>
148+
149+
Edit Zed settings (`~/.config/zed/settings.json`):
150+
151+
```json
152+
{
153+
"context_servers": {
154+
"wdio-mcp": {
155+
"source": "custom",
156+
"command": "npx",
157+
"args": ["-y", "@wdio/mcp@latest"]
158+
}
159+
}
160+
}
161+
```
162+
</details>
163+
164+
<details>
165+
<summary>VS Code (Copilot)</summary>
166+
167+
```bash
168+
code --add-mcp '{"name":"wdio-mcp","command":"npx","args":["-y","@wdio/mcp@latest"]}'
169+
```
170+
</details>
171+
172+
----
173+
> ⚠️ **Restart Required**: After adding the configuration, fully restart your MCP client to apply the changes.
174+
175+
### Option 2: Global Installation
176+
177+
If you prefer to install globally:
178+
179+
```bash
180+
npm install -g @wdio/mcp
181+
```
182+
183+
Then use `wdio-mcp` as the command:
184+
185+
```json
186+
{
187+
"mcpServers": {
188+
"wdio-mcp": {
189+
"command": "wdio-mcp"
190+
}
191+
}
192+
}
193+
```
52194

53-
📖 **Need help?** Read the [official MCP configuration guide](https://modelcontextprotocol.io/quickstart/user)
195+
📖 **Need help?** Follow the [MCP install guide](https://modelcontextprotocol.io/quickstart/user).
54196

55197
### Prerequisites For Mobile App Automation
56198

0 commit comments

Comments
 (0)