Skip to content

Commit 2bb4cf8

Browse files
authored
Merge pull request #47 from janhq/chore/update_readme
chore: update README
2 parents 05390f3 + 131ca30 commit 2bb4cf8

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
```bash
1919
# Clone the repository
20-
git clone https://github.com/menloresearch/jan-browser-extension.git
20+
git clone https://github.com/janhq/jan-browser-extension.git
2121
cd jan-browser-extension
2222

2323
# Install (npm is sufficient for the minimal build script)
@@ -38,13 +38,34 @@ npm run build:firefox
3838

3939
1. Open `chrome://extensions`
4040
2. Enable **Developer mode**
41-
3. Click **Load unpacked** → select the `dist` folder
41+
3. Click **Load unpacked** → select the `dist` folder
4242
4. Pin the extension if you want quick visibility
4343

4444
✅ You're ready to use Jan Browser MCP!
4545

4646
---
4747

48+
### 4. Use with Jan Desktop
49+
50+
If you have [Jan Desktop](https://jan.ai) installed, you can connect it seamlessly with the browser extension:
51+
52+
1. **Open Jan Desktop** → Navigate to **Settings****MCP Servers**
53+
2. **Enable** the **Jan Browser MCP (official)** server
54+
3. **Verify the port** matches between Jan and the extension:
55+
- Default port: `17389`
56+
- In Jan: Set `BRIDGE_PORT` environment variable if using a custom port
57+
- In Extension: Click the extension icon → Check **Settings** → Ensure port matches
58+
4. **Connect the bridge**:
59+
- Click the extension icon in Chrome
60+
- Click **Connect** to establish the WebSocket connection
61+
- You should see a "Connected" status indicator
62+
63+
**Tab Selection**:
64+
- **Use current tab**: Click "Set current tab for browser use" to let Jan control your active tab
65+
- **New tab**: Jan will automatically open and focus a new tab for automation
66+
67+
✅ Once connected, Jan can use browser automation tools through MCP!
68+
4869
## Project Structure
4970

5071
```

0 commit comments

Comments
 (0)