listbee-mcp 0.4.0 → 0.4.1
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.
- package/README.md +76 -12
- package/dist/generated/meta.js +1 -1
- package/dist/generated/schemas.js +1 -1
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -1,9 +1,19 @@
|
|
|
1
1
|
# listbee-mcp
|
|
2
2
|
|
|
3
|
+
[](https://insiders.vscode.dev/redirect/mcp/install?name=listbee&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22listbee-mcp%22%5D%2C%22env%22%3A%7B%22LISTBEE_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D)
|
|
4
|
+
|
|
3
5
|
MCP server for ListBee — commerce API for AI agents.
|
|
4
6
|
|
|
5
7
|
---
|
|
6
8
|
|
|
9
|
+
## Connect
|
|
10
|
+
|
|
11
|
+
**Remote (zero install):** `https://api.listbee.so/mcp` — for ChatGPT Apps, Claude API Connector, remote agents. Each request needs `Authorization: Bearer lb_...` header.
|
|
12
|
+
|
|
13
|
+
**Local (stdio):** `npx -y listbee-mcp` — for Claude Desktop, Cursor, VS Code, Cline.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
7
17
|
## Golden Path
|
|
8
18
|
|
|
9
19
|
Four calls to go from zero to a live, selling product page:
|
|
@@ -31,6 +41,8 @@ create_listing → set_deliverables → get_listing → publish_listing
|
|
|
31
41
|
|
|
32
42
|
## Install
|
|
33
43
|
|
|
44
|
+
Requires Node.js 20+.
|
|
45
|
+
|
|
34
46
|
### Claude Desktop
|
|
35
47
|
|
|
36
48
|
`~/.claude/claude_desktop_config.json`
|
|
@@ -40,7 +52,7 @@ create_listing → set_deliverables → get_listing → publish_listing
|
|
|
40
52
|
"mcpServers": {
|
|
41
53
|
"listbee": {
|
|
42
54
|
"command": "npx",
|
|
43
|
-
"args": ["listbee-mcp", "--api-key", "lb_..."]
|
|
55
|
+
"args": ["-y", "listbee-mcp", "--api-key", "lb_..."]
|
|
44
56
|
}
|
|
45
57
|
}
|
|
46
58
|
}
|
|
@@ -53,7 +65,7 @@ Or with an env var:
|
|
|
53
65
|
"mcpServers": {
|
|
54
66
|
"listbee": {
|
|
55
67
|
"command": "npx",
|
|
56
|
-
"args": ["listbee-mcp"],
|
|
68
|
+
"args": ["-y", "listbee-mcp"],
|
|
57
69
|
"env": {
|
|
58
70
|
"LISTBEE_API_KEY": "lb_..."
|
|
59
71
|
}
|
|
@@ -71,7 +83,7 @@ Or with an env var:
|
|
|
71
83
|
"mcpServers": {
|
|
72
84
|
"listbee": {
|
|
73
85
|
"command": "npx",
|
|
74
|
-
"args": ["listbee-mcp", "--api-key", "lb_..."]
|
|
86
|
+
"args": ["-y", "listbee-mcp", "--api-key", "lb_..."]
|
|
75
87
|
}
|
|
76
88
|
}
|
|
77
89
|
}
|
|
@@ -80,13 +92,13 @@ Or with an env var:
|
|
|
80
92
|
### Claude Code
|
|
81
93
|
|
|
82
94
|
```bash
|
|
83
|
-
claude mcp add listbee -- npx listbee-mcp --api-key lb_...
|
|
95
|
+
claude mcp add listbee -- npx -y listbee-mcp --api-key lb_...
|
|
84
96
|
```
|
|
85
97
|
|
|
86
98
|
### CLI
|
|
87
99
|
|
|
88
100
|
```bash
|
|
89
|
-
npx listbee-mcp --api-key lb_...
|
|
101
|
+
npx -y listbee-mcp --api-key lb_...
|
|
90
102
|
```
|
|
91
103
|
|
|
92
104
|
---
|
|
@@ -96,7 +108,7 @@ npx listbee-mcp --api-key lb_...
|
|
|
96
108
|
For hosted deployments (ChatGPT Apps, Claude API Connector, remote agents):
|
|
97
109
|
|
|
98
110
|
```bash
|
|
99
|
-
npx listbee-mcp --transport http --port 3000
|
|
111
|
+
npx -y listbee-mcp --transport http --port 3000
|
|
100
112
|
```
|
|
101
113
|
|
|
102
114
|
Each connecting agent provides their API key via `Authorization: Bearer` header.
|
|
@@ -119,31 +131,47 @@ docker run -p 8080:8080 listbee-mcp
|
|
|
119
131
|
|
|
120
132
|
| Flag | Env var | Default | Description |
|
|
121
133
|
|------|---------|---------|-------------|
|
|
122
|
-
| `--api-key <key>` | `LISTBEE_API_KEY` | — | ListBee API key (required) |
|
|
134
|
+
| `--api-key <key>` | `LISTBEE_API_KEY` | — | ListBee API key (required for stdio) |
|
|
123
135
|
| `--base-url <url>` | `LISTBEE_BASE_URL` | `https://api.listbee.so` | API base URL |
|
|
136
|
+
| `--transport <stdio\|http>` | — | `stdio` | Transport mode |
|
|
137
|
+
| `--port <number>` | `PORT` | `8080` | HTTP port (http mode only) |
|
|
124
138
|
| `--tools <list>` | — | all tools | Comma-separated list of tools to load |
|
|
139
|
+
| `--help`, `-h` | — | — | Show help |
|
|
125
140
|
|
|
126
141
|
**Selective tool loading** — load only what you need:
|
|
127
142
|
|
|
128
143
|
```bash
|
|
129
|
-
npx listbee-mcp --api-key lb_... --tools create_listing,get_listing,publish_listing
|
|
144
|
+
npx -y listbee-mcp --api-key lb_... --tools create_listing,get_listing,publish_listing
|
|
130
145
|
```
|
|
131
146
|
|
|
132
147
|
---
|
|
133
148
|
|
|
134
149
|
## Tools
|
|
135
150
|
|
|
151
|
+
### Account & Auth
|
|
152
|
+
|
|
153
|
+
| Tool | Description |
|
|
154
|
+
|------|-------------|
|
|
155
|
+
| `create_account` | Create a new ListBee account. Sends an OTP to the email for verification. |
|
|
156
|
+
| `verify_otp` | Verify the OTP sent during signup. Returns an API key on success — store it. |
|
|
157
|
+
| `get_account` | Get the account's full state including readiness and billing status. |
|
|
158
|
+
| `update_account` | Update display name, bio, or avatar. These appear on product pages. |
|
|
159
|
+
| `delete_account` | Permanently delete the account and all data. Irreversible. |
|
|
160
|
+
| `create_api_key` | Create a new API key. Full key value returned only once. |
|
|
161
|
+
| `list_api_keys` | List all API keys. Shows prefixes and names, not full values. |
|
|
162
|
+
| `delete_api_key` | Delete and immediately revoke an API key. |
|
|
163
|
+
|
|
136
164
|
### Listings
|
|
137
165
|
|
|
138
166
|
| Tool | Description |
|
|
139
167
|
|------|-------------|
|
|
140
|
-
| `create_listing` | Create a new listing. Returns checkout URL and readiness. |
|
|
168
|
+
| `create_listing` | Create a new listing for sale. Returns checkout URL and readiness. |
|
|
141
169
|
| `get_listing` | Get full listing state including readiness. Call after every change. |
|
|
142
170
|
| `update_listing` | Update title, price, or other listing details. |
|
|
143
171
|
| `list_listings` | List all listings for the current account. |
|
|
144
172
|
| `publish_listing` | Publish a listing so buyers can access the product page. |
|
|
145
173
|
| `set_deliverables` | Attach digital content (file, URL, or text) for automatic delivery. |
|
|
146
|
-
| `remove_deliverables` | Remove deliverables to switch to external fulfillment. |
|
|
174
|
+
| `remove_deliverables` | Remove deliverables to switch to external fulfillment. Draft only. |
|
|
147
175
|
| `delete_listing` | Permanently delete a listing. |
|
|
148
176
|
|
|
149
177
|
### Orders
|
|
@@ -153,6 +181,27 @@ npx listbee-mcp --api-key lb_... --tools create_listing,get_listing,publish_list
|
|
|
153
181
|
| `list_orders` | See all sales and order status. |
|
|
154
182
|
| `get_order` | Get full order details including buyer info and payment. |
|
|
155
183
|
| `deliver_order` | Push digital content to a buyer (external fulfillment only). |
|
|
184
|
+
| `ship_order` | Record shipping info and mark order as fulfilled (external fulfillment). |
|
|
185
|
+
| `refund_order` | Issue a full refund for an order through Stripe. |
|
|
186
|
+
|
|
187
|
+
### Customers
|
|
188
|
+
|
|
189
|
+
| Tool | Description |
|
|
190
|
+
|------|-------------|
|
|
191
|
+
| `list_customers` | List all buyers who have purchased. Auto-populated from orders. |
|
|
192
|
+
| `get_customer` | Get a customer by ID — total orders, total spent, purchase history. |
|
|
193
|
+
|
|
194
|
+
### Webhooks
|
|
195
|
+
|
|
196
|
+
| Tool | Description |
|
|
197
|
+
|------|-------------|
|
|
198
|
+
| `create_webhook` | Create a webhook endpoint. Returns a `whsec_` secret for signature verification. |
|
|
199
|
+
| `list_webhooks` | List all webhook endpoints for the account. |
|
|
200
|
+
| `update_webhook` | Update a webhook URL or event filter. |
|
|
201
|
+
| `delete_webhook` | Delete a webhook endpoint. Irreversible. |
|
|
202
|
+
| `test_webhook` | Send a test event to verify webhook configuration before going live. |
|
|
203
|
+
| `list_webhook_events` | List recent events for a webhook — delivery status, attempts, errors. |
|
|
204
|
+
| `retry_webhook_event` | Retry delivery of a failed webhook event. |
|
|
156
205
|
|
|
157
206
|
### Files
|
|
158
207
|
|
|
@@ -165,6 +214,7 @@ npx listbee-mcp --api-key lb_... --tools create_listing,get_listing,publish_list
|
|
|
165
214
|
| Tool | Description |
|
|
166
215
|
|------|-------------|
|
|
167
216
|
| `start_stripe_connect` | Start Stripe Connect onboarding. Returns a URL — the human must open it in a browser. |
|
|
217
|
+
| `disconnect_stripe` | Disconnect the Stripe account from ListBee. |
|
|
168
218
|
|
|
169
219
|
---
|
|
170
220
|
|
|
@@ -179,7 +229,7 @@ Every listing response includes a `readiness` object that tells you exactly what
|
|
|
179
229
|
"publishable": false,
|
|
180
230
|
"actions": [
|
|
181
231
|
{
|
|
182
|
-
"code": "
|
|
232
|
+
"code": "connect_stripe",
|
|
183
233
|
"kind": "human",
|
|
184
234
|
"message": "Connect a Stripe account to accept payments.",
|
|
185
235
|
"resolve": {
|
|
@@ -188,7 +238,7 @@ Every listing response includes a `readiness` object that tells you exactly what
|
|
|
188
238
|
}
|
|
189
239
|
}
|
|
190
240
|
],
|
|
191
|
-
"next": "
|
|
241
|
+
"next": "connect_stripe"
|
|
192
242
|
}
|
|
193
243
|
}
|
|
194
244
|
```
|
|
@@ -202,10 +252,22 @@ Every listing response includes a `readiness` object that tells you exactly what
|
|
|
202
252
|
- `human` actions: requires human input (show the `message` and `url`)
|
|
203
253
|
- `readiness.next` — the highest-priority action code to resolve first
|
|
204
254
|
|
|
255
|
+
**Canonical action codes:** `connect_stripe`, `enable_charges`, `update_billing`, `configure_webhook`, `publish_listing`, `webhook_disabled`
|
|
256
|
+
|
|
205
257
|
**The pattern:** `create_listing` → `get_listing` → resolve each `api` action → surface `human` actions to the user → `publish_listing` when `publishable` is `true`.
|
|
206
258
|
|
|
207
259
|
---
|
|
208
260
|
|
|
261
|
+
## Debugging
|
|
262
|
+
|
|
263
|
+
Use [MCP Inspector](https://github.com/modelcontextprotocol/inspector) for interactive testing:
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
npx @modelcontextprotocol/inspector npx -y listbee-mcp
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
209
271
|
## Get an API Key
|
|
210
272
|
|
|
211
273
|
[console.listbee.so](https://console.listbee.so) — sign in, go to API Keys.
|
|
@@ -217,6 +279,8 @@ Every listing response includes a `readiness` object that tells you exactly what
|
|
|
217
279
|
- [API Reference](https://docs.listbee.so/api-reference) — full endpoint docs
|
|
218
280
|
- [OpenAPI Spec](https://api.listbee.so/openapi.json) — machine-readable spec
|
|
219
281
|
- [Docs](https://docs.listbee.so) — guides and integration examples
|
|
282
|
+
- [CHANGELOG](https://github.com/listbee-dev/listbee-mcp/blob/main/CHANGELOG.md) — version history
|
|
283
|
+
- [npm](https://www.npmjs.com/package/listbee-mcp) — npm package
|
|
220
284
|
- [GitHub](https://github.com/listbee-dev/listbee-mcp) — source
|
|
221
285
|
|
|
222
286
|
---
|
package/dist/generated/meta.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// source: openapi.json + mcp-tools.yaml
|
|
3
3
|
// Regenerate with: npm run generate
|
|
4
4
|
// openapi_version: 1.0.0
|
|
5
|
-
// generated_at: 2026-04-
|
|
5
|
+
// generated_at: 2026-04-06T07:16:33.004Z
|
|
6
6
|
// sha256: c8b0d9640ed32ea12e64304dc6799ff00452ce0d57e332cd3eb4bd37042a3254
|
|
7
7
|
export const meta = {
|
|
8
8
|
create_account: {
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// source: openapi.json + mcp-tools.yaml
|
|
3
3
|
// Regenerate with: npm run generate
|
|
4
4
|
// openapi_version: 1.0.0
|
|
5
|
-
// generated_at: 2026-04-
|
|
5
|
+
// generated_at: 2026-04-06T07:16:33.004Z
|
|
6
6
|
// sha256: c8b0d9640ed32ea12e64304dc6799ff00452ce0d57e332cd3eb4bd37042a3254
|
|
7
7
|
import { z } from "zod";
|
|
8
8
|
// Tool name → Zod schema (null means the tool takes no inputs)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "listbee-mcp",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "MCP server for ListBee — commerce API for AI agents",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -42,8 +42,13 @@
|
|
|
42
42
|
"homepage": "https://listbee.so",
|
|
43
43
|
"keywords": [
|
|
44
44
|
"mcp",
|
|
45
|
+
"mcp-server",
|
|
45
46
|
"listbee",
|
|
46
47
|
"commerce",
|
|
48
|
+
"ecommerce",
|
|
49
|
+
"payments",
|
|
50
|
+
"digital-products",
|
|
51
|
+
"checkout",
|
|
47
52
|
"ai-agents",
|
|
48
53
|
"model-context-protocol"
|
|
49
54
|
]
|