@usethrottle/mcp 0.4.1 → 0.4.3
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 +19 -7
- package/dist/contract-index.json +1 -1
- package/dist/docs-index.json +1 -1
- package/dist/lib.cjs +377 -7
- package/dist/lib.cjs.map +1 -1
- package/dist/lib.d.cts +69 -1
- package/dist/lib.d.ts +69 -1
- package/dist/lib.js +371 -6
- package/dist/lib.js.map +1 -1
- package/dist/mcp.js +46 -5
- package/dist/mcp.js.map +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -67,12 +67,24 @@ than tools that fail when called.
|
|
|
67
67
|
|
|
68
68
|
## Writes
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
|
|
70
|
+
By default the server is read-only. Write tools register only when you start it
|
|
71
|
+
with `--allow-writes`, and only those the key is scoped for:
|
|
72
72
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
73
|
+
`create_customer`, `update_customer`, `create_checkout_link`, `create_quote`,
|
|
74
|
+
`send_quote`, `refund_payment`, `manage_subscription`, `cancel_subscription`,
|
|
75
|
+
`replay_webhook_delivery`, `send_test_webhook`.
|
|
76
|
+
|
|
77
|
+
On a production key they additionally need `--allow-live-writes`. Every write
|
|
78
|
+
call carries an idempotency key, so a retried tool call never acts twice.
|
|
79
|
+
`seed_test_data` is the one write that needs no flag, and it is refused outright
|
|
80
|
+
on a production key.
|
|
81
|
+
|
|
82
|
+
The hosted server at `mcp.usethrottle.dev` registers no write tools at all.
|
|
83
|
+
|
|
84
|
+
## Money
|
|
85
|
+
|
|
86
|
+
The library entry re-exports `@usethrottle/money` as `money` and `formatMoney`
|
|
87
|
+
by name, plus the `CurrencyCode` and `MoneyValue` types.
|
|
76
88
|
|
|
77
89
|
## Options
|
|
78
90
|
|
|
@@ -80,8 +92,8 @@ production keys and an idempotency key on every call.
|
|
|
80
92
|
| --- | --- |
|
|
81
93
|
| `--api-key <key>` | `THROTTLE_API_KEY` |
|
|
82
94
|
| `--api <url>` | `THROTTLE_API_URL`, else `https://api.usethrottle.dev` |
|
|
83
|
-
| `--allow-writes` | off
|
|
84
|
-
| `--allow-live-writes` | off |
|
|
95
|
+
| `--allow-writes` | off — registers the write tools above |
|
|
96
|
+
| `--allow-live-writes` | off — also required for writes on a production key |
|
|
85
97
|
|
|
86
98
|
A key belongs to one environment. To expose both production and a sandbox
|
|
87
99
|
environment, add two server entries with different keys and distinct names.
|