Skip to content

Commit 0df2f7f

Browse files
committed
docs: add LinkedIn adapter to README — available adapters table, quick start, config example
Made-with: Cursor
1 parent 7e9a8f1 commit 0df2f7f

1 file changed

Lines changed: 25 additions & 12 deletions

File tree

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ The trade-off is intentional — browserkit is single-user and local-only by des
1919
## Quick Start
2020

2121
```bash
22-
# Install core + an adapter
23-
pnpm add @browserkit/core @browserkit/adapter-hackernews
22+
# Install core + adapters
23+
pnpm add @browserkit/core @browserkit/adapter-hackernews @browserkit/adapter-linkedin
2424

25-
# Log in once (for sites that need auth)
26-
browserkit login hackernews
25+
# Log in once per authenticated site (opens a browser window)
26+
browserkit login linkedin
2727

2828
# Start the daemon
2929
browserkit start --config browserkit.config.js
@@ -34,15 +34,23 @@ Configure your MCP client (Cursor, Claude Desktop, etc.):
3434
```json
3535
{
3636
"mcpServers": {
37-
"browserkit-hackernews": {
38-
"url": "http://localhost:3847/mcp"
39-
}
37+
"browserkit-hackernews": { "url": "http://localhost:3847/mcp" },
38+
"browserkit-linkedin": { "url": "http://localhost:3848/mcp" }
4039
}
4140
}
4241
```
4342

4443
---
4544

45+
## Available Adapters
46+
47+
| Package | Site | Auth | Tools |
48+
|---|---|---|---|
49+
| [`@browserkit/adapter-hackernews`](https://github.com/browserkit-dev/adapter-hackernews) | Hacker News | none | `get_top`, `get_new`, `get_ask`, `get_show`, `get_comments` |
50+
| [`@browserkit/adapter-linkedin`](https://github.com/browserkit-dev/adapter-linkedin) | LinkedIn | required | `get_person_profile`, `get_company_profile`, `get_company_posts`, `search_people`, `search_jobs`, `get_job_details`, `get_feed` |
51+
52+
---
53+
4654
## How It Works
4755

4856
Each adapter runs as a **dedicated MCP HTTP server** on its own port. Multiple AI agents can connect concurrently — requests are serialized per adapter to protect the browser session.
@@ -52,7 +60,7 @@ AI Agent (Cursor / Claude / custom)
5260
↓ HTTP MCP
5361
browserkit daemon
5462
├── hackernews :3847 headless Chromium (public, no auth needed)
55-
├── linkedin :3848 headless Chromium (authenticated)
63+
├── linkedin :3848 headless Chrome (authenticated, uses real Chrome)
5664
└── ...
5765
```
5866

@@ -74,9 +82,13 @@ export default {
7482
"@browserkit/adapter-hackernews": {
7583
port: 3847,
7684
},
77-
"@someone/my-custom-adapter": {
85+
"@browserkit/adapter-linkedin": {
7886
port: 3848,
79-
debugPort: 4848, // optional: enables raw Playwright access via CDP
87+
channel: "chrome", // use real Chrome — avoids bot detection on login
88+
},
89+
"@someone/my-custom-adapter": {
90+
port: 3849,
91+
debugPort: 4849, // optional: enables raw Playwright access via CDP
8092
authStrategy: "persistent", // "persistent" | "storage-state" | "cdp-attach"
8193
rateLimit: { minDelayMs: 3000 },
8294
},
@@ -157,9 +169,10 @@ Enable in config: `debugPort: adapterPort + 1000` (e.g. adapter on 3848 → debu
157169
158170
## Building an Adapter
159171
160-
### Reference implementation
172+
### Reference implementations
161173
162-
[`browserkit-dev/adapter-hackernews`](https://github.com/browserkit-dev/adapter-hackernews) is a complete working adapter — public site, 5 tools, full 4-layer test suite. Read it first.
174+
- [`browserkit-dev/adapter-hackernews`](https://github.com/browserkit-dev/adapter-hackernews) — public site, no auth, 5 tools, full 4-layer test suite. The simplest starting point.
175+
- [`browserkit-dev/adapter-linkedin`](https://github.com/browserkit-dev/adapter-linkedin) — authenticated site, 7 tools, `innerText` extraction strategy + ARIA-anchor feed scraping. Good reference for adapters that need login and work against DOM-churning JS apps.
163176
164177
### Scaffold
165178

0 commit comments

Comments
 (0)