Skip to content

Commit 863b137

Browse files
committed
Revise and expand setup instructions in README
Updated the Quickstart section to provide a more detailed, step-by-step recommended setup method, clarified alternative installation options, and added a new section for common installation issues. These changes improve clarity for new users and address frequent setup problems.
1 parent eb81b70 commit 863b137

File tree

1 file changed

+78
-27
lines changed

1 file changed

+78
-27
lines changed

README.md

Lines changed: 78 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -52,60 +52,89 @@ Supercharge any MCP-compatible AI agent with undetectable, real-browser automati
5252

5353
## Quickstart (60 seconds)
5454

55-
### Option 1: FastMCP CLI (Recommended)
55+
### **Recommended Setup (Creator's Tested Method)**
5656
```bash
57-
# Install FastMCP CLI
58-
pip install fastmcp
59-
60-
# Clone and setup
57+
# 1. Clone the repository
6158
git clone https://github.com/vibheksoni/stealth-browser-mcp.git
6259
cd stealth-browser-mcp
6360

64-
# Auto-install with dependencies into Claude Desktop/Code/Cursor
61+
# 2. Create virtual environment
62+
python -m venv venv
63+
64+
# 3. Activate virtual environment
65+
# Windows:
66+
venv\Scripts\activate
67+
# Mac/Linux:
68+
source venv/bin/activate
69+
70+
# 4. Install dependencies
71+
pip install -r requirements.txt
72+
73+
# 5. Add to Claude Code using CLI
74+
```
75+
76+
**Windows:**
77+
```bash
78+
claude mcp add-json stealth-browser-mcp "{\"type\":\"stdio\",\"command\":\"C:\\path\\to\\stealth-browser-mcp\\venv\\Scripts\\python.exe\",\"args\":[\"C:\\path\\to\\stealth-browser-mcp\\src\\server.py\"]}"
79+
```
80+
81+
**Mac/Linux:**
82+
```bash
83+
claude mcp add-json stealth-browser-mcp '{
84+
"type": "stdio",
85+
"command": "/path/to/stealth-browser-mcp/venv/bin/python",
86+
"args": [
87+
"/path/to/stealth-browser-mcp/src/server.py"
88+
]
89+
}'
90+
```
91+
92+
> **💡 Replace `/path/to/stealth-browser-mcp/` with your actual project path**
93+
94+
---
95+
96+
### ⚠️ **Alternative: FastMCP CLI (Untested by Creator)**
97+
98+
*These methods should theoretically work but have not been tested by the creator. Use at your own risk.*
99+
100+
```bash
101+
# Install FastMCP
102+
pip install fastmcp
103+
104+
# Auto-install (untested)
65105
fastmcp install claude-desktop src/server.py --with-requirements requirements.txt
66106
# OR
67-
fastmcp install claude-code src/server.py --with-requirements requirements.txt
107+
fastmcp install claude-code src/server.py --with-requirements requirements.txt
68108
# OR
69109
fastmcp install cursor src/server.py --with-requirements requirements.txt
70110
```
71111

72-
### Option 2: Manual Installation
73-
```bash
74-
git clone https://github.com/vibheksoni/stealth-browser-mcp.git
75-
cd stealth-browser-mcp
76-
python -m venv venv
77-
78-
# Windows
79-
venv\Scripts\activate
80-
pip install -r requirements.txt
112+
---
81113

82-
# Mac/Linux
83-
source venv/bin/activate
84-
pip install -r requirements.txt
85-
```
114+
### Alternative: Manual Configuration (If Claude CLI not available)
86115

87-
Add to your MCP client configuration:
116+
If you don't have Claude Code CLI, manually add to your MCP client configuration:
88117

89-
**Windows**
118+
**Claude Desktop - Windows** (`%APPDATA%\Claude\claude_desktop_config.json`)
90119
```json
91120
{
92121
"mcpServers": {
93122
"stealth-browser": {
94-
"command": "C:\\path\\to\\venv\\Scripts\\python.exe",
95-
"args": ["C:\\path\\to\\src\\server.py"],
123+
"command": "C:\\path\\to\\stealth-browser-mcp\\venv\\Scripts\\python.exe",
124+
"args": ["C:\\path\\to\\stealth-browser-mcp\\src\\server.py"],
96125
"env": {}
97126
}
98127
}
99128
}
100129
```
101130

102-
**Mac/Linux**
131+
**Claude Desktop - Mac/Linux** (`~/Library/Application Support/Claude/claude_desktop_config.json`)
103132
```json
104133
{
105134
"mcpServers": {
106135
"stealth-browser": {
107-
"command": "/path/to/venv/bin/python",
108-
"args": ["/path/to/src/server.py"],
136+
"command": "/path/to/stealth-browser-mcp/venv/bin/python",
137+
"args": ["/path/to/stealth-browser-mcp/src/server.py"],
109138
"env": {}
110139
}
111140
}
@@ -117,6 +146,28 @@ Restart your MCP client and ask your agent:
117146

118147
> "Use stealth-browser to navigate to https://example.com and extract the pricing table."
119148
149+
## 🚨 **Common Installation Issues**
150+
151+
**❌ ERROR: Could not find a version that satisfies the requirement [package]**
152+
- **Solution**: Make sure your virtual environment is activated: `venv\Scripts\activate` (Windows) or `source venv/bin/activate` (Mac/Linux)
153+
- **Alternative**: Try upgrading pip first: `pip install --upgrade pip`
154+
155+
**❌ Module not found errors when running server**
156+
- **Solution**: Ensure virtual environment is activated before running
157+
- **Check paths**: Make sure the Claude CLI command uses the correct venv path
158+
159+
**❌ Chrome/Browser issues**
160+
- **Solution**: The server will automatically download Chrome when first run
161+
- **No manual Chrome installation needed**
162+
163+
**❌ "claude mcp add-json" command not found**
164+
- **Solution**: Make sure you have Claude Code CLI installed
165+
- **Alternative**: Use manual configuration method above
166+
167+
**❌ Path errors in Windows**
168+
- **Solution**: Use double backslashes `\\` in JSON strings for Windows paths
169+
- **Example**: `"C:\\\\Users\\\\name\\\\project\\\\venv\\\\Scripts\\\\python.exe"`
170+
120171
---
121172

122173
## ✨ Why developers star this

0 commit comments

Comments
 (0)