@paidfor/mcp 0.5.0 → 0.6.0
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 +13 -3
- package/dist/pay.d.ts +15 -0
- package/dist/pay.js +55 -4
- package/dist/stdio.js +5 -2
- package/dist/team.d.ts +80 -0
- package/dist/team.js +170 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -45,7 +45,7 @@ The read tools use the public JSON API (`GET https://paidfor.dev/v1/check`, `/v1
|
|
|
45
45
|
|
|
46
46
|
## Let your agent pay, safely (stdio only)
|
|
47
47
|
|
|
48
|
-
`pay_x402` pays an x402 seller with **your own wallet**, through `@paidfor/x402-safe-fetch` 0.
|
|
48
|
+
`pay_x402` pays an x402 seller with **your own wallet**, through `@paidfor/x402-safe-fetch` 0.4.0: it checks the seller on paidfor first and refuses `avoid` sellers, refuses quotes over 1.1x the listed price, caps the amount per call and per day, never pays twice for the same `intent_id` (a retry returns the stored result), keeps receipts in `~/.paidfor/receipts/`, and reports the outcome with its proof of payment (payer, nonce, pay-to, tx hash) to `https://paidfor.dev/v1/telemetry`, where it is checked on Base. It returns the status, the body (truncated at 64 KB) and a receipt with the amount, pay-to, tx hash and basescan link, the seller verdict at purchase, the validator results and the `verification_url` that shows whether the index verified it.
|
|
49
49
|
|
|
50
50
|
**Use a dedicated wallet holding a few dollars, never your main wallet.** There is no custody and no account: the key stays on your machine, is read only to sign, and is never logged, returned by a tool or sent anywhere.
|
|
51
51
|
|
|
@@ -76,7 +76,15 @@ Verify by asking the agent to call `wallet_status`.
|
|
|
76
76
|
PAIDFOR_TEAM_KEY=pft_... npx -y @paidfor/mcp wallet register --label "research agent"
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
It asks paidfor for a challenge, signs it with the wallet's key (the key is sent nowhere) and sends the signature back. The wallet is `PAIDFOR_WALLET_KEY_FILE` or `PAIDFOR_WALLET_KEY` when set, else `~/.paidfor/wallet.key
|
|
79
|
+
It asks paidfor for a challenge, signs it with the wallet's key (the key is sent nowhere) and sends the signature back. The wallet is `PAIDFOR_WALLET_KEY_FILE` or `PAIDFOR_WALLET_KEY` when set, else `~/.paidfor/wallet.key`; if the MCP client is configured with a key file elsewhere, set `PAIDFOR_WALLET_KEY_FILE` to that same path for this command too, or it registers the default wallet instead. A wallet registered with a key starts paused: open the team page, check its limits, untick Paused and save. The team key is read from the environment only, never from an argument. Written into the command it stays in your shell history; to keep it out, `read -rs PAIDFOR_TEAM_KEY && export PAIDFOR_TEAM_KEY` first and run the command without the prefix. Registering does not configure the server: `pay_x402` still needs `PAIDFOR_WALLET_KEY_FILE` in the MCP client config, as above.
|
|
80
|
+
|
|
81
|
+
**Ask the team before each payment (0.6.0).** Registering alone does not put payments under the team's rules. Give the server the team key too:
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
"env": { "PAIDFOR_WALLET_KEY_FILE": "/Users/you/.paidfor/wallet.key", "PAIDFOR_TEAM_KEY": "pft_..." }
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
With `PAIDFOR_TEAM_KEY` set, `pay_x402` asks `POST /v1/team/authorize` after its own checks and before it signs, and the local caps still apply. It pays only on an approval, and signs with the approval's reference as the EIP-3009 nonce and its deadline as `validBefore`, so the payment can be matched to the ledger. If the server is unreachable or answers anything but a clear decision, nothing is paid. A decline comes back with the team's reason. A payment waiting for a person comes back with the link to approve it and the `intent_id` to call again with. After a payment the outcome goes to `POST /v1/team/outcome`; a report the server cannot take is kept in `~/.paidfor/team-outcomes/` and sent before the next payment. The key sits in your MCP client's config, so treat that file as a secret. The key cannot change rules, keys or approvals. The agent holds its own wallet key here, so a payment made some other way is not stopped. Stdio only: the hosted server never pays.
|
|
80
88
|
|
|
81
89
|
**Routing a paid URL (0.4.1).** The model should reach for `pay_x402` whenever a URL is paid, metered, pay-per-call, x402, priced in USDC, said to charge a fee, or has answered 402 to any other fetch, even when the client also has a generic web fetch tool and the user never says how to pay. The tool is described as the way to fetch such a URL end to end (it sends the request, handles the 402, pays under the caps and returns the body), the description says a plain fetch fails on these URLs with 402, and the stdio server adds the same rule to its `instructions` only when the paying tools are registered; the hosted server's text is unchanged. `eval/routing.mjs` measures the first-call rate per model and prompt shape (`pnpm eval:routing`; results by date in `eval/routing-<date>.md`). `PAIDFOR_FETCH_ALIAS=1` also registers the same handler as `fetch_paid_url`, for clients that route by a fetch-shaped name; the eval compares both and the alias is off by default.
|
|
82
90
|
|
|
@@ -87,6 +95,7 @@ It asks paidfor for a challenge, signs it with the wallet's key (the key is sent
|
|
|
87
95
|
| `PAIDFOR_MAX_PER_CALL_USD` | `0.50` | most one call may pay; `max_usd` can lower it, never raise it |
|
|
88
96
|
| `PAIDFOR_DAILY_CAP_USD` | `5` | most all calls may pay per UTC day (tracked in `~/.paidfor/spend.json`) |
|
|
89
97
|
| `BASE_RPC_URL` | `https://mainnet.base.org` | used only by `wallet_status` for the balance |
|
|
98
|
+
| `PAIDFOR_TEAM_KEY` | | with a wallet: ask the team's rules before each payment and report the outcome (`https` only, or a server on this machine); also used by `wallet register` |
|
|
90
99
|
| `PAIDFOR_FETCH_ALIAS` | off | `1` also registers `pay_x402` as `fetch_paid_url` (same handler, schema and caps) |
|
|
91
100
|
|
|
92
101
|
Without a key (or with a misconfigured one, reported on stderr) the stdio server is the read-only server. The hosted server at `mcp.paidfor.dev` and the site's `/mcp` route never register `pay_x402` or `wallet_status`, by design: they never hold a key.
|
|
@@ -121,7 +130,7 @@ Usage is counted by Manufact's gateway (every `tools/call` with client and sessi
|
|
|
121
130
|
|
|
122
131
|
## Tests
|
|
123
132
|
|
|
124
|
-
`pnpm test` builds and runs `test/*.test.mjs` with Node's test runner: `hosted-snapshot` fails on any change to the hosted server's tool list, instructions or empty resources/prompts lists (the ChatGPT app review rescans them daily; regenerate on purpose with `UPDATE_SNAPSHOT=1`), `pay-wording` checks the `pay_x402` framing, guarantees, annotations and the alias, `pay-replay` the replay line and the `intent_id` guidance against a local seller. The site's `vitest` suite (`test/mcp-pay.test.ts` at the repo root) covers the paying tools end to end against a local seller.
|
|
133
|
+
`pnpm test` builds and runs `test/*.test.mjs` with Node's test runner: `hosted-snapshot` fails on any change to the hosted server's tool list, instructions or empty resources/prompts lists (the ChatGPT app review rescans them daily; regenerate on purpose with `UPDATE_SNAPSHOT=1`), `pay-wording` checks the `pay_x402` framing, guarantees, annotations and the alias, `pay-replay` the replay line and the `intent_id` guidance against a local seller, `pay-team` team mode against a local seller and a scripted server. The site's `vitest` suite (`test/mcp-pay.test.ts` at the repo root) covers the paying tools end to end against a local seller, and `test/mcp-team.test.ts` runs team mode against the real server code.
|
|
125
134
|
|
|
126
135
|
## Claude Desktop extension
|
|
127
136
|
|
|
@@ -133,6 +142,7 @@ Usage is counted by Manufact's gateway (every `tools/call` with client and sessi
|
|
|
133
142
|
|
|
134
143
|
## Changelog
|
|
135
144
|
|
|
145
|
+
- **0.6.0** (unpublished): team mode. With `PAIDFOR_TEAM_KEY` set, `pay_x402` asks the team before signing, fails closed, signs the approval's nonce and deadline and reports the outcome. Needs `@paidfor/x402-safe-fetch` 0.4.0. The hosted server's tools and instructions are unchanged.
|
|
136
146
|
- **0.5.0** (unpublished): `paidfor-mcp wallet register` registers the configured wallet to a paidfor team (`PAIDFOR_TEAM_KEY`), signing the team's challenge locally; new test `wallet-register.test.mjs`. The hosted server's tools and instructions are unchanged.
|
|
137
147
|
- **0.4.1** (unpublished): `pay_x402` is framed as the way to fetch a paid (x402) URL end to end, its description says a generic fetch fails on such URLs with 402 and that any URL called paid, metered, x402 or that answered 402 goes to it with the same method, headers and body; the stdio server with a wallet adds the same routing rule to its instructions (`PAY_ROUTING_RULE` in `rules.ts`). A replayed result (same `intent_id`) now opens with the age and time of the stored result and says to call again with a new id for a new purchase; the description, the schema and the stdio rules say to reuse an `intent_id` only when retrying the same purchase after an error or timeout and to omit it otherwise (a date-only id chosen in three fresh sessions replayed instead of buying). Optional `fetch_paid_url` alias (`PAIDFOR_FETCH_ALIAS=1`). New `pnpm test` (hosted-surface snapshot, wording) and `pnpm eval:routing`. The hosted server's tools and instructions are unchanged.
|
|
138
148
|
- **0.4.0**: `report_x402_payment` on every transport; `mcpName` `dev.paidfor/paidfor`.
|
package/dist/pay.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
2
|
import { type Receipt, type SafeNetwork } from "@paidfor/x402-safe-fetch";
|
|
3
|
+
import { type TeamDecision } from "./team.js";
|
|
3
4
|
import { type Limits, type LoadedWallet } from "./wallet.js";
|
|
4
5
|
export declare const PAY_TOOL_NAMES: readonly ["pay_x402", "fetch_paid_url", "wallet_status"];
|
|
5
6
|
/** The second name for the pay_x402 handler, registered only with PayOptions.fetchAlias (PAIDFOR_FETCH_ALIAS=1 on stdio). */
|
|
@@ -30,6 +31,10 @@ export type PayOptions = {
|
|
|
30
31
|
balanceOf?: (address: `0x${string}`) => Promise<bigint>;
|
|
31
32
|
/** Also register the same handler as fetch_paid_url (PAY_ALIAS). Off by default; stdio turns it on with PAIDFOR_FETCH_ALIAS=1. */
|
|
32
33
|
fetchAlias?: boolean;
|
|
34
|
+
/** PAIDFOR_TEAM_KEY: ask the team's rules before every payment and report the outcome. Stdio only. */
|
|
35
|
+
teamKey?: string;
|
|
36
|
+
/** Tests only: how long to wait before the second try of an outcome report. */
|
|
37
|
+
teamRetryDelayMs?: number;
|
|
33
38
|
};
|
|
34
39
|
/** The receipt as pay_x402 reports it: what was paid, to whom, the proof, and how to check it. */
|
|
35
40
|
export declare function receiptSummary(r: Receipt): {
|
|
@@ -57,6 +62,16 @@ export declare function receiptSummary(r: Receipt): {
|
|
|
57
62
|
export declare function describeAge(ms: number): string;
|
|
58
63
|
/** The first line of a replayed pay_x402 result: the age and time of the stored result, so a second genuine purchase is not mistaken for a retry. */
|
|
59
64
|
export declare function replayHead(r: Receipt, now?: number): string;
|
|
65
|
+
/** What pay_x402 says when the team's rules, not the seller or the local caps, stop a payment. Nothing was paid in any of these. */
|
|
66
|
+
export declare function teamRefusal(d: Exclude<TeamDecision, {
|
|
67
|
+
kind: "approve";
|
|
68
|
+
}>, intentId: string, limits: unknown): {
|
|
69
|
+
isError?: boolean | undefined;
|
|
70
|
+
content: {
|
|
71
|
+
type: "text";
|
|
72
|
+
text: string;
|
|
73
|
+
}[];
|
|
74
|
+
};
|
|
60
75
|
export declare function truncateBody(body: string): {
|
|
61
76
|
body: string;
|
|
62
77
|
note: string | null;
|
package/dist/pay.js
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
* user's own wallet and report the verified outcome to the index. Only stdio.ts imports this module;
|
|
4
4
|
* the hosted service (index.ts) and the site's /mcp route never do, because they never hold a key.
|
|
5
5
|
*/
|
|
6
|
+
import { randomUUID } from "node:crypto";
|
|
6
7
|
import { mkdir } from "node:fs/promises";
|
|
7
8
|
import { join } from "node:path";
|
|
8
9
|
import { PaymentRefusedError, SafeFetchError, safeFetch } from "@paidfor/x402-safe-fetch";
|
|
@@ -10,6 +11,7 @@ import { createPublicClient, erc20Abi, http } from "viem";
|
|
|
10
11
|
import { base as baseChain } from "viem/chains";
|
|
11
12
|
import { z } from "zod";
|
|
12
13
|
import { INSTRUCTIONS, NO_ACCOUNT_PROMISE, PAID_URL_SIGNALS, PAY_ROUTING_RULE, PLAIN_FETCH_FAILS } from "./server.js";
|
|
14
|
+
import { TeamClient, outcomeFor } from "./team.js";
|
|
13
15
|
import { SpendLedger, fromMicro, paidforDir, toMicro } from "./wallet.js";
|
|
14
16
|
export const PAY_TOOL_NAMES = ["pay_x402", "fetch_paid_url", "wallet_status"];
|
|
15
17
|
/** The second name for the pay_x402 handler, registered only with PayOptions.fetchAlias (PAIDFOR_FETCH_ALIAS=1 on stdio). */
|
|
@@ -83,6 +85,20 @@ export function replayHead(r, now = Date.now()) {
|
|
|
83
85
|
const when = at && Number.isFinite(Date.parse(at)) ? `stored ${describeAge(now - Date.parse(at))} ago (${at})` : "stored earlier (time unknown, the original receipt file is gone)";
|
|
84
86
|
return `Replayed the result ${when} for intent ${r.intent_id}; nothing was paid again. If this is a new purchase, call again with a new intent_id.`;
|
|
85
87
|
}
|
|
88
|
+
/** What pay_x402 says when the team's rules, not the seller or the local caps, stop a payment. Nothing was paid in any of these. */
|
|
89
|
+
export function teamRefusal(d, intentId, limits) {
|
|
90
|
+
const res = (head, detail, isError = false) => text(`${head}\n\n${json({ ...detail, paid: false, intent_id: intentId, limits })}`, isError);
|
|
91
|
+
switch (d.kind) {
|
|
92
|
+
case "decline":
|
|
93
|
+
return res(`Declined by your team's rules: ${d.message}\nNothing was paid.`, { refused: "team_decline", reason: d.reason, ...(d.retry_after !== undefined ? { retry_after: d.retry_after } : {}) });
|
|
94
|
+
case "needs_approval":
|
|
95
|
+
return res(`A person has to approve this payment before it can be made. Nothing was paid.\nGive the user this link: ${d.approve_url}\nAfter they approve it, call pay_x402 again with intent_id "${intentId}". The request waits until ${d.expires_at}.${d.message ? ` ${d.message}` : ""}`, { refused: "team_needs_approval", approve_url: d.approve_url, expires_at: d.expires_at });
|
|
96
|
+
case "already_settled":
|
|
97
|
+
return res(`This purchase was already paid (settlement ${d.settlement_ref}, outcome ${d.outcome}); nothing was paid again. If this is a new purchase, call again with a new intent_id.`, { refused: "team_already_settled", settlement_ref: d.settlement_ref, outcome: d.outcome });
|
|
98
|
+
case "failed":
|
|
99
|
+
return res(`The team's rules could not be checked, so nothing was paid: ${d.message}\nCalling again with intent_id "${intentId}" is safe.`, { refused: "team_authorize_failed" }, true);
|
|
100
|
+
}
|
|
101
|
+
}
|
|
86
102
|
export function truncateBody(body) {
|
|
87
103
|
const buf = Buffer.from(body, "utf8");
|
|
88
104
|
if (buf.byteLength <= BODY_LIMIT_BYTES)
|
|
@@ -103,6 +119,9 @@ export async function registerPayTools(server, o) {
|
|
|
103
119
|
const base = o.baseUrl.replace(/\/$/, "");
|
|
104
120
|
const address = o.wallet.account.address;
|
|
105
121
|
const logger = { warn: (m) => void process.stderr.write(`${m}\n`) };
|
|
122
|
+
const team = o.teamKey ? new TeamClient({ baseUrl: base, teamKey: o.teamKey, dir, ...(o.fetch ? { fetch: o.fetch } : {}), warn: logger.warn, ...(o.teamRetryDelayMs !== undefined ? { retryDelayMs: o.teamRetryDelayMs } : {}) }) : null;
|
|
123
|
+
if (team)
|
|
124
|
+
void team.flush();
|
|
106
125
|
const payInput = {
|
|
107
126
|
url: z.string().url().describe("The URL to fetch and, if it answers 402, pay for"),
|
|
108
127
|
method: z.string().min(1).max(10).optional().describe("HTTP method, default GET"),
|
|
@@ -124,6 +143,20 @@ export async function registerPayTools(server, o) {
|
|
|
124
143
|
spent_today_usdc: fromMicro(spent),
|
|
125
144
|
...(max_usd !== undefined && max_usd > o.limits.maxPerCallUsd ? { note: `max_usd ${max_usd} is above PAIDFOR_MAX_PER_CALL_USD; capped at ${o.limits.maxPerCallUsd}` } : {}),
|
|
126
145
|
};
|
|
146
|
+
// Team mode needs the id before the first call: a person's approval is claimed by asking again with the same one.
|
|
147
|
+
const intentId = intent_id ?? (team ? randomUUID() : undefined);
|
|
148
|
+
const asked = {};
|
|
149
|
+
/** Say what happened to an approved payment. Undefined when the server approved nothing. */
|
|
150
|
+
const settle = async (r) => {
|
|
151
|
+
const d = asked.decision;
|
|
152
|
+
if (!team || d?.kind !== "approve")
|
|
153
|
+
return undefined;
|
|
154
|
+
if (!r) {
|
|
155
|
+
logger.warn(`paidfor-mcp: no receipt for approved intent ${intentId}, so no outcome was reported; the approval keeps counting against the budgets`);
|
|
156
|
+
return undefined;
|
|
157
|
+
}
|
|
158
|
+
return team.report(outcomeFor(r, address, d.auth_ref));
|
|
159
|
+
};
|
|
127
160
|
const sf = safeFetch(o.wallet.account, {
|
|
128
161
|
maxPerCallUsd: cap,
|
|
129
162
|
maxOverListedRatio: 1.1,
|
|
@@ -134,31 +167,48 @@ export async function registerPayTools(server, o) {
|
|
|
134
167
|
logger,
|
|
135
168
|
...(o.network ? { network: o.network } : {}),
|
|
136
169
|
...(o.fetch ? { fetch: o.fetch } : {}),
|
|
170
|
+
...(team
|
|
171
|
+
? {
|
|
172
|
+
authorize: async (q) => {
|
|
173
|
+
const d = await team.authorize({ wallet: q.payer, intent_id: q.intentId, resource_url: q.url, pay_to: q.payTo, amount_atomic: q.amountAtomic, network: q.network, asset: q.asset, scheme: q.scheme, protocol: "x402" });
|
|
174
|
+
asked.decision = d;
|
|
175
|
+
return d.kind === "approve" ? { approve: true, nonce: d.auth_ref, validBefore: d.valid_before } : { approve: false, message: d.message };
|
|
176
|
+
},
|
|
177
|
+
}
|
|
178
|
+
: {}),
|
|
137
179
|
});
|
|
138
180
|
try {
|
|
139
|
-
|
|
181
|
+
// Owed reports go first: until the server has them it answers the same purchase with pending_settlement.
|
|
182
|
+
await team?.flush();
|
|
183
|
+
const res = await sf(url, { method: method ?? "GET", headers, body }, { intentId });
|
|
140
184
|
const r = res.receipt;
|
|
141
185
|
if (r.paid && !r.replayed)
|
|
142
186
|
await ledger.add(toMicro(r.amount_usdc));
|
|
187
|
+
const teamReport = await settle(r);
|
|
143
188
|
const { body: out, note } = truncateBody(await res.text());
|
|
144
189
|
const head = r.replayed
|
|
145
190
|
? replayHead(r)
|
|
146
191
|
: r.paid
|
|
147
192
|
? `Paid ${r.amount_usdc} USDC to ${r.quote?.pay_to}; the seller answered HTTP ${res.status} (${r.outcome}).`
|
|
148
193
|
: `No payment was needed; the server answered HTTP ${res.status}.`;
|
|
149
|
-
return text(`${head}\n\n${json({ status: res.status, receipt: receiptSummary(r), limits, ...(note ? { body_note: note } : {}) })}\n\n--- response body ---\n${out}`);
|
|
194
|
+
return text(`${head}\n\n${json({ status: res.status, receipt: receiptSummary(r), limits, ...(teamReport ? { team_outcome_report: teamReport } : {}), ...(note ? { body_note: note } : {}) })}\n\n--- response body ---\n${out}`);
|
|
150
195
|
}
|
|
151
196
|
catch (e) {
|
|
197
|
+
if (asked.decision && asked.decision.kind !== "approve" && e instanceof PaymentRefusedError && e.code === "refused_authorize") {
|
|
198
|
+
return teamRefusal(asked.decision, e.receipt?.intent_id ?? intentId, limits);
|
|
199
|
+
}
|
|
200
|
+
const teamReport = await settle(e instanceof SafeFetchError ? e.receipt : undefined);
|
|
201
|
+
const reported = teamReport ? { team_outcome_report: teamReport } : {};
|
|
152
202
|
if (e instanceof PaymentRefusedError) {
|
|
153
203
|
const why = e.code === "refused_max_per_call" && dailyBinds
|
|
154
204
|
? `refused: today's cap of ${o.limits.dailyCapUsd} USD (PAIDFOR_DAILY_CAP_USD) leaves ${fromMicro(Math.max(leftMicro, 0))} USDC. ${e.message}`
|
|
155
205
|
: e.code === "refused_max_per_call"
|
|
156
206
|
? `refused: the quote is above this call's cap of ${cap} USD (max_usd, capped by PAIDFOR_MAX_PER_CALL_USD ${o.limits.maxPerCallUsd}). ${e.message}`
|
|
157
207
|
: `refused: ${e.message}`;
|
|
158
|
-
return text(`${why}\nNothing was paid.\n\n${json({ refused: e.code, paid: false, seller_url: e.sellerUrl ?? e.receipt?.seller.seller_url ?? null, intent_id: e.receipt?.intent_id ??
|
|
208
|
+
return text(`${why}\nNothing was paid.\n\n${json({ refused: e.code, paid: false, seller_url: e.sellerUrl ?? e.receipt?.seller.seller_url ?? null, intent_id: e.receipt?.intent_id ?? intentId ?? null, limits, ...reported })}`);
|
|
159
209
|
}
|
|
160
210
|
if (e instanceof SafeFetchError) {
|
|
161
|
-
return text(`${e.code}: ${e.message}\n\n${json({ error: e.code, paid: e.receipt?.paid ?? false, receipt: e.receipt ? receiptSummary(e.receipt) : null, limits })}`, true);
|
|
211
|
+
return text(`${e.code}: ${e.message}\n\n${json({ error: e.code, paid: e.receipt?.paid ?? false, receipt: e.receipt ? receiptSummary(e.receipt) : null, limits, ...reported })}`, true);
|
|
162
212
|
}
|
|
163
213
|
return text(`error: ${e instanceof Error ? e.message : String(e)}`, true);
|
|
164
214
|
}
|
|
@@ -193,6 +243,7 @@ export async function registerPayTools(server, o) {
|
|
|
193
243
|
max_per_call_usd: o.limits.maxPerCallUsd,
|
|
194
244
|
daily_cap_usd: o.limits.dailyCapUsd,
|
|
195
245
|
spent_today_usdc: fromMicro(spent),
|
|
246
|
+
...(team ? { team_mode: true } : {}),
|
|
196
247
|
};
|
|
197
248
|
return text(`${usdc === null ? "Balance unavailable" : `${usdc} USDC on Base`} at ${address}.\n\n${json(s)}`);
|
|
198
249
|
});
|
package/dist/stdio.js
CHANGED
|
@@ -3,7 +3,8 @@
|
|
|
3
3
|
* `npx @paidfor/mcp`: the stdio server. With PAIDFOR_WALLET_KEY_FILE (or PAIDFOR_WALLET_KEY) set it also
|
|
4
4
|
* registers pay_x402 and wallet_status; without one it is the same read-only server as the hosted one.
|
|
5
5
|
* `paidfor-mcp wallet new` writes a fresh key to ~/.paidfor/wallet.key (mode 600) and prints the address.
|
|
6
|
-
* `paidfor-mcp wallet register` proves that wallet to a paidfor team (PAIDFOR_TEAM_KEY)
|
|
6
|
+
* `paidfor-mcp wallet register` proves that wallet to a paidfor team (PAIDFOR_TEAM_KEY). With PAIDFOR_TEAM_KEY also set on
|
|
7
|
+
* the server, pay_x402 asks the team's rules before every payment.
|
|
7
8
|
*/
|
|
8
9
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
9
10
|
import { DEFAULT_BASE, createServer } from "./server.js";
|
|
@@ -63,7 +64,9 @@ if (pay && limits) {
|
|
|
63
64
|
const { INSTRUCTIONS_WITH_PAY, registerPayTools } = await import("./pay.js");
|
|
64
65
|
const server = createServer({ baseUrl, instructions: INSTRUCTIONS_WITH_PAY });
|
|
65
66
|
// PAIDFOR_FETCH_ALIAS=1 also registers the handler as fetch_paid_url (eval/routing.mjs measures whether the second name helps).
|
|
66
|
-
|
|
67
|
+
// PAIDFOR_TEAM_KEY: every payment asks the team's rules first (docs/team-api.md).
|
|
68
|
+
const teamKey = process.env.PAIDFOR_TEAM_KEY?.trim() || undefined;
|
|
69
|
+
await registerPayTools(server, { wallet: pay, limits, baseUrl, fetchAlias: process.env.PAIDFOR_FETCH_ALIAS === "1", ...(teamKey ? { teamKey } : {}) });
|
|
67
70
|
await server.connect(new StdioServerTransport());
|
|
68
71
|
}
|
|
69
72
|
else {
|
package/dist/team.d.ts
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import type { Receipt } from "@paidfor/x402-safe-fetch";
|
|
2
|
+
export declare const AUTHORIZE_TIMEOUT_MS = 10000;
|
|
3
|
+
export declare const REPORT_TIMEOUT_MS = 5000;
|
|
4
|
+
export type AuthorizeBody = {
|
|
5
|
+
wallet: string;
|
|
6
|
+
intent_id: string;
|
|
7
|
+
resource_url: string;
|
|
8
|
+
pay_to: string;
|
|
9
|
+
amount_atomic: string;
|
|
10
|
+
network: string;
|
|
11
|
+
asset: string;
|
|
12
|
+
scheme: string;
|
|
13
|
+
protocol: "x402";
|
|
14
|
+
};
|
|
15
|
+
export type TeamDecision = {
|
|
16
|
+
kind: "approve";
|
|
17
|
+
auth_ref: string;
|
|
18
|
+
valid_before: number;
|
|
19
|
+
} | {
|
|
20
|
+
kind: "decline";
|
|
21
|
+
reason: string;
|
|
22
|
+
message: string;
|
|
23
|
+
retry_after?: number;
|
|
24
|
+
} | {
|
|
25
|
+
kind: "needs_approval";
|
|
26
|
+
approve_url: string;
|
|
27
|
+
expires_at: string;
|
|
28
|
+
message: string;
|
|
29
|
+
} | {
|
|
30
|
+
kind: "already_settled";
|
|
31
|
+
settlement_ref: string;
|
|
32
|
+
outcome: string;
|
|
33
|
+
message: string;
|
|
34
|
+
} | {
|
|
35
|
+
kind: "failed";
|
|
36
|
+
message: string;
|
|
37
|
+
};
|
|
38
|
+
export type OutcomeBody = {
|
|
39
|
+
wallet: string;
|
|
40
|
+
intent_id: string;
|
|
41
|
+
auth_ref: string;
|
|
42
|
+
paid: boolean;
|
|
43
|
+
settlement_ref?: string;
|
|
44
|
+
outcome?: string;
|
|
45
|
+
http_status?: number;
|
|
46
|
+
response_sha256?: string;
|
|
47
|
+
};
|
|
48
|
+
/** sent: the server has it. queued: kept on disk, sent again before the next payment. rejected: the server refused it for good. */
|
|
49
|
+
export type ReportState = "sent" | "queued" | "rejected";
|
|
50
|
+
/** What to report for a payment that was approved, from its receipt. */
|
|
51
|
+
export declare function outcomeFor(r: Receipt, wallet: string, authRef: string): OutcomeBody;
|
|
52
|
+
/** Exported for tests: a 200's body as a decision. Anything not exactly one of the contract's answers is "failed". */
|
|
53
|
+
export declare function readDecision(b: unknown): TeamDecision;
|
|
54
|
+
export declare class TeamClient {
|
|
55
|
+
private readonly base;
|
|
56
|
+
private readonly key;
|
|
57
|
+
private readonly queueDir;
|
|
58
|
+
private readonly fetchFn;
|
|
59
|
+
private readonly warn;
|
|
60
|
+
private readonly retryDelayMs;
|
|
61
|
+
/** The key travels in a header. Plain http is for a server on this machine only. */
|
|
62
|
+
private readonly keySafe;
|
|
63
|
+
constructor(o: {
|
|
64
|
+
baseUrl: string;
|
|
65
|
+
teamKey: string;
|
|
66
|
+
dir: string;
|
|
67
|
+
fetch?: typeof globalThis.fetch;
|
|
68
|
+
warn?: (m: string) => void;
|
|
69
|
+
retryDelayMs?: number;
|
|
70
|
+
});
|
|
71
|
+
private post;
|
|
72
|
+
/** Never throws: anything but a 200 with a readable decision is { kind: "failed" }. */
|
|
73
|
+
authorize(body: AuthorizeBody): Promise<TeamDecision>;
|
|
74
|
+
/** One try. "retry" means the server could not take it now; a 4xx will never be taken, so it is not kept. */
|
|
75
|
+
private send;
|
|
76
|
+
private queueFile;
|
|
77
|
+
report(body: OutcomeBody): Promise<ReportState>;
|
|
78
|
+
/** Send what earlier reports left behind. Stops at the first one the server cannot take now. Never throws. */
|
|
79
|
+
flush(): Promise<void>;
|
|
80
|
+
}
|
package/dist/team.js
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Team mode: the two calls pay_x402 makes around a payment (docs/team-api.md). `authorize` asks before signing and
|
|
3
|
+
* turns anything but a clean decision into "failed", which pays nothing. `report` says what happened afterwards; a
|
|
4
|
+
* report the server could not take is kept on disk and sent again, because an approval nobody reports keeps counting
|
|
5
|
+
* against the budgets. Only pay.ts imports this module.
|
|
6
|
+
*/
|
|
7
|
+
import { createHash } from "node:crypto";
|
|
8
|
+
import { mkdir, readFile, readdir, rename, unlink, writeFile } from "node:fs/promises";
|
|
9
|
+
import { join } from "node:path";
|
|
10
|
+
export const AUTHORIZE_TIMEOUT_MS = 10_000;
|
|
11
|
+
export const REPORT_TIMEOUT_MS = 5_000;
|
|
12
|
+
/** The words the server takes for a paid outcome. */
|
|
13
|
+
const PAID_OUTCOMES = ["ok", "non_delivery", "wrong_goods", "overcharge", "duplicate", "paid_no_response"];
|
|
14
|
+
/** What to report for a payment that was approved, from its receipt. */
|
|
15
|
+
export function outcomeFor(r, wallet, authRef) {
|
|
16
|
+
const base = { wallet, intent_id: r.intent_id, auth_ref: authRef };
|
|
17
|
+
// Nothing left this machine, or the seller says its settlement failed: the money did not move.
|
|
18
|
+
if (!r.paid || r.settlement.parsed?.success === false)
|
|
19
|
+
return { ...base, paid: false };
|
|
20
|
+
return {
|
|
21
|
+
...base,
|
|
22
|
+
paid: true,
|
|
23
|
+
// With no transaction hash the signed nonce is what finds the settlement on chain.
|
|
24
|
+
settlement_ref: r.tx_hash ?? r.nonce ?? authRef,
|
|
25
|
+
outcome: r.reported_outcome && PAID_OUTCOMES.includes(r.reported_outcome) ? r.reported_outcome : "non_delivery",
|
|
26
|
+
...(r.response ? { http_status: r.response.status } : {}),
|
|
27
|
+
...(r.response?.sha256 ? { response_sha256: r.response.sha256 } : {}),
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
const str = (v) => typeof v === "string" && v.length > 0;
|
|
31
|
+
function failedStatus(status, body) {
|
|
32
|
+
const said = body && typeof body === "object" && str(body.error) ? ` ${body.error.slice(0, 300)}` : "";
|
|
33
|
+
if (status === 401)
|
|
34
|
+
return { kind: "failed", message: `paidfor refused the team key; check PAIDFOR_TEAM_KEY.${said}` };
|
|
35
|
+
if (status === 404)
|
|
36
|
+
return { kind: "failed", message: `this wallet is not registered to the team; run: paidfor-mcp wallet register.${said}` };
|
|
37
|
+
return { kind: "failed", message: `paidfor answered HTTP ${status}.${said}` };
|
|
38
|
+
}
|
|
39
|
+
/** Exported for tests: a 200's body as a decision. Anything not exactly one of the contract's answers is "failed". */
|
|
40
|
+
export function readDecision(b) {
|
|
41
|
+
const bad = { kind: "failed", message: "paidfor's answer could not be read." };
|
|
42
|
+
if (!b || typeof b !== "object")
|
|
43
|
+
return bad;
|
|
44
|
+
const d = b;
|
|
45
|
+
const message = str(d.message) ? d.message : "";
|
|
46
|
+
switch (d.decision) {
|
|
47
|
+
case "approve":
|
|
48
|
+
return str(d.auth_ref) && typeof d.valid_before === "number" ? { kind: "approve", auth_ref: d.auth_ref, valid_before: d.valid_before } : bad;
|
|
49
|
+
case "decline":
|
|
50
|
+
return str(d.reason) ? { kind: "decline", reason: d.reason, message: message || d.reason, ...(typeof d.retry_after === "number" ? { retry_after: d.retry_after } : {}) } : bad;
|
|
51
|
+
case "needs_approval":
|
|
52
|
+
return str(d.approve_url) && str(d.expires_at) ? { kind: "needs_approval", approve_url: d.approve_url, expires_at: d.expires_at, message } : bad;
|
|
53
|
+
case "already_settled":
|
|
54
|
+
return { kind: "already_settled", settlement_ref: str(d.settlement_ref) ? d.settlement_ref : "unknown", outcome: str(d.outcome) ? d.outcome : "unknown", message };
|
|
55
|
+
default:
|
|
56
|
+
return bad;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
export class TeamClient {
|
|
60
|
+
base;
|
|
61
|
+
key;
|
|
62
|
+
queueDir;
|
|
63
|
+
fetchFn;
|
|
64
|
+
warn;
|
|
65
|
+
retryDelayMs;
|
|
66
|
+
/** The key travels in a header. Plain http is for a server on this machine only. */
|
|
67
|
+
keySafe;
|
|
68
|
+
constructor(o) {
|
|
69
|
+
this.base = o.baseUrl.replace(/\/$/, "");
|
|
70
|
+
this.key = o.teamKey;
|
|
71
|
+
this.queueDir = join(o.dir, "team-outcomes");
|
|
72
|
+
this.fetchFn = o.fetch ?? globalThis.fetch;
|
|
73
|
+
this.warn = o.warn ?? (() => undefined);
|
|
74
|
+
this.retryDelayMs = o.retryDelayMs ?? 250;
|
|
75
|
+
const u = new URL(this.base);
|
|
76
|
+
this.keySafe = u.protocol === "https:" || ["localhost", "127.0.0.1", "[::1]"].includes(u.hostname);
|
|
77
|
+
}
|
|
78
|
+
post(path, body, timeoutMs) {
|
|
79
|
+
return this.fetchFn(`${this.base}${path}`, {
|
|
80
|
+
method: "POST",
|
|
81
|
+
headers: { "content-type": "application/json", authorization: `Bearer ${this.key}` },
|
|
82
|
+
body: JSON.stringify(body),
|
|
83
|
+
redirect: "error", // the key goes to the configured origin and nowhere else
|
|
84
|
+
signal: AbortSignal.timeout(timeoutMs),
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
/** Never throws: anything but a 200 with a readable decision is { kind: "failed" }. */
|
|
88
|
+
async authorize(body) {
|
|
89
|
+
if (!this.keySafe)
|
|
90
|
+
return { kind: "failed", message: `refusing to send the team key to ${this.base}; use https.` };
|
|
91
|
+
let res;
|
|
92
|
+
try {
|
|
93
|
+
res = await this.post("/v1/team/authorize", body, AUTHORIZE_TIMEOUT_MS);
|
|
94
|
+
}
|
|
95
|
+
catch {
|
|
96
|
+
return { kind: "failed", message: "paidfor could not be reached." };
|
|
97
|
+
}
|
|
98
|
+
let parsed = null;
|
|
99
|
+
try {
|
|
100
|
+
parsed = await res.json();
|
|
101
|
+
}
|
|
102
|
+
catch {
|
|
103
|
+
/* an unreadable body is handled below */
|
|
104
|
+
}
|
|
105
|
+
return res.status === 200 ? readDecision(parsed) : failedStatus(res.status, parsed);
|
|
106
|
+
}
|
|
107
|
+
/** One try. "retry" means the server could not take it now; a 4xx will never be taken, so it is not kept. */
|
|
108
|
+
async send(body) {
|
|
109
|
+
if (!this.keySafe)
|
|
110
|
+
return "retry";
|
|
111
|
+
try {
|
|
112
|
+
const res = await this.post("/v1/team/outcome", body, REPORT_TIMEOUT_MS);
|
|
113
|
+
void res.body?.cancel().catch(() => undefined);
|
|
114
|
+
if (res.ok)
|
|
115
|
+
return "sent";
|
|
116
|
+
if (res.status >= 400 && res.status < 500 && res.status !== 408 && res.status !== 429) {
|
|
117
|
+
this.warn(`paidfor-mcp: the team outcome for intent ${body.intent_id} was refused with HTTP ${res.status}`);
|
|
118
|
+
return "rejected";
|
|
119
|
+
}
|
|
120
|
+
return "retry";
|
|
121
|
+
}
|
|
122
|
+
catch {
|
|
123
|
+
return "retry";
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
queueFile(body) {
|
|
127
|
+
return join(this.queueDir, `${createHash("sha256").update(`${body.intent_id}\n${body.auth_ref}`).digest("hex").slice(0, 40)}.json`);
|
|
128
|
+
}
|
|
129
|
+
async report(body) {
|
|
130
|
+
let r = await this.send(body);
|
|
131
|
+
if (r === "retry") {
|
|
132
|
+
await new Promise((d) => setTimeout(d, this.retryDelayMs));
|
|
133
|
+
r = await this.send(body);
|
|
134
|
+
}
|
|
135
|
+
if (r !== "retry")
|
|
136
|
+
return r;
|
|
137
|
+
try {
|
|
138
|
+
await mkdir(this.queueDir, { recursive: true, mode: 0o700 });
|
|
139
|
+
const file = this.queueFile(body);
|
|
140
|
+
await writeFile(`${file}.tmp`, JSON.stringify(body), { mode: 0o600 });
|
|
141
|
+
await rename(`${file}.tmp`, file);
|
|
142
|
+
}
|
|
143
|
+
catch (e) {
|
|
144
|
+
this.warn(`paidfor-mcp: could not keep the team outcome for intent ${body.intent_id}: ${e instanceof Error ? e.message : String(e)}`);
|
|
145
|
+
}
|
|
146
|
+
return "queued";
|
|
147
|
+
}
|
|
148
|
+
/** Send what earlier reports left behind. Stops at the first one the server cannot take now. Never throws. */
|
|
149
|
+
async flush() {
|
|
150
|
+
let names;
|
|
151
|
+
try {
|
|
152
|
+
names = (await readdir(this.queueDir)).filter((n) => n.endsWith(".json"));
|
|
153
|
+
}
|
|
154
|
+
catch {
|
|
155
|
+
return; // nothing queued yet
|
|
156
|
+
}
|
|
157
|
+
for (const name of names) {
|
|
158
|
+
const file = join(this.queueDir, name);
|
|
159
|
+
try {
|
|
160
|
+
const r = await this.send(JSON.parse(await readFile(file, "utf8")));
|
|
161
|
+
if (r === "retry")
|
|
162
|
+
return;
|
|
163
|
+
await unlink(file);
|
|
164
|
+
}
|
|
165
|
+
catch (e) {
|
|
166
|
+
this.warn(`paidfor-mcp: could not resend ${name}: ${e instanceof Error ? e.message : String(e)}`);
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@paidfor/mcp",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"mcpName": "dev.paidfor/paidfor",
|
|
5
5
|
"description": "MCP server for the paidfor.dev x402 seller index: check_x402_seller, list_reliable_sellers and recent_changes, plus pay_x402 (stdio, your own wallet)",
|
|
6
6
|
"license": "MIT",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
27
|
"@modelcontextprotocol/sdk": "^1.32.2",
|
|
28
|
-
"@paidfor/x402-safe-fetch": "0.
|
|
28
|
+
"@paidfor/x402-safe-fetch": "0.4.0",
|
|
29
29
|
"viem": "^2.57.13",
|
|
30
30
|
"zod": "^4.0.0"
|
|
31
31
|
},
|