@mackody/quickenrich-mcp 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "quickenrich-mcp",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Standalone MCP server and CLI for Quick Enrich lead enrichment APIs.",
5
5
  "author": {
6
6
  "name": "Cody Robertson"
7
7
  },
8
8
  "homepage": "https://app.quickenrich.io/docs",
9
9
  "repository": "https://github.com/codyrobertson/quickenrich-mcp",
10
- "license": "UNLICENSED",
10
+ "license": "SEE LICENSE IN LICENSE.md",
11
11
  "keywords": [
12
12
  "quickenrich",
13
13
  "quick-enrich",
package/LICENSE.md ADDED
@@ -0,0 +1,59 @@
1
+ # Quick Enrich MCP Restricted License
2
+
3
+ Copyright (c) 2026 Cody Robertson. All rights reserved.
4
+
5
+ This software is not open source. The package is published for controlled installation, review, and internal evaluation only. No rights are granted except the limited rights expressly stated in this license.
6
+
7
+ ## 1. Limited Permitted Use
8
+
9
+ You may install, run, inspect, and test this software solely for internal evaluation, internal development, and integration planning.
10
+
11
+ This permission is personal, non-exclusive, non-transferable, revocable, and non-sublicensable.
12
+
13
+ ## 2. No Commercial, Production, or Payment-Gated Use
14
+
15
+ You may not use this software, in whole or in part, for any commercial, production, revenue-generating, customer-facing, or payment-gated purpose without prior written permission from Cody Robertson or an authorized Mackody representative.
16
+
17
+ Prohibited uses include, without limitation:
18
+
19
+ - integrating this software into any commercial product, SaaS, hosted service, agent platform, automation platform, marketplace listing, CRM, enrichment platform, prospecting platform, customer deliverable, or managed service;
20
+ - making this software available behind subscriptions, paid seats, usage-based billing, credits, checkout, payment processing, paid API access, or any other monetization mechanism;
21
+ - using this software to provide lead enrichment, prospecting, data enrichment, automation, implementation, consulting, or agency services to third parties;
22
+ - bundling, embedding, white-labeling, reselling, sublicensing, leasing, renting, or otherwise commercially distributing this software;
23
+ - using this software to compete with, replace, or commercially replicate Quick Enrich, Mackody, or their related services.
24
+
25
+ ## 3. No Redistribution
26
+
27
+ You may not copy, publish, mirror, redistribute, repackage, upload, or make this software available to any third party except as expressly authorized in writing.
28
+
29
+ You may not remove, obscure, or alter copyright notices, license notices, package metadata, or attribution notices.
30
+
31
+ ## 4. API, Credentials, and Rate Limits
32
+
33
+ This license does not grant access to Quick Enrich APIs, data, credentials, trademarks, or services. You must use your own authorized Quick Enrich API key and comply with Quick Enrich's API documentation, account terms, data rules, and published rate limits.
34
+
35
+ You may not use this software to bypass, evade, overload, or work around Quick Enrich limits, billing, credit accounting, authentication, authorization, or abuse controls.
36
+
37
+ ## 5. Ownership
38
+
39
+ Cody Robertson and/or Mackody retain all right, title, and interest in and to this software, including all intellectual property rights. No implied licenses are granted.
40
+
41
+ Feedback, suggestions, bug reports, or proposed changes may be used without restriction or compensation unless separately agreed in writing.
42
+
43
+ ## 6. Termination
44
+
45
+ Any use outside this license automatically terminates your rights immediately. Upon termination, you must stop using the software and delete all copies in your possession or control.
46
+
47
+ ## 7. Commercial Permission
48
+
49
+ Commercial, production, hosted, payment-gated, customer-facing, or third-party use requires a separate written license or written approval from Cody Robertson or an authorized Mackody representative before use begins.
50
+
51
+ ## 8. Disclaimer
52
+
53
+ THE SOFTWARE IS PROVIDED "AS IS" AND "AS AVAILABLE" WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AVAILABILITY, ACCURACY, OR ERROR-FREE OPERATION.
54
+
55
+ TO THE MAXIMUM EXTENT PERMITTED BY LAW, CODY ROBERTSON, MACKODY, AND THEIR AFFILIATES WILL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES, OR FOR LOST PROFITS, LOST REVENUE, LOST DATA, BUSINESS INTERRUPTION, API CHARGES, CREDIT USAGE, OR PROCUREMENT OF SUBSTITUTE SERVICES.
56
+
57
+ ## 9. No Waiver
58
+
59
+ Failure to enforce any provision of this license is not a waiver. If any provision is held unenforceable, the remaining provisions remain in effect.
package/README.md CHANGED
@@ -1,54 +1,112 @@
1
1
  # Quick Enrich MCP
2
2
 
3
- Standalone MCP server for Quick Enrich's documented APIs. It is built for internal prospecting workflows: secure local API-key storage, exact person enrichment, reverse-email/phone lookup, domain lead pulls, contact/company finder calls, and compact batch envelopes for agent use.
3
+ NPM package: [`@mackody/quickenrich-mcp`](https://www.npmjs.com/package/@mackody/quickenrich-mcp)
4
+
5
+ Standalone MCP server and CLI for Quick Enrich's documented APIs. It is built for internal prospecting workflows: secure local API-key storage, exact person enrichment, reverse-email/phone lookup, domain lead pulls, contact/company finder calls, CSV/JSONL workflows, and compact batch envelopes for agent use.
4
6
 
5
7
  Docs source: [Quick Enrich API Documentation](https://app.quickenrich.io/docs).
6
8
 
7
- ## Install
9
+ ## License
8
10
 
9
- ```bash
10
- npm install
11
- npm run test
12
- ```
11
+ This package is not open source. It is published under the [Quick Enrich MCP Restricted License](./LICENSE.md) for controlled internal evaluation only.
12
+
13
+ Commercial, production, hosted, payment-gated, customer-facing, SaaS, resale, agency, consulting, marketplace, or third-party service integrations require prior written permission from Cody Robertson or an authorized Mackody representative.
13
14
 
14
- Package/agent setup after install:
15
+ ## Install From NPM
15
16
 
16
17
  ```bash
18
+ npm install -g @mackody/quickenrich-mcp
17
19
  quickenrich-token set
18
20
  quickenrich-token doctor
19
- quickenrich-agent-docs install --cwd /path/to/agent-project
20
21
  ```
21
22
 
22
- `quickenrich-agent-docs install` appends exactly two managed Quick Enrich how-to-use lines to `CLAUDE.md` and `AGENTS.md` in the target project. It is idempotent. Remove those managed lines with:
23
+ Requires Node.js 20 or newer.
24
+
25
+ You can also run without a global install:
23
26
 
24
27
  ```bash
25
- quickenrich-agent-docs uninstall --cwd /path/to/agent-project
28
+ npx -p @mackody/quickenrich-mcp quickenrich-token set
29
+ npx -y @mackody/quickenrich-mcp
26
30
  ```
27
31
 
28
- Set an API key with either an environment variable:
32
+ ## MCP Client Config
29
33
 
30
- ```bash
31
- export QUICKENRICH_API_KEY=...
34
+ Global install config:
35
+
36
+ ```json
37
+ {
38
+ "mcpServers": {
39
+ "quick-enrich": {
40
+ "command": "quickenrich-mcp",
41
+ "env": {
42
+ "QUICKENRICH_MCP_TOOL_MODE": "agent",
43
+ "QUICKENRICH_MCP_RESPONSE_MODE": "compact"
44
+ }
45
+ }
46
+ }
47
+ }
32
48
  ```
33
49
 
34
- or the local secure config:
50
+ No-install `npx` config:
51
+
52
+ ```json
53
+ {
54
+ "mcpServers": {
55
+ "quick-enrich": {
56
+ "command": "npx",
57
+ "args": ["-y", "@mackody/quickenrich-mcp"],
58
+ "env": {
59
+ "QUICKENRICH_MCP_TOOL_MODE": "agent",
60
+ "QUICKENRICH_MCP_RESPONSE_MODE": "compact"
61
+ }
62
+ }
63
+ }
64
+ }
65
+ ```
66
+
67
+ MCP server alias: `quick-enrich`
68
+
69
+ Use `QUICKENRICH_MCP_TOOL_MODE=minimal` for only auth, graph, natural-language planning, and batch pull. Use `QUICKENRICH_MCP_TOOL_MODE=full` when you want every low-level endpoint and verbose schema descriptions. Default `agent` mode is the recommended NPM install mode.
70
+
71
+ ## Auth
35
72
 
36
73
  ```bash
37
- node scripts/quickenrich-token.mjs set
38
- node scripts/quickenrich-token.mjs status
74
+ quickenrich-token set
75
+ quickenrich-token status
76
+ quickenrich-token doctor
39
77
  ```
40
78
 
41
79
  The token CLI stores the key at `~/.config/quickenrich-mcp/config.json` with `0600` permissions. Env vars override the config file.
42
80
 
43
- ## MCP
81
+ For CI or ephemeral MCP hosts, set:
82
+
83
+ ```bash
84
+ export QUICKENRICH_API_KEY=...
85
+ ```
44
86
 
45
- Use the bundled `.mcp.json` or run directly:
87
+ ## Agent Project Setup
88
+
89
+ After installing the package, add the two managed agent hints to a project:
46
90
 
47
91
  ```bash
48
- node scripts/quickenrich-mcp.mjs
92
+ quickenrich-agent-docs install --cwd /path/to/agent-project
49
93
  ```
50
94
 
51
- MCP server alias: `quick-enrich`
95
+ `quickenrich-agent-docs install` appends exactly two Quick Enrich how-to-use lines to `CLAUDE.md` and `AGENTS.md`. It is idempotent.
96
+
97
+ Remove those managed lines with:
98
+
99
+ ```bash
100
+ quickenrich-agent-docs uninstall --cwd /path/to/agent-project
101
+ ```
102
+
103
+ ## Package Binaries
104
+
105
+ - `quickenrich-mcp`: stdio MCP server.
106
+ - `quickenrich-token`: secure local API-key setup and auth diagnostics.
107
+ - `quickenrich-agent-docs`: install/uninstall agent usage hints in `CLAUDE.md` and `AGENTS.md`.
108
+
109
+ ## Agent Tool Surface
52
110
 
53
111
  Default agent tools:
54
112
 
@@ -76,8 +134,6 @@ Full-mode tools (`QUICKENRICH_MCP_TOOL_MODE=full`) also expose:
76
134
  - `quickenrich_batch_pull_leads`
77
135
  - `quickenrich_lookup_values`
78
136
 
79
- Use `QUICKENRICH_MCP_TOOL_MODE=minimal` for only auth, graph, natural-language planning, and batch pull. Use `QUICKENRICH_MCP_TOOL_MODE=full` when you want every low-level endpoint and verbose schema descriptions.
80
-
81
137
  Default agent mode intentionally emits slim schemas and short tool descriptions so cold agents do not spend context on prose they can recover from `quickenrich_agent_graph`. The default `tools/list` surface is budgeted under 8 KB and includes lookup discovery because finder filters need valid country, industry, employee-range, revenue-range, and service values.
82
138
 
83
139
  Responses default to compact mode with a 12 KB output budget, 12 array items, 48 object keys, depth 4, and 240-character strings. Pass `response: { "mode": "full", "maxOutputChars": 64000 }` for rawer output, or `response: { "mode": "meta" }` for shape-only output.
@@ -174,7 +230,7 @@ Domain batch pulls use a shared token-bucket limiter per MCP client plus a rolli
174
230
  ```bash
175
231
  QUICKENRICH_DOMAIN_SEARCH_REQUESTS_PER_MINUTE=300 \
176
232
  QUICKENRICH_DOMAIN_SEARCH_BURST_SIZE=8 \
177
- node scripts/quickenrich-mcp.mjs
233
+ quickenrich-mcp
178
234
  ```
179
235
 
180
236
  The batch result includes `throttle` metadata showing the active ceiling, burst, total acquired slots, and sleep time. Repeated calls through the same MCP process share buckets, so follow-up batches do not reset the burst. If a final 429 includes `Retry-After`, the limiter cools down before later starts.
@@ -183,7 +239,18 @@ Use `throttle_scope:"shared"` to coordinate the rolling request ceiling across m
183
239
 
184
240
  Other batch lanes also use small compliant default bursts: employee search, phone search, and reverse email default to `burst_size=16`; Contact Finder and Company Finder default to `burst_size=4`.
185
241
 
186
- ## Smoke Tests
242
+ ## Source Development
243
+
244
+ Clone the repo only if you are developing the package itself:
245
+
246
+ ```bash
247
+ git clone https://github.com/codyrobertson/quickenrich-mcp.git
248
+ cd quickenrich-mcp
249
+ npm install
250
+ npm run smoke
251
+ ```
252
+
253
+ Run the full local plus live suite when a Quick Enrich key is configured:
187
254
 
188
255
  ```bash
189
256
  npm run test
@@ -265,19 +332,3 @@ Latest default token-bucket paid local run on 2026-07-09:
265
332
  - `direct_core_batch`: 266.64 ms, 2 requests, 2 credits, 2 leads.
266
333
  - `mcp_batch_stdio`: 318.64 ms, 2 requests, 2 credits, 2 leads.
267
334
  - Result: MCP stdio batch was 2.09x faster than naive raw sequential API usage, cut request volume 2x, and saved 50% credits on duplicate inputs.
268
-
269
- ## NPM Publish Prep
270
-
271
- Dry-run the package contents before publishing:
272
-
273
- ```bash
274
- npm run check
275
- npm run smoke
276
- npm run pack:dry-run
277
- ```
278
-
279
- Actual publish is intentionally manual:
280
-
281
- ```bash
282
- npm publish --access public
283
- ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mackody/quickenrich-mcp",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "type": "module",
5
5
  "description": "Standalone MCP server and CLI for Quick Enrich lead enrichment APIs.",
6
6
  "bin": {
@@ -15,6 +15,7 @@
15
15
  "agents/",
16
16
  "scripts/",
17
17
  "skills/",
18
+ "LICENSE.md",
18
19
  "README.md"
19
20
  ],
20
21
  "scripts": {
@@ -36,5 +37,5 @@
36
37
  "engines": {
37
38
  "node": ">=20"
38
39
  },
39
- "license": "UNLICENSED"
40
+ "license": "SEE LICENSE IN LICENSE.md"
40
41
  }