Skip to content

Commit 1154821

Browse files
committed
docs: polish marketplace submission copy
Clarify installation, validation, and submission steps so the LeadMagic Cursor plugin is easier to review, test, and publish. Made-with: Cursor
1 parent 68d8c1e commit 1154821

3 files changed

Lines changed: 125 additions & 46 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ All notable changes to the LeadMagic Cursor plugin will be documented in this fi
1414
- Removed wording that implied MCP support for ad-search endpoints that are part of the REST API but not the current MCP tool surface
1515
- Tightened skills and default guidance around company research, job-change checks, hiring signals, and credit-aware workflows
1616
- Added GitHub pull request and validation scaffolding so the plugin repo matches the OpenAPI repo's baseline maintenance hygiene
17+
- Expanded README and submission docs with clearer install, validation, troubleshooting, and marketplace submission steps

README.md

Lines changed: 112 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# LeadMagic Cursor Plugin
22

3-
Official LeadMagic plugin for Cursor. It connects Cursor to LeadMagic's hosted MCP server so agents can run credit-aware B2B enrichment, contact discovery, company research, technographics, competitor analysis, job-change checks, and hiring-signal workflows inside Cursor.
3+
Official LeadMagic plugin for Cursor. It connects Cursor to LeadMagic's hosted MCP server so agents can perform credit-aware B2B enrichment, contact discovery, company research, technographic analysis, job-change checks, and hiring-signal workflows without leaving the editor.
44

5-
## What this plugin adds
5+
## Overview
6+
7+
This repository packages LeadMagic's hosted MCP integration in a Cursor-native format for marketplace distribution, local installation, and team use. The goal is straightforward: make LeadMagic's enrichment and research workflows available to Cursor agents with minimal setup and clear operational guidance.
8+
9+
The package includes:
610

711
- Hosted LeadMagic MCP connectivity for Cursor
812
- The current LeadMagic MCP surface:
@@ -14,19 +18,29 @@ Official LeadMagic plugin for Cursor. It connects Cursor to LeadMagic's hosted M
1418
- account intelligence
1519
- prospect list QA
1620
- signal research
17-
- A default rule that nudges Cursor to use LeadMagic efficiently and avoid wasteful repeat lookups
21+
- One default rule that nudges Cursor toward efficient, low-duplication LeadMagic usage
22+
23+
## Why Use It
24+
25+
Use this plugin when you want Cursor to help with:
26+
27+
- validating or finding work emails
28+
- enriching people and companies from strong identifiers
29+
- researching account fit, competitors, funding, and technographics
30+
- spotting hiring activity and job-change signals
31+
- keeping enrichment workflows credit-aware and repeatable
1832

19-
## How it works
33+
## Hosted MCP Configuration
2034

2135
The plugin points Cursor at LeadMagic's hosted MCP endpoint:
2236

2337
- MCP endpoint: `https://mcp.leadmagic.io/mcp`
2438
- MCP transport: `http`
2539
- Auth header: `x-leadmagic-key`
2640

27-
Users provide their API key through the `LEADMAGIC_API_KEY` environment variable, and the plugin passes it through to the hosted MCP server. This mirrors the current hosted MCP setup docs for Cursor.
41+
Users provide their API key through the `LEADMAGIC_API_KEY` environment variable. The plugin forwards that key to the hosted MCP server at runtime.
2842

29-
## What the MCP supports today
43+
## What The MCP Supports Today
3044

3145
The current hosted MCP surface is strongest for:
3246

@@ -37,80 +51,132 @@ The current hosted MCP surface is strongest for:
3751
- researching companies with company search, funding, competitors, and technographics
3852
- detecting job changes and finding live hiring signals through jobs search
3953

40-
The broader REST API and OpenAPI snapshot include additional surfaces, but this plugin should describe the MCP surface accurately rather than implying every API endpoint is exposed as an MCP tool.
54+
The broader REST API and OpenAPI snapshot include additional surfaces, but this plugin is documented against the current MCP surface only. That keeps the marketplace listing accurate and avoids implying support for endpoints that are not currently exposed through MCP.
4155

