real-browser-mcp-server 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +41 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,8 +12,37 @@ This server is **100% compatible with all major AI IDEs** (Cursor, VS Code, Clin
12
12
  ---
13
13
 
14
14
  ## ⚙️ Installation & Setup
15
+ Since this project is published on NPM, the easiest way to use it is via `npx` (which handles downloading and executing automatically).
15
16
 
16
- To install and run the server locally, clone the repository, install NPM dependencies, and configure the undetected browser binary using **Patchright**:
17
+ ### Quick Start (Using npx)
18
+
19
+ Add the following to your MCP Configuration file (e.g. `cline_mcp_settings.json` or `claude_desktop_config.json`):
20
+
21
+ ```json
22
+ {
23
+ "mcpServers": {
24
+ "real-browser": {
25
+ "command": "npx",
26
+ "args": ["-y", "real-browser-mcp-server@latest", "mcp"]
27
+ }
28
+ }
29
+ }
30
+ ```
31
+
32
+ ### 🌍 Global Installation
33
+
34
+ You can also install it globally on your system:
35
+
36
+ ```bash
37
+ npm install -g real-browser-mcp-server
38
+
39
+ # Run the MCP server
40
+ real-browser-mcp mcp
41
+ ```
42
+
43
+ ### 🛠️ Local Development & Build (Git Clone)
44
+
45
+ If you want to clone the repository and run it locally, follow these exact steps:
17
46
 
18
47
  ```bash
19
48
  # 1. Clone the repository
@@ -25,10 +54,20 @@ cd Real-Browser-Mcp-Server
25
54
  # 3. Install dependencies
26
55
  npm install
27
56
 
28
- # 4. Install Chromium-Driver for Patchright (Undetected Browser binary)
57
+ # 4. IMPORTANT: Install Chromium-Driver for Patchright (Undetected Browser binary)
29
58
  npx patchright install chromium
59
+
60
+ # 5. Build the TypeScript files
61
+ npm run build
62
+
63
+ # 6. Start the MCP server
64
+ npm run mcp
30
65
  ```
31
66
 
67
+ > [!NOTE]
68
+ > *Why does `npm run build` not build the entire project alone?*
69
+ > `npm run build` only compiles the TypeScript code into JavaScript (`dist/`). However, the undetected browser engine (`patchright`) requires you to explicitly download its browser binaries using `npx patchright install chromium`. Without this step, the server will crash trying to find Chromium.
70
+
32
71
  ### 🐳 Run via Docker (Recommended for Servers)
33
72
 
34
73
  We automatically build and publish a production-ready Docker image to GitHub Container Registry (GHCR).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "real-browser-mcp-server",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "MCP Server for Real Browser - Patchright (undetected Playwright fork) with Stealth Mode, Ad Blocker, and Turnstile Auto-Solver for undetectable web automation.",
5
5
  "main": "dist/lib/cjs/index.js",
6
6
  "module": "lib/esm/index.mjs",
@@ -26,7 +26,7 @@
26
26
  },
27
27
  "scripts": {
28
28
  "prepublishOnly": "npm run build",
29
- "build": "tsc",
29
+ "build": "tsc && node -e \"console.log('\\n✅ Build Successful! The dist/ folder is ready.\\n')\"",
30
30
  "start": "node dist/src/index.js",
31
31
  "dev": "npm run build && node dist/src/index.js",
32
32
  "mcp": "node dist/src/index.js mcp",