Skip to content

Commit 0e13e1a

Browse files
authored
Merge pull request #90 from leadbay/ArtyETH06/make-the-doc-more-user-friendly-v2
docs(readme): make it more user-friendly — split user vs developer, rename to LeadMCP
2 parents a5aa6c5 + ba134a6 commit 0e13e1a

1 file changed

Lines changed: 83 additions & 42 deletions

File tree

README.md

Lines changed: 83 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,140 @@
11
<p align="center">
2-
<img src="logo.png" alt="LeadClaw" width="200">
2+
<img src="logo.png" alt="LeadMCP" width="200">
33
</p>
44

5-
<h1 align="center">LeadClaw</h1>
6-
<p align="center">MCP server that gives your B2B outreach agent superpowers. LeadClaw lets your agent tap into Leadbay's rich knowledge base of companies, turning outreach activity from senseless spamming into meaningful connections.</p>
5+
<h1 align="center">LeadMCP</h1>
6+
<p align="center">MCP server that gives your B2B outreach agent superpowers. LeadMCP lets your agent tap into Leadbay's rich knowledge base of companies, turning outreach activity from senseless spamming into meaningful connections.</p>
77
<p align="center">Ask your agent for new leads, and it will pull highly qualified companies that score well against your target profile and meet your qualification criteria.</p>
88
<p align="center">Everything is personalized—nothing to configure. Leadbay runs advanced AI agents on your website and leverages deep B2B sales expertise to optimize how leads are sourced for you.</p>
99
<p align="center">Tell your agent which leads you want it to prospect, connect your communication channels, and it will source contacts from Leadbay and handle outreach on your behalf. Enjoy the outreach you no longer have to do.
1010
</p>
1111

1212
---
1313