42-
## Repository layout
56+
## Quick Start
4357

44-
```text
45-
.cursor-plugin/plugin.json
46-
.github/pull_request_template.md
47-
.github/workflows/validate-plugin.yml
48-
assets/logo.svg
49-
mcp.json
50-
package-lock.json
51-
schemas/plugin.schema.json
52-
rules/leadmagic-usage.mdc
53-
skills/*/SKILL.md
54-
scripts/validate-plugin.mjs
55-
README.md
56-
SUBMISSION.md
58+
Install the plugin from GitHub today, or from the Cursor marketplace after approval.
59+
60+
### 1. Set your API key
61+
62+
```bash
63+
export LEADMAGIC_API_KEY="your_api_key_here"
5764
```
5865

59-
## Setup
66+
### 2. Install the plugin locally for testing
6067

61-
1. Install the plugin in Cursor from GitHub or after marketplace approval.
62-
2. Set your API key in your shell or environment:
68+
If you are using this repository locally:
6369

6470
```bash
65-
export LEADMAGIC_API_KEY="your_api_key_here"
71+
npm ci
72+
npm run install:local
6673
```
6774

68-
3. Restart Cursor or reload the plugin if needed.
69-
4. Verify the connection by asking Cursor: `"Check my LeadMagic credit balance."`
75+
This creates a symlink at `~/.cursor/plugins/local/leadmagic` pointing to this repository.
76+
77+
Then reload Cursor with `Developer: Reload Window`.
78+
79+
### 3. Verify the connection
80+
81+
Ask Cursor one of these:
82+
83+
- `Check my LeadMagic credit balance.`
84+
- `Validate this email with LeadMagic: jane@company.com`
85+
- `Research Ramp as an account and summarize the best buying signals.`
7086

7187
## Local Development
7288

73-
To load this repository as a local Cursor plugin during development:
89+
From the repository root, install dependencies and validate the package:
90+
91+
```bash
92+
npm ci
93+
npm run validate
94+
```
95+
96+
To link the plugin into Cursor locally:
7497

7598
```bash
7699
npm run install:local
77100
```
78101

79-
That creates a symlink at `~/.cursor/plugins/local/leadmagic` that points to this repository. Then reload Cursor with `Developer: Reload Window`.
102+
To remove the local symlink later:
103+
104+
```bash
105+
npm run uninstall:local
106+
```
107+
108+
## Troubleshooting
109+
110+
### Cursor cannot see `LEADMAGIC_API_KEY`
80111

81112
On macOS, if Cursor was launched from the dock or Finder, it may not inherit your shell environment. If `LEADMAGIC_API_KEY` is set in your terminal but LeadMagic still fails inside Cursor, launch Cursor from the same shell session or reload it after exporting the variable in an environment Cursor can see.
82113

83-
If you prefer to configure LeadMagic directly in Cursor instead of through the plugin package, see the hosted setup guide:
114+
### Authentication fails
115+
116+
Confirm that:
117+
118+
- `LEADMAGIC_API_KEY` is set in the environment visible to Cursor
119+
- the plugin is using `https://mcp.leadmagic.io/mcp`
120+
- the request header is `x-leadmagic-key`
121+
122+
### You need exact tool details
123+
124+
Use the shared docs resource `leadmagic://docs` or review:
84125

