Skip to content

Commit 65fccad

Browse files
committed
docs: README refresh — install options, auth, troubleshooting
Made-with: Cursor
1 parent 4b56cdd commit 65fccad

1 file changed

Lines changed: 133 additions & 48 deletions

File tree

README.md

Lines changed: 133 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,85 @@
11
# LeadMagic Cursor Plugin
22

3-
Official LeadMagic plugin for Cursor: connect the editor to LeadMagic’s **hosted MCP** for credit-aware B2B enrichmentwork emails, mobile, profile-to-email, job-change signals, account research, competitors, technographics, people-by-role, and credits.
3+
Official LeadMagic plugin for Cursor. Connect Cursor to LeadMagic's hosted MCP for credit-aware B2B enrichment and GTM research: work email validation and discovery, mobile lookup, LinkedIn profile to work email, job-change signals, account research, competitors, technographics, people by role, and credit balance.
44

5-
**Repository:** [github.com/LeadMagic/leadmagic-cursor-plugin](https://github.com/LeadMagic/leadmagic-cursor-plugin)
5+
[GitHub repository](https://github.com/LeadMagic/leadmagic-cursor-plugin) | [LeadMagic docs](https://leadmagic.io/docs/mcp/setup) | [LeadMagic](https://leadmagic.io)
66

7-
## Security and privacy
7+
## What this plugin gives you
8+
9+
- A hosted LeadMagic MCP endpoint at `https://mcp.leadmagic.io/mcp`
10+
- OAuth sign-in in Cursor by default
11+
- 10 LeadMagic MCP tools for contact and account workflows
12+
- Cursor-native packaging: rules, skills, commands, and a dedicated enrichment agent
13+
- In-editor docs via `leadmagic://docs`
814

9-
- **Default auth:** **OAuth** in Cursor (browser sign-in). No API keys are stored in this repo’s `mcp.json`.
10-
- **Optional API-key mode:** Use environment variable `LEADMAGIC_API_KEY` and the header pattern in [MCP configuration](#mcp-configuration). Never commit keys, tokens, or `.env` files—see [SECURITY.md](SECURITY.md) for reporting issues and hardening notes.
11-
- **Data:** Tool calls send the inputs you or the agent provide (e.g. emails, names, company names or domains, profile URLs) to LeadMagic’s hosted service. Read [Privacy](https://leadmagic.io/privacy), [Terms](https://leadmagic.io/legal/terms), and [Support](https://leadmagic.io/docs/support).
15+
This repository packages the Cursor plugin. It does not run a local MCP server. The MCP server is hosted by LeadMagic.
1216

13-
## What’s included
17+
It follows Cursor's public plugin model documented at [https://cursor.com/docs/plugins](https://cursor.com/docs/plugins).
1418

15-
| Area | Details |
19+
## Included in the plugin
20+
21+
| Area | Included |
1622
| --- | --- |
17-
| **MCP** | Hosted endpoint `https://mcp.leadmagic.io/mcp` (HTTP), **OAuth** by default |
18-
| **Tools** | 10 tools: credits, validate/find work email, mobile, LinkedIn-to-email, job change, account research, competitors, technographics, people-by-role |
19-
| **Docs in Cursor** | Resource `leadmagic://docs`; prompts `account_research`, `contact_lookup` |
20-
| **Rules / skills / agent / commands** | One rule, four skills, agent `leadmagic-enrichment`, commands (`check-credits`, `research-company`, `validate-email`) |
23+
| MCP server | Hosted HTTP MCP at `https://mcp.leadmagic.io/mcp` |
24+
| Authentication | OAuth in Cursor by default; optional API-key mode |
25+
| Tools | `check_credit_balance`, `validate_work_email`, `find_work_email`, `find_mobile_number`, `linkedin_profile_to_work_email`, `detect_job_change`, `research_account`, `list_company_competitors`, `get_company_technographics`, `find_people_by_role` |
26+
| Cursor docs | Resource `leadmagic://docs`; prompts `account_research` and `contact_lookup` |
27+
| Packaged assets | 1 rule, 4 skills, 1 agent, 3 commands |
28+
29+
## Install in Cursor
2130

22-
**MCP vs REST:** For direct `https://api.leadmagic.io` integration, schemas, and smoke tests, use [LeadMagic OpenAPI](https://github.com/LeadMagic/leadmagic-openapi) and [product docs](https://leadmagic.io/docs). MCP tools cover a **subset** of the REST surface (e.g. jobs/ads are not MCP tools today).
31+
Choose the path that fits how you want to use the plugin.
2332

24-
**Same plugin model as other Cursor plugins:** [Cursor Plugins](https://cursor.com/docs/plugins), [plugin-template](https://github.com/cursor/plugin-template). Similar bundle to [Encore’s Cursor plugin](https://github.com/encoredev/cursor-plugin) (rules, skills, MCP, agent, commands); LeadMagic uses **remote HTTP MCP** instead of a local stdio server.
33+
### Option 1: Team marketplace import
34+
35+
In Cursor, go to `Dashboard -> Settings -> Plugins -> Team Marketplaces -> Import` and use:
36+
37+
```text
38+
https://github.com/LeadMagic/leadmagic-cursor-plugin
39+
```
2540

26-
## Quick start
41+
### Option 2: Local install from this repo
2742

28-
1. **Marketplace** — Install from the Cursor marketplace when available.
29-
2. **Team marketplace**`Dashboard → Settings → Plugins → Team Marketplaces → Import``https://github.com/LeadMagic/leadmagic-cursor-plugin`.
30-
3. **Local symlink** — From the repo root:
43+
From the repo root:
3144

3245
```bash
3346
npm ci
3447
npm run install:local
3548
```
3649

37-
Reload Cursor (`Developer: Reload Window`), complete **OAuth** when the LeadMagic MCP server connects, then try: *“Check my LeadMagic credit balance.”*
50+
Then reload Cursor with `Developer: Reload Window`.
3851

39-
For API-key mode (no OAuth), set `LEADMAGIC_API_KEY` where Cursor can read it and apply the JSON block below.
52+
### Option 3: Cursor marketplace
4053

41-
## MCP configuration
54+
Install from the Cursor marketplace when the listing is available.
4255

43-
| Setting | Value |
44-
| --- | --- |
45-
| URL | `https://mcp.leadmagic.io/mcp` |
46-
| Transport | `http` |
47-
| Auth (default) | OAuth in Cursor (no `headers` in bundled `mcp.json`) |
56+
## First run
4857

49-
**Optional API-key header** (merge into your MCP config; env var must be visible to Cursor):
58+
1. Enable the LeadMagic plugin in Cursor.
59+
2. Complete the OAuth sign-in flow when Cursor prompts you.
60+
3. Ask Cursor something simple, such as:
61+
62+
```text
63+
Check my LeadMagic credit balance.
64+
```
65+
66+
You can also try:
67+
68+
```text
69+
Validate this work email with LeadMagic: jane@company.com
70+
Research the company acme.com with LeadMagic
71+
Find people by role at Stripe: VP Marketing
72+
```
73+
74+
## Authentication
75+
76+
### Default: OAuth
77+
78+
The bundled `mcp.json` uses OAuth by default. No API keys are stored in this repository.
79+
80+
### Optional: API-key mode
81+
82+
If you need header-based authentication instead of OAuth, set `LEADMAGIC_API_KEY` in an environment visible to Cursor and merge this into your MCP config:
5083

5184
```json
5285
{
@@ -62,39 +95,98 @@ For API-key mode (no OAuth), set `LEADMAGIC_API_KEY` where Cursor can read it an
6295
}
6396
```
6497

65-
## Tools and documentation
98+
On macOS, if Cursor cannot see `LEADMAGIC_API_KEY`, launch Cursor from a shell that already has the variable exported.
6699

67-
**MCP tools:** `check_credit_balance`, `validate_work_email`, `find_work_email`, `find_mobile_number`, `linkedin_profile_to_work_email`, `detect_job_change`, `research_account`, `list_company_competitors`, `get_company_technographics`, `find_people_by_role`.
100+
## MCP configuration
101+
102+
| Setting | Value |
103+
| --- | --- |
104+
| URL | `https://mcp.leadmagic.io/mcp` |
105+
| Transport | `http` |
106+
| Default auth | OAuth in Cursor |
107+
| Optional auth | `x-leadmagic-key: ${LEADMAGIC_API_KEY}` |
108+
109+
## What you can do with it
110+
111+
### Contact workflows
112+
113+
- Validate an existing work email
114+
- Find a likely work email from a person and company
115+
- Resolve a work email from a LinkedIn profile
116+
- Find a mobile number when supported
117+
- Check for recent job-change signals
118+
119+
### Account workflows
120+
121+
- Research a company from a name or domain
122+
- Pull competitors
123+
- Pull technographics
124+
- Find people by role at a target account
125+
126+
### Cursor-native helpers
127+
128+
- Command: `check-credits`
129+
- Command: `research-company`
130+
- Command: `validate-email`
131+
- Agent: `leadmagic-enrichment`
132+
- Skills for contact enrichment, account intelligence, signal research, and prospect-list QA
133+
134+
## Docs and product references
68135

69136
- In Cursor: `leadmagic://docs`
70-
- Product: [LeadMagic MCP Setup](https://leadmagic.io/docs/mcp/setup), [LeadMagic MCP Tools](https://leadmagic.io/docs/mcp/tools), [LeadMagic MCP Troubleshooting](https://leadmagic.io/docs/mcp/troubleshooting)
137+
- Setup guide: [LeadMagic MCP Setup](https://leadmagic.io/docs/mcp/setup)
138+
- Tool reference: [LeadMagic MCP Tools](https://leadmagic.io/docs/mcp/tools)
139+
- Troubleshooting: [LeadMagic MCP Troubleshooting](https://leadmagic.io/docs/mcp/troubleshooting)
140+
- REST and schemas: [LeadMagic OpenAPI](https://github.com/LeadMagic/leadmagic-openapi)
141+
142+
For direct `https://api.leadmagic.io` integration, OpenAPI schemas, or REST smoke tests, use the OpenAPI repository and product docs. The Cursor plugin exposes the hosted MCP surface, which is a subset of the full REST platform.
71143

72-
## Developing this repository
144+
## Security and privacy
145+
146+
- Tool calls send the inputs you provide, such as emails, names, company domains, or profile URLs, to LeadMagic's hosted service.
147+
- Never commit secrets, API keys, tokens, or `.env` files.
148+
- Review [Privacy](https://leadmagic.io/privacy), [Terms](https://leadmagic.io/legal/terms), [Support](https://leadmagic.io/docs/support), and [SECURITY.md](SECURITY.md).
73149

74-
CI and local tooling target **Node.js 22** (see `.node-version` and `package.json` `engines`).
150+
## Develop this repository
151+
152+
This repo targets **Node.js 22**.
75153

76154
```bash
77155
npm ci
78156
npm run check
79157
```
80158

81-
`npm run check` runs `npm run validate` (schema + package assertions) and `npm run verify:health` (GET `https://mcp.leadmagic.io/health`). **Offline:** use `npm run validate` only.
159+
`npm run check` runs:
160+
161+
- `npm run validate` for schema and package assertions
162+
- `npm run verify:health` for `GET https://mcp.leadmagic.io/health`
163+
164+
If you are offline, run:
82165

83166
```bash
84-
npm run install:local # symlink into ~/.cursor/plugins/local/leadmagic
85-
npm run uninstall:local # remove symlink
167+
npm run validate
86168
```
87169

88-
Marketplace copy and checklist: `SUBMISSION.md`. Changelog: `CHANGELOG.md`.
170+
Useful local commands:
171+
172+
```bash
173+
npm run install:local
174+
npm run uninstall:local
175+
```
176+
177+
Additional repo docs:
178+
179+
- Marketplace submission copy: `SUBMISSION.md`
180+
- Release notes: `CHANGELOG.md`
89181

90182
## Troubleshooting
91183

92184
| Issue | What to try |
93185
| --- | --- |
94-
| OAuth / sign-in | Retry MCP settings; URL must be `https://mcp.leadmagic.io/mcp`; remove bad header overrides. |
95-
| `LEADMAGIC_API_KEY` not seen (API-key mode) | On macOS, launch Cursor from a shell that has the var, or fix GUI env inheritance. |
96-
| API-key auth fails | Confirm `x-leadmagic-key` + `${LEADMAGIC_API_KEY}` and endpoint URL. |
97-
| Reachability | `GET https://mcp.leadmagic.io/health` → 200; `/mcp` may return **401** until OAuth or a valid key—expected. |
186+
| OAuth sign-in does not complete | Confirm the MCP URL is `https://mcp.leadmagic.io/mcp` and remove incorrect header overrides. |
187+
| API-key auth fails | Confirm `x-leadmagic-key` is set from `${LEADMAGIC_API_KEY}` and that Cursor can read the env var. |
188+
| Cursor cannot see `LEADMAGIC_API_KEY` | On macOS, launch Cursor from a shell that already has the variable exported. |
189+
| Health check works but MCP returns `401` | Expected until OAuth completes or a valid API key is provided. |
98190

99191
## Project layout
100192

@@ -118,13 +210,6 @@ LICENSE
118210
README.md
119211
```
120212

121-
## Resources
122-
123-
- [LeadMagic OpenAPI](https://github.com/LeadMagic/leadmagic-openapi) — REST snapshot, `llms.txt`, optional `npm run test:api`
124-
- [LeadMagic docs (LLM index)](https://leadmagic.io/docs/llms.txt)
125-
- [leadmagic.io](https://leadmagic.io)
126-
- [Security policy](SECURITY.md)
127-
128213
## License
129214

130-
MIT — see [LICENSE](LICENSE).
215+
MIT. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)