14-
> **New to Leadbay?** [Create your account here](https://wow.leadbay.ai/?register=true) before installing.
15-
1614
## How Leadbay thinks (mental model for your agent)
1715

1816
- **Inbox, not a database.** Each day your user logs back in, a fresh batch of leads is delivered. Batch size is paced by how many leads the user has actually acted on recently — some workflows produce a big stream of smaller prospects, others a narrow stream of bigger ones. Pulling more won't produce more; acting on leads does.
1917
- **Two scoring layers.** Every lead ships with a basic `score` (firmographic — already decent, usually correlates with AI). Roughly the top 10 of each batch are also AI-qualified (targeted web research + qualification questions → `ai_agent_lead_score`). Leads below the top 10 aren't worse — the system is saving resources. The agent can request deeper qualification (`leadbay_bulk_qualify_leads`) or contact enrichment (`leadbay_enrich_titles`) on any lead that looks worth it.
2018
- **Daily rhythm.** The agent works best as a daily check-in: pull fresh leads, skim the auto-qualified top, deepen 1-3 promising ones, propose outreach, then log what actually got sent via `leadbay_report_outreach`. If your host supports scheduling, set up a daily run.
2119

22-
## Install
20+
---
2321

24-
> **No Leadbay account yet?** [Register here](https://wow.leadbay.ai/?register=true) first.
22+
# For users
2523

26-
### Step 1 — Connect Leadbay with the universal installer
24+
Get LeadMCP running inside your AI assistant in a couple of minutes. No coding required.
2725

28-
Requires [Node.js 22+](https://nodejs.org).
26+
> **No Leadbay account yet?** [Create one here](https://wow.leadbay.ai/?register=true) first — you'll need it to sign in during setup.
2927
30-
```bash
31-
npx -y -p @leadbay/mcp@latest installer
32-
```
28+
## Install in Claude (recommended)
3329

34-
Click **Sign in with Leadbay**. The installer opens OAuth in your browser, then comes back to the app so you can choose which local agents to configure.
30+
The fastest way to get started is the one-click Claude extension.
3531

36-
The installer works on macOS and Windows. On Linux, only the command-line install path is available (`npx -y @leadbay/mcp@latest install --oauth`) — no desktop installer window. The installer only shows supported clients that are actually installed on the machine:
32+
**1. Download the extension**
3733

38-
| Client | Installer behavior |
39-
|--------|--------------------|
40-
| Claude Code | Registers/removes `leadbay` with `claude mcp add/remove --scope user` |
41-
| Claude Desktop | Writes/removes only the `mcpServers.leadbay` entry in `claude_desktop_config.json` |
42-
| Cursor | Writes/removes only the `mcpServers.leadbay` entry in Cursor's MCP config |
43-
| Codex | Writes/removes only the `[mcp_servers.leadbay]` block in `~/.codex/config.toml` and the Leadbay-managed shell export block |
44-
| ChatGPT Desktop | Uses the hosted MCP URL, no local config write |
34+
👉 **[Download the latest LeadMCP for Claude (.dxt)](https://github.com/leadbay/leadclaw/releases/latest)**
4535

46-
Uninstall is scoped to Leadbay. It does not rewrite unrelated client settings or remove other MCP servers.
36+
On the releases page, click the file ending in **`.dxt`** to download it.
4737

48-
---
38+
**2. Install it**
39+
40+
Double-click the downloaded `.dxt` file. Claude opens and shows an install dialog — click **Install**, and you're done.
4941

50-
### Step 2 — Connect your client
42+
**If the double-click doesn't open Claude**, install it manually:
5143

52-
#### Claude Desktop
44+
1. Open Claude and go to your **profile → Settings → Extensions**.
45+
2. Open **Advanced settings**.
46+
3. Choose **Install extension…** and select the `.dxt` file you downloaded.
5347

54-
Use the guided installer above. It writes the local `mcpServers.leadbay` entry in `claude_desktop_config.json` with `npx -y @leadbay/mcp@0.16`, then Claude Desktop runs the published MCP package.
48+
**3. Sign in**
5549

56-
The `.dxt` / `.mcpb` bundle from [Releases](https://github.com/leadbay/leadclaw/releases/latest) remains available as an alternative.
50+
Claude will prompt you to connect Leadbay. Sign in with your Leadbay account and you're ready — just ask your agent for leads.
5751

58-
#### ChatGPT Desktop
52+
## Using another assistant?
5953

60-
ChatGPT Desktop connects to the hosted MCP URL instead of a local config file:
54+
LeadMCP also works with Claude Code, Claude Desktop, Cursor, and Codex. The **universal installer** sets everything up for you and lets you sign in with Leadbay.
6155

62-
```text
63-
https://leadbay-mcp-prod.fly.dev/mcp
56+
Requires [Node.js 22+](https://nodejs.org). Then run:
57+
58+
```bash
59+
npx -y -p @leadbay/mcp@latest installer
6460
```
6561

66-
Use the connector auth flow to approve Leadbay.
62+
It opens in your browser where you click **Sign in with Leadbay**, then pick which assistants to connect. Works on macOS, Windows, and Linux.
6763

68-
#### Terminal-only install / automation (all platforms)
64+
**To uninstall**, run the same installer with `--uninstall`:
6965

7066
```bash
71-
npx -y @leadbay/mcp@latest install --oauth
67+
npx -y -p @leadbay/mcp@latest installer --uninstall
7268
```
7369

74-
Works on macOS, Windows, and Linux. Opens OAuth in your browser and registers the server into every detected MCP client, asking per-target. Pass `--yes` to skip prompts after auth. Pass `--target claude-code,cursor` to scope to specific clients.
70+
It opens an uninstall window showing only the assistants that have Leadbay connected — pick the ones to remove and click **Remove selected**. It only removes Leadbay; your other settings and connections are left untouched.
71+
72+
---
73+
74+
# For developers
75+
76+
Everything below is for contributors and anyone running LeadMCP from source or wiring it into automation.
77+
78+
## Install a local version with the custom installer
7579

76-
#### Uninstall
80+
To run your local checkout (instead of the published package), first build it from source:
7781

7882
```bash
79-
npx -y -p @leadbay/mcp@latest installer --uninstall
83+
pnpm install
84+
pnpm prompts:build
85+
pnpm -r build
86+
```
87+
88+
Then point the installer at your freshly built version with `--local`:
89+
90+
```bash
91+
pnpm --filter @leadbay/mcp installer -- --local
8092
```
8193

82-
Opens the uninstall wizard. Only shows clients that already have Leadbay MCP configured — select the ones to clean up and click "Remove selected". De-registers Claude Code, strips the JSON stanza from Claude Desktop / Cursor configs, removes the `[mcp_servers.leadbay]` TOML block from Codex, and strips the managed `export LEADBAY_*` block from `~/.zshrc` / `~/.bashrc`.
94+
`--local` registers the MCP client(s) against the build in your working tree rather than `@leadbay/mcp@latest`. OAuth is handled automatically — you don't need to pass `--oauth`. The installer asks per-target before writing anything.
95+
96+
## All install methods
8397

98+
Every supported way to connect LeadMCP:
99+
100+
| Method | Command / action | Platforms | Notes |
101+
|--------|------------------|-----------|-------|
102+
| **`.dxt` / `.mcpb` bundle** | Download from [Releases](https://github.com/leadbay/leadclaw/releases/latest), double-click → **Install** | Claude Desktop | One-click. The recommended path for end users. |
103+
| **Guided installer (GUI)** | `npx -y -p @leadbay/mcp@latest installer` | macOS, Windows, Linux | Browser wizard: sign in with Leadbay, pick clients. Works for everyone. |
104+
| **Local dev build** | `pnpm --filter @leadbay/mcp installer -- --local` | macOS, Windows, Linux | Registers clients against your local build. OAuth automatic. Build from source first (above). |
105+
| **Claude Code plugin marketplace** | `/plugin marketplace add leadbay/leadclaw` then `/plugin install leadbay@leadbay-leadclaw` | Claude Code | Registers the MCP server **and** installs auto-triggering skills. |
106+
107+
### What each installer writes per client
108+
109+
The GUI/CLI installers only touch clients that are actually installed on the machine:
110+
111+
| Client | Installer behavior |
112+
|--------|--------------------|
113+
| Claude Code | Registers/removes `leadbay` with `claude mcp add/remove --scope user` |
114+
| Claude Desktop | Writes/removes only the `mcpServers.leadbay` entry in `claude_desktop_config.json` |
115+
| Cursor | Writes/removes only the `mcpServers.leadbay` entry in Cursor's MCP config |
116+
| Codex | Writes/removes only the `[mcp_servers.leadbay]` block in `~/.codex/config.toml` and the Leadbay-managed shell export block |
84117

85-
#### Claude Code plugin marketplace
118+
### Claude Code plugin marketplace
86119

87-
```text
120+
```bash
88121
/plugin marketplace add leadbay/leadclaw
89122
```
90123

91-
```text
124+
```bash
92125
/plugin install leadbay@leadbay-leadclaw
93126
```
94127

95128
Claude Code prompts for Leadbay auth/config. Registers the MCP server **and** installs skills (`leadbay_research_a_domain`, `leadbay_import_file`, `leadbay_log_outreach`, `leadbay_qualify_top_n`, `leadbay_refine_audience`, and others) that auto-trigger on natural-language asks.
96129

130+
### Uninstall
131+
132+
```bash
133+
npx -y -p @leadbay/mcp@latest installer --uninstall
134+
```
135+
136+
Opens the uninstall wizard — only shows clients that already have Leadbay MCP configured. De-registers Claude Code, strips the JSON stanza from Claude Desktop / Cursor configs, removes the `[mcp_servers.leadbay]` TOML block from Codex, and strips the managed `export LEADBAY_*` block from `~/.zshrc` / `~/.bashrc`. Uninstall is scoped to Leadbay — it never rewrites unrelated client settings or removes other MCP servers.
137+
97138
## Tools
98139

99140
### Read-only (always on)
@@ -182,7 +223,7 @@ leadbay_import_leads → leadbay_bulk_qualify_leads
182223
- Node.js 22+
183224
- A [Leadbay account](https://wow.leadbay.ai/?register=true)
184225

185-
## Development
226+
## Building from source
186227

187228
```bash
188229
pnpm install

0 commit comments

Comments
 (0)