85126
- [LeadMagic MCP Setup](https://leadmagic.io/docs/mcp/setup)
86127
- [LeadMagic MCP Tools](https://leadmagic.io/docs/mcp/tools)
87128
- [LeadMagic MCP Troubleshooting](https://leadmagic.io/docs/mcp/troubleshooting)
88129

89-
## Companion resources
130+
## Example Prompts
90131

91-
- OpenAPI snapshot and schema docs: [LeadMagic OpenAPI](https://github.com/LeadMagic/leadmagic-openapi)
92-
- Product docs index: [leadmagic.io/docs/llms.txt](https://leadmagic.io/docs/llms.txt)
93-
- Website: [leadmagic.io](https://leadmagic.io)
132+
- `Check my LeadMagic credit balance.`
133+
- `Validate these prospect emails and tell me which are safe to use.`
134+
- `Find the best work email for Jane Doe at Snowflake.`
135+
- `Enrich this B2B profile and pull any work email or mobile available.`
136+
- `Has this prospect changed jobs recently?`
137+
- `Research Ramp as an account and tell me the best buying signals.`
138+
- `What tech stack does Ramp use and who are its competitors?`
139+
- `Find engineering hiring signals for OpenAI and summarize the GTM angle.`
94140

95-
## Example prompts
141+
## Repository Layout
96142

97-
- "Check my LeadMagic credit balance."
98-
- "Validate these prospect emails and tell me which are safe to use."
99-
- "Find the best work email for Jane Doe at Snowflake."
100-
- "Enrich this b2b profile and pull any work email or mobile available."
101-
- "Has this prospect changed jobs recently?"
102-
- "Research Ramp as an account and tell me the best buying signals."
103-
- "What tech stack does Ramp use and who are its competitors?"
104-
- "Find engineering hiring signals for OpenAI and summarize the GTM angle."
143+
```text
144+
.cursor-plugin/plugin.json
145+
.github/pull_request_template.md
146+
.github/workflows/validate-plugin.yml
147+
assets/logo.svg
148+
mcp.json
149+
package-lock.json
150+
schemas/plugin.schema.json
151+
rules/leadmagic-usage.mdc
152+
skills/*/SKILL.md
153+
scripts/install-local-plugin.mjs
154+
scripts/validate-plugin.mjs
155+
README.md
156+
SUBMISSION.md
157+
CHANGELOG.md
158+
```
105159

106160
## Validation
107161

108162
```bash
109163
npm run validate
110164
```
111165

112-
The validator checks this package against a vendored snapshot of Cursor's official `plugin.schema.json` and then applies LeadMagic-specific assertions for the hosted MCP endpoint, canonical logo asset, and submission metadata.
166+
The validator checks this package against a vendored snapshot of Cursor's official `plugin.schema.json` and then applies LeadMagic-specific assertions for:
167+
168+
- the hosted MCP endpoint
169+
- `LEADMAGIC_API_KEY` interpolation
170+
- the canonical logo asset and submission logo URL
171+
- skills and rules metadata
172+
- repository and submission copy consistency
173+
174+
## Marketplace Submission
113175

114-
## Submission
176+
Use `SUBMISSION.md` for ready-to-paste marketplace form values, reviewer notes, and a final pre-submit checklist.
115177

116-
Use `SUBMISSION.md` for ready-to-paste marketplace copy.
178+
## Companion Resources
179+
180+
- OpenAPI snapshot and schema docs: [LeadMagic OpenAPI](https://github.com/LeadMagic/leadmagic-openapi)
181+
- Product docs index: [leadmagic.io/docs/llms.txt](https://leadmagic.io/docs/llms.txt)
182+
- Website: [leadmagic.io](https://leadmagic.io)

SUBMISSION.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ https://github.com/LeadMagic/leadmagic-cursor-plugin
2828
**Website URL**
2929
https://leadmagic.io
3030

31+
## Submission checklist
32+
33+
Before submitting:
34+
35+
1. Make sure the repository is public at `https://github.com/LeadMagic/leadmagic-cursor-plugin`.
36+
2. Make sure `assets/logo.svg` is committed on `main`.
37+
3. Confirm the public logo URL resolves:
38+
`https://raw.githubusercontent.com/LeadMagic/leadmagic-cursor-plugin/main/assets/logo.svg`
39+
4. Run `npm ci`.
40+
5. Run `npm run validate`.
41+
6. If you want to test the package in Cursor first, run `npm run install:local` and reload Cursor with `Developer: Reload Window`.
42+
3143
## Suggested reviewer note
3244

3345
LeadMagic is an API-first B2B enrichment platform for AI agents and GTM engineers. This plugin packages our current hosted MCP integration into a Cursor-native repo with focused skills, safe default guidance, and a clean environment-variable setup for credit-aware enrichment workflows.

0 commit comments

Comments
 (0)