Skip to content

Commit 92f0f1a

Browse files
authored
Merge pull request #137 from leadbay/ArtyETH06/improve-mcp-repo-base-documentation
docs: refresh root README — rebrand Leadbay MCP, sync tool + skill inventory
2 parents 46993c1 + 5b30109 commit 92f0f1a

1 file changed

Lines changed: 176 additions & 47 deletions

File tree

README.md

Lines changed: 176 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
<p align="center">
2-
<img src="logo.png" alt="LeadMCP" width="200">
2+
<img src="logo.png" alt="Leadbay MCP" width="200">
33
</p>
44

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>
7-
<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>
8-
<p align="center">Everything is personalizednothing 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>
9-
<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.
5+
<h1 align="center">Leadbay MCP</h1>
6+
<p align="center"><strong>Leadbay MCP connects your AI assistant to your Leadbay account, so you can work your leads by simply asking.</strong></p>
7+
<p align="center">Pull leads, qualify them, draft outreach, and log activity — in plain language. Your assistant acts on your real Leadbay data, with your permissions, just as you would in the app.</p>
8+
<p align="center">Everything is personalizednothing to configure. Leadbay runs advanced AI on your website and market data to source and score leads against your target profile, so outreach becomes meaningful connection instead of senseless spamming.</p>
9+
<p align="center">Tell your assistant which leads to prospect, connect your channels, and it sources contacts from Leadbay and handles outreach on your behalf. Enjoy the outreach you no longer have to do.
1010
</p>
1111

12+
> **MCP** stands for *Model Context Protocol* — an open standard that lets AI assistants like Claude securely connect to external tools and data. This server is open source and lives at [github.com/leadbay/mcp](https://github.com/leadbay/mcp).
13+
1214
---
1315

1416
## How Leadbay thinks (mental model for your agent)
@@ -21,17 +23,28 @@
2123

2224
# For users
2325

24-
Get LeadMCP running inside your AI assistant in a couple of minutes. No coding required.
26+
Get Leadbay MCP running inside your AI assistant in a couple of minutes. No coding required.
27+
28+
> **New to Leadbay?** The friendly, screenshot-driven walkthrough — what a lens is, how scoring works, and the full MCP setup for every assistant — lives in the **[Leadbay user guide](https://docs.leadbay.ai/leadbay-mcp/what-is-leadbay-mcp)**. This README is the technical companion.
2529
2630
> **No Leadbay account yet?** [Create one here](https://wow.leadbay.ai/?register=true) first — you'll need it to sign in during setup.
2731
28-
## Install in Claude (recommended)
32+
## Connect on the web (no install)
33+
34+
If you use Claude on the web, Claude Desktop, or ChatGPT, the fastest path is a **custom connector** — no terminal, no tokens to copy. Add one URL and sign in with your browser:
35+
36+
- **Name:** `Leadbay`
37+
- **URL:** `https://mcp.leadbay.app/mcp` (EU accounts: `https://mcp.leadbay.app/fr/mcp`)
38+
39+
In Claude: **Settings → Connectors → + → Add custom connector**, paste the URL, then open the connector and **Connect**. Sign in with Leadbay, click **Approve**, and you're linked. The server handles OAuth in-app; updates are automatic — you never touch a config file.
2940

30-
The fastest way to get started is the one-click Claude extension.
41+
## Install in Claude Desktop (one-click bundle)
42+
43+
Prefer a bundled desktop extension? Grab the one-click file.
3144

3245
**1. Download the extension**
3346

34-
👉 **[Download the latest LeadMCP for Claude (.dxt)](https://github.com/leadbay/mcp/releases/latest)**
47+
👉 **[Download the latest Leadbay MCP for Claude (.dxt)](https://github.com/leadbay/mcp/releases/latest)**
3548

3649
On the releases page, click the file ending in **`.dxt`** to download it.
3750

@@ -49,9 +62,9 @@ Double-click the downloaded `.dxt` file. Claude opens and shows an install dialo
4962

5063
Claude will prompt you to connect Leadbay. Sign in with your Leadbay account and you're ready — just ask your agent for leads.
5164

52-
## Using another assistant?
65+
## Using a local assistant?
5366

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.
67+
Leadbay MCP 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.
5568

5669
Requires [Node.js 22+](https://nodejs.org). Then run:
5770

@@ -69,11 +82,25 @@ npx -y -p @leadbay/mcp@latest installer --uninstall
6982

7083
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.
7184

85+
## Ask for your first leads
86+
87+
Open a new conversation and describe the outcome — you never name a tool, just say what you want, the way you'd ask a colleague:
88+
89+
> *Show me today's leads and tell me which two are worth opening first.*
90+
91+
A successful first reply is a **ranked table of prospects**, not a wall of text: each row has a fit score, a one-line why-it-fits, and the best contact to reach. Then keep going:
92+
93+
> *Research the top one — is it a fit for us?*
94+
95+
> *Draft me an outreach email to them.*
96+
97+
> *I just emailed them. Log it as outreach.*
98+
7299
---
73100

74101
# For developers
75102

76-
Everything below is for contributors and anyone running LeadMCP from source or wiring it into automation.
103+
Everything below is for contributors and anyone running Leadbay MCP from source or wiring it into automation.
77104

78105
## Install a local version with the custom installer
79106

@@ -95,11 +122,12 @@ pnpm --filter @leadbay/mcp installer -- --local
95122

96123
## All install methods
97124

98-
Every supported way to connect LeadMCP:
125+
Every supported way to connect Leadbay MCP:
99126

100127
| Method | Command / action | Platforms | Notes |
101128
|--------|------------------|-----------|-------|
102-
| **`.dxt` / `.mcpb` bundle** | Download from [Releases](https://github.com/leadbay/mcp/releases/latest), double-click → **Install** | Claude Desktop | One-click. The recommended path for end users. |
129+
| **Hosted connector (no install)** | Add custom connector → `https://mcp.leadbay.app/mcp` (EU `…/fr/mcp`) | Claude web / Desktop, ChatGPT | Browser OAuth in-app. Nothing to install; auto-updates. |
130+
| **`.dxt` / `.mcpb` bundle** | Download from [Releases](https://github.com/leadbay/mcp/releases/latest), double-click → **Install** | Claude Desktop | One-click desktop extension. |
103131
| **Guided installer (GUI)** | `npx -y -p @leadbay/mcp@latest installer` | macOS, Windows, Linux | Browser wizard: sign in with Leadbay, pick clients. Works for everyone. |
104132
| **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). |
105133
| **Claude Code plugin marketplace** | `/plugin marketplace add leadbay/mcp` then `/plugin install leadbay@leadbay-mcp` | Claude Code | Registers the MCP server **and** installs auto-triggering skills. |
@@ -125,7 +153,7 @@ The GUI/CLI installers only touch clients that are actually installed on the mac
125153
/plugin install leadbay@leadbay-mcp
126154
```
127155

128-
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.
156+
Claude Code prompts for Leadbay auth/config. Registers the MCP server **and** installs a set of skills that auto-trigger on natural-language asks — including `leadbay_daily_check_in` ("get my leads today"), `leadbay_research_a_domain` ("research acme.com"), `leadbay_followup_check_in`, `leadbay_qualify_top_n`, `leadbay_refine_audience`, `leadbay_log_outreach`, `leadbay_import_file`, `leadbay_plan_tour_in_city`, `leadbay_prospecting_overview`, `leadbay_extend_my_lens`, `leadbay_setup_team_prospecting`, `leadbay_build_campaign`, and `leadbay_work_campaign`. Each `SKILL.md` is generated by `@leadbay/promptforge` from the same source as the MCP prompts, so the two surfaces never drift.
129157

130158
### Uninstall
131159

@@ -137,56 +165,155 @@ Opens the uninstall wizard — only shows clients that already have Leadbay MCP
137165

138166
## Tools
139167

168+
Your assistant calls these on your behalf — you never call them directly. You ask in plain language ("show me today's leads", "research acme.com", "log that I emailed Jane") and the agent picks the right tool. The default surface below is always exposed; the [full per-tool reference](https://docs.leadbay.ai/leadbay-mcp/tools-reference) lives in the user guide.
169+
170+
### Always on — agent memory
171+
172+
A local, per-account memory of your taste signals (preferred sectors, deal size, communication style). It never leaves your machine.
173+
174+
| Tool | Description |
175+
|------|-------------|
176+
| `leadbay_agent_memory_recall` | Read the consolidated top taste signals |
177+
| `leadbay_agent_memory_capture` | Record a new learning after you reveal a preference |
178+
| `leadbay_agent_memory_review` | List entries; gate retractions / org promotion behind confirmation |
179+
140180
### Read-only (always on)
141181

182+
These never modify your account, so they're always safe to allow.
183+
184+
**Discover & follow up**
185+
142186
| Tool | Description |
143187
|------|-------------|
144-
| `leadbay_pull_leads` | Pull today's fresh batch of scored leads |
145-
| `leadbay_pull_followups` | Pull leads that need follow-up action |
146-
| `leadbay_followups_map` | Geo-clustered follow-up map for travel planning |
147-
| `leadbay_tour_plan` | Build a visit plan for an upcoming trip |
148-
| `leadbay_research_lead_by_id` | Deep-dive research card for a single lead |
149-
| `leadbay_research_lead_by_name_fuzzy` | Look up a lead by company name |
150-
| `leadbay_prepare_outreach` | Build a personalized outreach brief for a lead |
188+
| `leadbay_pull_leads` | Pull today's fresh batch of scored, ranked leads |
189+
| `leadbay_pull_followups` | Pull the leads that need a follow-up action |
151190
| `leadbay_account_status` | Check quota, credits, and account state |
152-
| `leadbay_list_campaigns` | List existing campaigns |
153-
| `leadbay_campaign_progression` | Campaign funnel metrics |
154-
| `leadbay_campaign_call_sheet` | Call sheet for a campaign |
155-
| `leadbay_bulk_enrich_status` | Status of a running enrichment job |
156-
| `leadbay_qualify_status` | Status of a running qualification job |
191+
| `leadbay_scan_portfolio_signals` | Scan your existing leads for a web signal in one pass ("which of my leads acquired a company since 2025?") — no quota burn |
192+
193+
**Research a company**
194+
195+
| Tool | Description |
196+
|------|-------------|
197+
| `leadbay_research_lead_by_id` | Deep-dive research card for a known lead — details + AI qualification + contacts in one response |
198+
| `leadbay_research_lead_by_name_fuzzy` | Look up a lead by company name or domain when you don't have its ID |
199+
| `leadbay_account_history` | Full history on one account — current AI signals + all notes + interaction timeline, in one call ("why has this account resurfaced?") |
200+
| `leadbay_prepare_outreach` | Build a personalized outreach brief for a lead |
201+
202+
**Travel & field sales**
203+
204+
| Tool | Description |
205+
|------|-------------|
206+
| `leadbay_followups_map` | Geo-cluster your follow-ups on a map for travel planning |
207+
| `leadbay_tour_plan` | Build a visit itinerary for an upcoming trip to a city |
208+
209+
**Campaigns**
210+
211+
| Tool | Description |
212+
|------|-------------|
213+
| `leadbay_list_campaigns` | List your existing campaigns |
214+
| `leadbay_campaign_progression` | Show a campaign's funnel metrics |
215+
| `leadbay_campaign_call_sheet` | Pull the call sheet for a campaign |
216+
217+
**Lenses, audience & qualification**
218+
219+
| Tool | Description |
220+
|------|-------------|
221+
| `leadbay_list_sectors` | List the real sector taxonomy labels — so you (and the agent) name sectors correctly, no guessing |
222+
| `leadbay_recall_ordered_titles` | Recall the job titles previously enriched by the org (use before `leadbay_enrich_titles`) |
223+
| `leadbay_seed_candidates` | Read-only discovery surface for building a bigger lens |
224+
| `leadbay_get_qualification_questions` | Retrieve the org's AI-agent qualification questions (how leads are scored) |
225+
| `leadbay_get_lead_custom_fields` | Retrieve the custom-field values stored on one lead |
226+
| `leadbay_list_mappable_fields` | List the CRM fields you can map an import onto |
227+
228+
**Imports & jobs**
229+
230+
| Tool | Description |
231+
|------|-------------|
157232
| `leadbay_import_status` | Status of a running import job |
158-
| `leadbay_resolve_import_rows` | Resolve import rows to lead IDs |
159-
| `leadbay_list_mappable_fields` | List CRM fields available for mapping |
160-
| `leadbay_list_sectors` | List the sector taxonomy (real labels to target — no guessing) |
161-
| `leadbay_recall_ordered_titles` | List job titles previously enriched by the org (use before `leadbay_enrich_titles`) |
162-
| `leadbay_create_topup_link` | Generate a Stripe top-up link (quota recovery) |
233+
| `leadbay_qualify_status` | Status of a running qualification job |
234+
| `leadbay_bulk_enrich_status` | Status of a running enrichment job |
235+
| `leadbay_resolve_import_rows` | Map imported rows back to their lead IDs |
236+
237+
**Team, billing & product signals**
238+
239+
| Tool | Description |
240+
|------|-------------|
241+
| `leadbay_team_activity` | Manager-facing per-rep leaderboard + activity trend (non-admins are scoped to themselves) |
242+
| `leadbay_create_topup_link` | Generate a Stripe top-up link (you pay in your browser — nothing is charged automatically) |
163243
| `leadbay_open_billing_portal` | Open the billing portal |
244+
| `leadbay_acknowledge_notification` | Clear a terminal bulk-job notification so it stops resurfacing |
245+
| `leadbay_report_friction` | Report when a tool didn't deliver — helps improve the product (no account change) |
246+
| `leadbay_artifact_kit` | Fetch the headless view-models the agent uses to build an interactive HTML artifact |
247+
248+
### Write actions (on by default since 0.3.0; set `LEADBAY_MCP_WRITE=0` to disable)
249+
250+
These take action on your account. Every action is one you could take yourself in the app — there's nothing destructive at the platform level, and deletes are confirm-gated.
164251

165-
### Write actions (gated by `LEADBAY_MCP_WRITE=1`, default ON since 0.3.0)
252+
**Qualify & enrich**
166253

167254
| Tool | Description |
168255
|------|-------------|
169256
| `leadbay_bulk_qualify_leads` | Trigger AI qualification on a batch of leads |
170-
| `leadbay_enrich_titles` | Enrich contact job titles |
257+
| `leadbay_enrich_titles` | Enrich contacts by job title |
258+
259+
**Outreach & activity**
260+
261+
| Tool | Description |
262+
|------|-------------|
263+
| `leadbay_report_outreach` | Log an outreach action (call, email, meeting) — required after every contact |
264+
| `leadbay_add_note` | Add a note to a lead |
265+
| `leadbay_like_lead` | Mark a lead as liked — teaches your taste profile |
266+
| `leadbay_dislike_lead` | Mark a lead as disliked — teaches your taste profile |
267+
268+
**Contacts**
269+
270+
| Tool | Description |
271+
|------|-------------|
272+
| `leadbay_add_contact` | Add a person to a company (name + optional LinkedIn / title / email / phone) |
273+
| `leadbay_remove_contact` | Remove a contact you added |
274+
| `leadbay_pin_contact` | Pin a contact as the priority on a company |
275+
| `leadbay_unpin_contact` | Unpin a contact |
276+
| `leadbay_update_contact` | Edit a contact's details (title, email, LinkedIn…) |
277+
278+
**Lenses & audience**
279+
280+
| Tool | Description |
281+
|------|-------------|
171282
| `leadbay_my_lenses` | List, switch, rename/describe, or delete your lenses (delete is confirm-gated) |
172-
| `leadbay_new_lens` | Create a new named lens with sectors/sizes (previews & confirms before creating) |
173-
| `leadbay_adjust_audience` | Adjust a lens audience by sector/size — pass `lensName` to edit a lens by name (edit-only, doesn't switch your active lens) |
174-
| `leadbay_refine_prompt` | Refine the qualification prompt |
175-
| `leadbay_answer_clarification` | Answer a clarification question from Leadbay |
176-
| `leadbay_report_outreach` | Log outreach activity (required after every contact) |
283+
| `leadbay_new_lens` | Create a named lens with sector / company-size (and optional location) criteria |
284+
| `leadbay_adjust_audience` | Edit a lens's audience ("stop showing me companies over 50 employees"); pass `lensName` to edit a lens by name |
285+
| `leadbay_extend_lens` | Fill your current lens with more leads on demand (subject to a daily refill quota) |
286+
| `leadbay_refine_prompt` | Refine the qualification prompt that scores your leads |
287+
| `leadbay_answer_clarification` | Answer a clarification question Leadbay asked about your audience |
288+
289+
**Imports & campaigns**
290+
291+
| Tool | Description |
292+
|------|-------------|
177293
| `leadbay_import_leads` | Import a list of company domains |
178-
| `leadbay_import_and_qualify` | Import + immediately qualify leads |
179-
| `leadbay_add_note` | Add a note to a lead |
180-
| `leadbay_like_lead` | Mark a lead as liked |
181-
| `leadbay_dislike_lead` | Mark a lead as disliked |
294+
| `leadbay_import_and_qualify` | Import a list and immediately qualify it |
182295
| `leadbay_create_campaign` | Create a new campaign |
183296
| `leadbay_add_leads_to_campaign` | Add leads to a campaign |
184297
| `leadbay_remove_leads_from_campaign` | Remove leads from a campaign |
185-
| `leadbay_create_custom_field` | Create a custom CRM field |
298+
299+
**Custom fields & qualification questions**
300+
301+
| Tool | Description |
302+
|------|-------------|
303+
| `leadbay_create_custom_field` | Create a custom CRM field (e.g. to preserve a source-system ID) |
304+
| `leadbay_update_custom_field` | Rename or retype a custom field |
305+
| `leadbay_delete_custom_field` | Delete a custom field (confirm-gated) |
306+
| `leadbay_set_qualification_questions` | Modify the org's AI-agent qualification questions (max 5; removals confirm-gated) |
307+
308+
**Feedback**
309+
310+
| Tool | Description |
311+
|------|-------------|
312+
| `leadbay_send_feedback` | Send a message to the Leadbay team (same inbox as the in-app feedback form) |
186313

187314
### Advanced granular tools (gated by `LEADBAY_MCP_ADVANCED=1`)
188315

189-
Low-level single-API-call tools for power users and integrations. Enabled by setting `LEADBAY_MCP_ADVANCED=1` in the MCP server's env.
316+
Low-level, single-API-call tools for power users and integrations (`leadbay_discover_leads`, `leadbay_get_lead_profile`, `leadbay_get_contacts`, `leadbay_list_lenses`, …). Off by default; enable by setting `LEADBAY_MCP_ADVANCED=1` in the MCP server's env. See [`packages/mcp/README.md`](packages/mcp/README.md#8-advanced) for the full list.
190317

191318
## How it works
192319

@@ -202,10 +329,12 @@ You can also manage lenses directly from chat: `leadbay_my_lenses` lists them an
202329
|---------|----------|-------------|
203330
| `LEADBAY_TOKEN` | Yes | Local OAuth bearer credential (set by the installer) |
204331
| `LEADBAY_REGION` | Yes | `us` or `fr` |
205-
| `LEADBAY_MCP_WRITE` | No | Set to `0` to disable write tools (default: on) |
332+
| `LEADBAY_MCP_WRITE` | No | Set to `0` to disable write tools (default: on since 0.3.0) |
206333
| `LEADBAY_MCP_ADVANCED` | No | Set to `1` to expose granular tools (default: off) |
207334
| `LEADBAY_BASE_URL` | No | Override API URL (for staging/dev) |
208335

336+
The full environment-variable reference (telemetry, mock mode, logging, timeouts) is in [`packages/mcp/README.md`](packages/mcp/README.md#environment-variables).
337+
209338
## Workflows
210339

211340
The canonical inventory of what the MCP supports — supported / partial / planned / blocked-on-backend — is **[WORKFLOWS.md](WORKFLOWS.md)**. Use it to triage incoming asks: find the row that matches, or add a new one. A small audit asserts every cited tool/prompt and test path is real, so the table can't silently drift.

0 commit comments

Comments
 (0)