@paidfor/mcp 0.4.0 → 0.5.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 +25 -0
- package/dist/pay.d.ts +16 -1
- package/dist/pay.js +56 -23
- package/dist/rules.d.ts +10 -0
- package/dist/rules.js +13 -0
- package/dist/server.d.ts +3 -3
- package/dist/server.js +1 -1
- package/dist/stdio.js +35 -12
- package/dist/wallet.d.ts +25 -0
- package/dist/wallet.js +51 -0
- package/package.json +3 -1
- package/dist/http.d.ts +0 -1
- package/dist/http.js +0 -49
package/README.md
CHANGED
|
@@ -70,6 +70,16 @@ That writes `~/.paidfor/wallet.key` with mode 600 (it never overwrites an existi
|
|
|
70
70
|
|
|
71
71
|
Verify by asking the agent to call `wallet_status`.
|
|
72
72
|
|
|
73
|
+
**Put the wallet under a team's rules (0.5.0).** A paidfor team account (`https://paidfor.dev/team`) sets budgets and rules on a wallet. To register this wallet to your team, make a team key on that page and run:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
PAIDFOR_TEAM_KEY=pft_... npx -y @paidfor/mcp wallet register --label "research agent"
|
|
77
|
+
```
|
|
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`. 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.
|
|
80
|
+
|
|
81
|
+
**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
|
+
|
|
73
83
|
| env | default | |
|
|
74
84
|
|---|---|---|
|
|
75
85
|
| `PAIDFOR_WALLET_KEY_FILE` | | path to the key file; refused if group- or world-readable (`chmod 600`) |
|
|
@@ -77,6 +87,7 @@ Verify by asking the agent to call `wallet_status`.
|
|
|
77
87
|
| `PAIDFOR_MAX_PER_CALL_USD` | `0.50` | most one call may pay; `max_usd` can lower it, never raise it |
|
|
78
88
|
| `PAIDFOR_DAILY_CAP_USD` | `5` | most all calls may pay per UTC day (tracked in `~/.paidfor/spend.json`) |
|
|
79
89
|
| `BASE_RPC_URL` | `https://mainnet.base.org` | used only by `wallet_status` for the balance |
|
|
90
|
+
| `PAIDFOR_FETCH_ALIAS` | off | `1` also registers `pay_x402` as `fetch_paid_url` (same handler, schema and caps) |
|
|
80
91
|
|
|
81
92
|
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.
|
|
82
93
|
|
|
@@ -104,6 +115,14 @@ Usage is counted by Manufact's gateway (every `tools/call` with client and sessi
|
|
|
104
115
|
|
|
105
116
|
`pnpm build && pnpm eval` runs ten user messages that never mention paidfor through the Anthropic API (`ANTHROPIC_API_KEY` from the environment or an untracked `eval/.env`; model `claude-sonnet-5-5` or `EVAL_MODEL`) with the server's tools and instructions attached, by default with the tools deferred as Claude Code presents them, and prints which ones called the right tool first. Results by date in `eval/RESULTS.md`.
|
|
106
117
|
|
|
118
|
+
## Routing eval
|
|
119
|
+
|
|
120
|
+
`pnpm build && pnpm eval:routing` (`eval/routing.mjs`) runs paid-URL prompts that never mention paidfor, wallets or tool names through the Anthropic API on `claude-sonnet-5-5` and `claude-opus-5-5`, five trials each, with every tool simulated and nothing paid. Two scenarios: the default `hosted` is the primary adoption path, the hosted server's four tools (no wallet) next to the user's own `web_fetch` and a third-party `x402_pay`, measuring how often the model checks the seller before its first payment attempt, refuses an avoid seller, and reports a payment with the right transaction hash; `EVAL_SCENARIO=stdio` is the stdio server with a wallet next to a generic `web_fetch`, measuring how often the first fetch of a paid URL goes to `pay_x402`. Variants compare wordings (`EVAL_VARIANTS`); the hosted text is frozen by the listings, so its directive variant is a what-if. Results by date in `eval/routing-<date>.md`.
|
|
121
|
+
|
|
122
|
+
## Tests
|
|
123
|
+
|
|
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.
|
|
125
|
+
|
|
107
126
|
## Claude Desktop extension
|
|
108
127
|
|
|
109
128
|
`pnpm mcpb` bundles the stdio server with esbuild, writes `manifest.json` at the package version, validates and packs it with `@anthropic-ai/mcpb`, and copies it to the site's `public/paidfor.mcpb` (served at https://paidfor.dev/paidfor.mcpb).
|
|
@@ -111,3 +130,9 @@ Usage is counted by Manufact's gateway (every `tools/call` with client and sessi
|
|
|
111
130
|
## Registry
|
|
112
131
|
|
|
113
132
|
`server.json` is the Official MCP Registry entry (`dev.paidfor/paidfor`, matching `mcpName` in `package.json` from 0.3.3) and the manifest the site serves at https://paidfor.dev/.well-known/mcp.json and `/mcp.json`. Its `_meta` is `MANIFEST_META` from `src/setup.ts`; the site test fails when they differ. Publish npm first, then `mcp-publisher login dns --domain paidfor.dev` and `mcp-publisher publish` (checklist in `docs/listings.md` at the repo root).
|
|
133
|
+
|
|
134
|
+
## Changelog
|
|
135
|
+
|
|
136
|
+
- **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
|
+
- **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
|
+
- **0.4.0**: `report_x402_payment` on every transport; `mcpName` `dev.paidfor/paidfor`.
|
package/dist/pay.d.ts
CHANGED
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
2
|
import { type Receipt, type SafeNetwork } from "@paidfor/x402-safe-fetch";
|
|
3
3
|
import { type Limits, type LoadedWallet } from "./wallet.js";
|
|
4
|
-
export declare const PAY_TOOL_NAMES: readonly ["pay_x402", "wallet_status"];
|
|
4
|
+
export declare const PAY_TOOL_NAMES: readonly ["pay_x402", "fetch_paid_url", "wallet_status"];
|
|
5
|
+
/** The second name for the pay_x402 handler, registered only with PayOptions.fetchAlias (PAIDFOR_FETCH_ALIAS=1 on stdio). */
|
|
6
|
+
export declare const PAY_ALIAS = "fetch_paid_url";
|
|
5
7
|
export declare const BODY_LIMIT_BYTES: number;
|
|
8
|
+
/** When to reuse an intent_id: a retry of the same purchase only. A date-only id (observed: "bitcoin-price-2026-11-01" chosen in three fresh sessions) replays instead of buying. */
|
|
9
|
+
export declare const INTENT_RULE: string;
|
|
6
10
|
export declare const PAY_INSTRUCTIONS: string;
|
|
7
11
|
/** The stdio server's instructions with a wallet configured: the pay paragraph goes in before the no-account promise, which stays last. */
|
|
8
12
|
export declare const INSTRUCTIONS_WITH_PAY: string;
|
|
13
|
+
export declare const PAY_TITLE = "Fetch a paid (x402) URL, paying with your wallet";
|
|
14
|
+
export declare const PAY_ALIAS_TITLE = "Fetch a paid URL (same as pay_x402)";
|
|
9
15
|
export declare const PAY_DESCRIPTION: string;
|
|
16
|
+
/** The alias carries the whole description, so a client that shows tools by name routes to either; the last sentence stops double calls. */
|
|
17
|
+
export declare const PAY_ALIAS_DESCRIPTION: string;
|
|
10
18
|
export declare const WALLET_STATUS_DESCRIPTION: string;
|
|
11
19
|
export type PayOptions = {
|
|
12
20
|
wallet: LoadedWallet;
|
|
@@ -20,6 +28,8 @@ export type PayOptions = {
|
|
|
20
28
|
fetch?: typeof globalThis.fetch;
|
|
21
29
|
/** wallet_status balance; default reads USDC.balanceOf on Base over BASE_RPC_URL or https://mainnet.base.org. */
|
|
22
30
|
balanceOf?: (address: `0x${string}`) => Promise<bigint>;
|
|
31
|
+
/** Also register the same handler as fetch_paid_url (PAY_ALIAS). Off by default; stdio turns it on with PAIDFOR_FETCH_ALIAS=1. */
|
|
32
|
+
fetchAlias?: boolean;
|
|
23
33
|
};
|
|
24
34
|
/** The receipt as pay_x402 reports it: what was paid, to whom, the proof, and how to check it. */
|
|
25
35
|
export declare function receiptSummary(r: Receipt): {
|
|
@@ -27,6 +37,7 @@ export declare function receiptSummary(r: Receipt): {
|
|
|
27
37
|
paid: boolean;
|
|
28
38
|
replayed: boolean;
|
|
29
39
|
intent_id: string;
|
|
40
|
+
stored_at: string | null;
|
|
30
41
|
amount_usdc: string;
|
|
31
42
|
pay_to: string | null;
|
|
32
43
|
tx_hash: string | null;
|
|
@@ -42,6 +53,10 @@ export declare function receiptSummary(r: Receipt): {
|
|
|
42
53
|
reported_outcome: import("@paidfor/x402-safe-fetch").TelemetryOutcome | null;
|
|
43
54
|
verification_url: string | null;
|
|
44
55
|
};
|
|
56
|
+
/** "14 minutes", "3 hours", "2 days", "less than a minute". */
|
|
57
|
+
export declare function describeAge(ms: number): string;
|
|
58
|
+
/** 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
|
+
export declare function replayHead(r: Receipt, now?: number): string;
|
|
45
60
|
export declare function truncateBody(body: string): {
|
|
46
61
|
body: string;
|
|
47
62
|
note: string | null;
|
package/dist/pay.js
CHANGED
|
@@ -9,24 +9,37 @@ import { PaymentRefusedError, SafeFetchError, safeFetch } from "@paidfor/x402-sa
|
|
|
9
9
|
import { createPublicClient, erc20Abi, http } from "viem";
|
|
10
10
|
import { base as baseChain } from "viem/chains";
|
|
11
11
|
import { z } from "zod";
|
|
12
|
-
import { INSTRUCTIONS, NO_ACCOUNT_PROMISE } from "./server.js";
|
|
12
|
+
import { INSTRUCTIONS, NO_ACCOUNT_PROMISE, PAID_URL_SIGNALS, PAY_ROUTING_RULE, PLAIN_FETCH_FAILS } from "./server.js";
|
|
13
13
|
import { SpendLedger, fromMicro, paidforDir, toMicro } from "./wallet.js";
|
|
14
|
-
export const PAY_TOOL_NAMES = ["pay_x402", "wallet_status"];
|
|
14
|
+
export const PAY_TOOL_NAMES = ["pay_x402", "fetch_paid_url", "wallet_status"];
|
|
15
|
+
/** The second name for the pay_x402 handler, registered only with PayOptions.fetchAlias (PAIDFOR_FETCH_ALIAS=1 on stdio). */
|
|
16
|
+
export const PAY_ALIAS = "fetch_paid_url";
|
|
15
17
|
export const BODY_LIMIT_BYTES = 64 * 1024;
|
|
16
18
|
const USDC_BASE = "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
|
|
17
19
|
/** The client's smallest positive cap: with the daily budget spent, any quote is refused before signing. */
|
|
18
20
|
const MIN_CAP_USD = 0.000001;
|
|
19
|
-
|
|
20
|
-
|
|
21
|
+
/** When to reuse an intent_id: a retry of the same purchase only. A date-only id (observed: "bitcoin-price-2026-11-01" chosen in three fresh sessions) replays instead of buying. */
|
|
22
|
+
export const INTENT_RULE = "Reuse an intent_id only when retrying the same purchase after an error or timeout; for a new purchase omit it (the tool mints one) or use a fresh id with a random suffix, never an id made only of the task and the date. " +
|
|
23
|
+
"A replayed result says so in its first line with the age of the stored result: tell the user it is a replay, and call again with a new intent_id if a new purchase was meant.";
|
|
24
|
+
export const PAY_INSTRUCTIONS = `${PAY_ROUTING_RULE} ` +
|
|
25
|
+
"If pay_x402 is available, use it for every x402 purchase instead of any other way of paying; it checks the seller first, refuses avoid sellers, caps the amount, " +
|
|
26
|
+
"never pays twice for the same intent, and reports the verified outcome to the index by itself (report_x402_payment is not needed after it). " +
|
|
27
|
+
`${INTENT_RULE} ` +
|
|
21
28
|
"Tell the user the amount and the seller verdict before the first purchase from a new seller. " +
|
|
22
29
|
"pay_x402 signs with the user's own wallet on this machine; the key never leaves it.";
|
|
23
30
|
/** The stdio server's instructions with a wallet configured: the pay paragraph goes in before the no-account promise, which stays last. */
|
|
24
31
|
export const INSTRUCTIONS_WITH_PAY = INSTRUCTIONS.replace(`\n${NO_ACCOUNT_PROMISE}`, `\n${PAY_INSTRUCTIONS}\n${NO_ACCOUNT_PROMISE}`);
|
|
25
|
-
export const
|
|
26
|
-
|
|
27
|
-
|
|
32
|
+
export const PAY_TITLE = "Fetch a paid (x402) URL, paying with your wallet";
|
|
33
|
+
export const PAY_ALIAS_TITLE = "Fetch a paid URL (same as pay_x402)";
|
|
34
|
+
export const PAY_DESCRIPTION = "Fetches a paid (x402) URL end to end: sends the request, handles the HTTP 402 and pays the quoted USDC on Base with the user's own wallet under the configured caps, and returns the response body. " +
|
|
35
|
+
`${PLAIN_FETCH_FAILS.charAt(0).toUpperCase()}${PLAIN_FETCH_FAILS.slice(1)}; ` +
|
|
36
|
+
`any URL the user calls ${PAID_URL_SIGNALS}, and any URL that returned 402 to any other fetch, goes here instead, with the same method, headers and body. ` +
|
|
37
|
+
"Before paying it checks the seller on paidfor and refuses avoid sellers and quotes over 1.1x the listed price, caps the amount per call and per day, " +
|
|
38
|
+
"never pays twice for the same intent_id (a retry with the same id returns the stored result and says how old it is; omit intent_id for a new purchase), and reports the verified outcome to the index by itself. " +
|
|
28
39
|
"Returns the response status and body (64 KB max) and a receipt: amount, pay-to, tx hash with a basescan link, seller verdict, validator results and verification_url. " +
|
|
29
|
-
"On refusal it returns the reason and the seller page and pays nothing.";
|
|
40
|
+
"On refusal it returns the reason and the seller page and pays nothing. A URL that answers without a 402 is returned as is, nothing paid.";
|
|
41
|
+
/** The alias carries the whole description, so a client that shows tools by name routes to either; the last sentence stops double calls. */
|
|
42
|
+
export const PAY_ALIAS_DESCRIPTION = `${PAY_DESCRIPTION} This is the same tool as pay_x402 under a second name; call one of them, not both.`;
|
|
30
43
|
export const WALLET_STATUS_DESCRIPTION = "Call this when the user asks which wallet pays, how much USDC it holds, or how much of today's cap is left, and before a first purchase. " +
|
|
31
44
|
"Returns the address, the USDC balance on Base, the per-call and daily limits and today's spend. Never returns the key.";
|
|
32
45
|
const text = (s, isError = false) => ({ content: [{ type: "text", text: s }], ...(isError ? { isError: true } : {}) });
|
|
@@ -40,6 +53,7 @@ export function receiptSummary(r) {
|
|
|
40
53
|
paid: r.paid,
|
|
41
54
|
replayed: r.replayed,
|
|
42
55
|
intent_id: r.intent_id,
|
|
56
|
+
stored_at: r.replayed ? (r.original?.finished_at ?? null) : null,
|
|
43
57
|
amount_usdc: paid.amount_usdc,
|
|
44
58
|
pay_to: paid.quote?.pay_to ?? null,
|
|
45
59
|
tx_hash: tx,
|
|
@@ -51,6 +65,24 @@ export function receiptSummary(r) {
|
|
|
51
65
|
verification_url: paid.verification_url,
|
|
52
66
|
};
|
|
53
67
|
}
|
|
68
|
+
/** "14 minutes", "3 hours", "2 days", "less than a minute". */
|
|
69
|
+
export function describeAge(ms) {
|
|
70
|
+
const s = Math.max(0, Math.floor(ms / 1000));
|
|
71
|
+
const unit = (n, w) => `${n} ${w}${n === 1 ? "" : "s"}`;
|
|
72
|
+
if (s < 60)
|
|
73
|
+
return "less than a minute";
|
|
74
|
+
if (s < 3600)
|
|
75
|
+
return unit(Math.floor(s / 60), "minute");
|
|
76
|
+
if (s < 86400)
|
|
77
|
+
return unit(Math.floor(s / 3600), "hour");
|
|
78
|
+
return unit(Math.floor(s / 86400), "day");
|
|
79
|
+
}
|
|
80
|
+
/** 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. */
|
|
81
|
+
export function replayHead(r, now = Date.now()) {
|
|
82
|
+
const at = r.original?.finished_at ?? r.original?.started_at ?? null;
|
|
83
|
+
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
|
+
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
|
+
}
|
|
54
86
|
export function truncateBody(body) {
|
|
55
87
|
const buf = Buffer.from(body, "utf8");
|
|
56
88
|
if (buf.byteLength <= BODY_LIMIT_BYTES)
|
|
@@ -71,19 +103,15 @@ export async function registerPayTools(server, o) {
|
|
|
71
103
|
const base = o.baseUrl.replace(/\/$/, "");
|
|
72
104
|
const address = o.wallet.account.address;
|
|
73
105
|
const logger = { warn: (m) => void process.stderr.write(`${m}\n`) };
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
intent_id: z.string().min(1).max(200).optional().describe("Reuse the same id when retrying the same purchase; a retry returns the stored result without paying again"),
|
|
84
|
-
max_usd: z.number().positive().optional().describe("Most to pay for this call in USD; capped by PAIDFOR_MAX_PER_CALL_USD"),
|
|
85
|
-
},
|
|
86
|
-
}, async ({ url, method, headers, body, intent_id, max_usd }) => {
|
|
106
|
+
const payInput = {
|
|
107
|
+
url: z.string().url().describe("The URL to fetch and, if it answers 402, pay for"),
|
|
108
|
+
method: z.string().min(1).max(10).optional().describe("HTTP method, default GET"),
|
|
109
|
+
headers: z.record(z.string(), z.string()).optional().describe("Request headers"),
|
|
110
|
+
body: z.string().optional().describe("Request body, as text"),
|
|
111
|
+
intent_id: z.string().min(1).max(200).optional().describe("Omit for a new purchase (one is minted). Reuse the same id only when retrying the same purchase after an error or timeout: a retry returns the stored result, with its age, without paying again. Never a date-only id."),
|
|
112
|
+
max_usd: z.number().positive().optional().describe("Most to pay for this call in USD; capped by PAIDFOR_MAX_PER_CALL_USD"),
|
|
113
|
+
};
|
|
114
|
+
const pay = async ({ url, method, headers, body, intent_id, max_usd }) => {
|
|
87
115
|
const spent = await ledger.spentMicro();
|
|
88
116
|
const leftMicro = toMicro(o.limits.dailyCapUsd) - spent;
|
|
89
117
|
const perCall = Math.min(max_usd ?? o.limits.maxPerCallUsd, o.limits.maxPerCallUsd);
|
|
@@ -114,7 +142,7 @@ export async function registerPayTools(server, o) {
|
|
|
114
142
|
await ledger.add(toMicro(r.amount_usdc));
|
|
115
143
|
const { body: out, note } = truncateBody(await res.text());
|
|
116
144
|
const head = r.replayed
|
|
117
|
-
?
|
|
145
|
+
? replayHead(r)
|
|
118
146
|
: r.paid
|
|
119
147
|
? `Paid ${r.amount_usdc} USDC to ${r.quote?.pay_to}; the seller answered HTTP ${res.status} (${r.outcome}).`
|
|
120
148
|
: `No payment was needed; the server answered HTTP ${res.status}.`;
|
|
@@ -134,7 +162,12 @@ export async function registerPayTools(server, o) {
|
|
|
134
162
|
}
|
|
135
163
|
return text(`error: ${e instanceof Error ? e.message : String(e)}`, true);
|
|
136
164
|
}
|
|
137
|
-
}
|
|
165
|
+
};
|
|
166
|
+
const payAnnotations = { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: true };
|
|
167
|
+
server.registerTool("pay_x402", { title: PAY_TITLE, description: PAY_DESCRIPTION, annotations: { ...payAnnotations, title: PAY_TITLE }, inputSchema: payInput }, pay);
|
|
168
|
+
if (o.fetchAlias) {
|
|
169
|
+
server.registerTool(PAY_ALIAS, { title: PAY_ALIAS_TITLE, description: PAY_ALIAS_DESCRIPTION, annotations: { ...payAnnotations, title: PAY_ALIAS_TITLE }, inputSchema: payInput }, pay);
|
|
170
|
+
}
|
|
138
171
|
server.registerTool("wallet_status", {
|
|
139
172
|
title: "Show the paying wallet",
|
|
140
173
|
description: WALLET_STATUS_DESCRIPTION,
|
package/dist/rules.d.ts
CHANGED
|
@@ -40,6 +40,16 @@ export declare const REPORT_OUTCOMES: {
|
|
|
40
40
|
};
|
|
41
41
|
/** What the report sends, for the instructions and the skill. */
|
|
42
42
|
export declare const REPORT_SENDS = "the resource URL, the settlement transaction hash, the outcome and the quote if given";
|
|
43
|
+
/**
|
|
44
|
+
* Routing a paid URL to pay_x402 (stdio with a wallet). Kept out of RULES_SHA like the report constants: the skill moved
|
|
45
|
+
* to its `.3` revision when these were added (2026-11-01). The hosted server never carries them (test/hosted-snapshot).
|
|
46
|
+
*/
|
|
47
|
+
/** The words that mark a URL as one to fetch through the paying path, for the tool description, the instructions and the skill. */
|
|
48
|
+
export declare const PAID_URL_SIGNALS = "paid, metered, pay-per-call, x402, priced in USDC, or said to charge a fee per request";
|
|
49
|
+
/** Why a generic fetch is the wrong tool for such a URL, in one clause. */
|
|
50
|
+
export declare const PLAIN_FETCH_FAILS = "a plain fetch cannot pay and fails on these URLs with HTTP 402 Payment Required (or an opaque client error)";
|
|
51
|
+
/** The rule the stdio server adds to its instructions when pay_x402 is registered. */
|
|
52
|
+
export declare const PAY_ROUTING_RULE: string;
|
|
43
53
|
/** "a, b, and c" */
|
|
44
54
|
export declare function listAnd(xs: readonly string[]): string;
|
|
45
55
|
/** "a, b, or c" */
|
package/dist/rules.js
CHANGED
|
@@ -45,6 +45,19 @@ export const REPORT_OUTCOMES = {
|
|
|
45
45
|
};
|
|
46
46
|
/** What the report sends, for the instructions and the skill. */
|
|
47
47
|
export const REPORT_SENDS = "the resource URL, the settlement transaction hash, the outcome and the quote if given";
|
|
48
|
+
/**
|
|
49
|
+
* Routing a paid URL to pay_x402 (stdio with a wallet). Kept out of RULES_SHA like the report constants: the skill moved
|
|
50
|
+
* to its `.3` revision when these were added (2026-11-01). The hosted server never carries them (test/hosted-snapshot).
|
|
51
|
+
*/
|
|
52
|
+
/** The words that mark a URL as one to fetch through the paying path, for the tool description, the instructions and the skill. */
|
|
53
|
+
export const PAID_URL_SIGNALS = "paid, metered, pay-per-call, x402, priced in USDC, or said to charge a fee per request";
|
|
54
|
+
/** Why a generic fetch is the wrong tool for such a URL, in one clause. */
|
|
55
|
+
export const PLAIN_FETCH_FAILS = "a plain fetch cannot pay and fails on these URLs with HTTP 402 Payment Required (or an opaque client error)";
|
|
56
|
+
/** The rule the stdio server adds to its instructions when pay_x402 is registered. */
|
|
57
|
+
export const PAY_ROUTING_RULE = `When a URL is ${PAID_URL_SIGNALS}, or when any fetch of it answered HTTP 402 (or failed with a client error on a URL the user called paid), ` +
|
|
58
|
+
"fetch it with pay_x402 and not with a web fetch or any other fetch tool, even if one is available and even if the user did not ask to pay: " +
|
|
59
|
+
`${PLAIN_FETCH_FAILS}, while pay_x402 sends the request, pays the quote within the caps and returns the body. ` +
|
|
60
|
+
"Pass the same URL, method, headers and body. Never tell the user a paid URL cannot be fetched or paid while pay_x402 is available.";
|
|
48
61
|
/** "a, b, and c" */
|
|
49
62
|
export function listAnd(xs) {
|
|
50
63
|
return xs.length < 2 ? (xs[0] ?? "") : `${xs.slice(0, -1).join(", ")}, and ${xs.at(-1)}`;
|
package/dist/server.d.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
2
|
import { REPORT_OUTCOMES } from "./rules.js";
|
|
3
3
|
export * from "./rules.js";
|
|
4
|
-
export declare const VERSION = "0.4.
|
|
4
|
+
export declare const VERSION = "0.4.1";
|
|
5
5
|
/** Sent on every request to the index so usage can be counted by channel (never anything else). */
|
|
6
|
-
export declare const CLIENT_HEADER = "mcp/0.4.
|
|
6
|
+
export declare const CLIENT_HEADER = "mcp/0.4.1";
|
|
7
7
|
/** What the hosted service (index.ts) sends instead, so the index can count hosted and stdio use apart. */
|
|
8
|
-
export declare const HOSTED_CLIENT_HEADER = "mcp-hosted/0.4.
|
|
8
|
+
export declare const HOSTED_CLIENT_HEADER = "mcp-hosted/0.4.1";
|
|
9
9
|
/**
|
|
10
10
|
* Which client product a hosted session comes from, read from `clientInfo.name` on initialize and nothing else from the
|
|
11
11
|
* handshake: a product name, never a user. The hosted service appends it to its header (`mcp-hosted/<version>+claude`),
|
package/dist/server.js
CHANGED
|
@@ -10,7 +10,7 @@ import { ListPromptsRequestSchema, ListResourcesRequestSchema, ListResourceTempl
|
|
|
10
10
|
import { z } from "zod";
|
|
11
11
|
import { CHANGES_TRIGGER, CHECK_TRIGGERS, CHOOSE_TRIGGER, NEVER_PAY_TWICE, REPORT_DESCRIPTION, REPORT_OUTCOMES, REPORT_SENDS, SENDS_ONLY_URL, VERDICT_SENTENCE, cap, listAnd, listOr } from "./rules.js";
|
|
12
12
|
export * from "./rules.js";
|
|
13
|
-
export const VERSION = "0.4.
|
|
13
|
+
export const VERSION = "0.4.1";
|
|
14
14
|
/** Sent on every request to the index so usage can be counted by channel (never anything else). */
|
|
15
15
|
export const CLIENT_HEADER = `mcp/${VERSION}`;
|
|
16
16
|
/** What the hosted service (index.ts) sends instead, so the index can count hosted and stdio use apart. */
|
package/dist/stdio.js
CHANGED
|
@@ -3,28 +3,50 @@
|
|
|
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), so the team's rules apply to it.
|
|
6
7
|
*/
|
|
7
8
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
8
9
|
import { DEFAULT_BASE, createServer } from "./server.js";
|
|
9
|
-
import { FUND_SENTENCE, WalletConfigError, loadWallet, newWallet, readLimits } from "./wallet.js";
|
|
10
|
-
const [cmd, sub] = process.argv.slice(2);
|
|
10
|
+
import { FUND_SENTENCE, WalletConfigError, loadWallet, newWallet, readLimits, registerWallet } from "./wallet.js";
|
|
11
|
+
const [cmd, sub, ...rest] = process.argv.slice(2);
|
|
12
|
+
const baseUrl = (process.env.PAIDFOR_API_BASE ?? process.env.PAIDFOR_URL ?? DEFAULT_BASE).replace(/\/$/, "");
|
|
11
13
|
if (cmd === "wallet") {
|
|
12
|
-
|
|
13
|
-
process.stderr.write("usage: paidfor-mcp wallet new\n");
|
|
14
|
-
process.exit(2);
|
|
15
|
-
}
|
|
14
|
+
const usage = "usage: paidfor-mcp wallet new | PAIDFOR_TEAM_KEY=pft_... paidfor-mcp wallet register [--label \"research agent\"]\n";
|
|
16
15
|
try {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
16
|
+
if (sub === "new") {
|
|
17
|
+
const { address, file } = await newWallet();
|
|
18
|
+
process.stdout.write(`${address}\n${FUND_SENTENCE}\n`);
|
|
19
|
+
process.stderr.write(`key written to ${file} (mode 600); set PAIDFOR_WALLET_KEY_FILE=${file} in your MCP client config\n`);
|
|
20
|
+
process.exit(0);
|
|
21
|
+
}
|
|
22
|
+
if (sub === "register") {
|
|
23
|
+
// The team key comes from the environment, not an argument: it is a secret, and arguments show in process lists.
|
|
24
|
+
const teamKey = process.env.PAIDFOR_TEAM_KEY?.trim();
|
|
25
|
+
if (!teamKey) {
|
|
26
|
+
process.stderr.write(`paidfor-mcp: PAIDFOR_TEAM_KEY is not set. Make a key on ${baseUrl}/team and run: PAIDFOR_TEAM_KEY=pft_... paidfor-mcp wallet register\n`);
|
|
27
|
+
process.exit(2);
|
|
28
|
+
}
|
|
29
|
+
const at = rest.indexOf("--label");
|
|
30
|
+
if (at >= 0 && (rest[at + 1] === undefined || rest[at + 1].startsWith("--"))) {
|
|
31
|
+
process.stderr.write(usage);
|
|
32
|
+
process.exit(2);
|
|
33
|
+
}
|
|
34
|
+
const label = at >= 0 ? rest[at + 1] : "";
|
|
35
|
+
const r = await registerWallet({ baseUrl, teamKey, label });
|
|
36
|
+
process.stdout.write(`${r.address}\n`);
|
|
37
|
+
process.stdout.write(r.already ? "already registered to your team; nothing changed\n" : r.moved ? "registered to your team (it was moved from another team)\n" : "registered to your team\n");
|
|
38
|
+
if (r.paused)
|
|
39
|
+
process.stdout.write(`it starts paused: open ${baseUrl}/team, check its limits, untick Paused and save\n`);
|
|
40
|
+
process.exit(0);
|
|
41
|
+
}
|
|
42
|
+
process.stderr.write(usage);
|
|
43
|
+
process.exit(2);
|
|
21
44
|
}
|
|
22
45
|
catch (e) {
|
|
23
46
|
process.stderr.write(`paidfor-mcp: ${e instanceof Error ? e.message : String(e)}\n`);
|
|
24
47
|
process.exit(1);
|
|
25
48
|
}
|
|
26
49
|
}
|
|
27
|
-
const baseUrl = (process.env.PAIDFOR_API_BASE ?? process.env.PAIDFOR_URL ?? DEFAULT_BASE).replace(/\/$/, "");
|
|
28
50
|
let pay = null;
|
|
29
51
|
let limits = null;
|
|
30
52
|
try {
|
|
@@ -40,7 +62,8 @@ catch (e) {
|
|
|
40
62
|
if (pay && limits) {
|
|
41
63
|
const { INSTRUCTIONS_WITH_PAY, registerPayTools } = await import("./pay.js");
|
|
42
64
|
const server = createServer({ baseUrl, instructions: INSTRUCTIONS_WITH_PAY });
|
|
43
|
-
|
|
65
|
+
// PAIDFOR_FETCH_ALIAS=1 also registers the handler as fetch_paid_url (eval/routing.mjs measures whether the second name helps).
|
|
66
|
+
await registerPayTools(server, { wallet: pay, limits, baseUrl, fetchAlias: process.env.PAIDFOR_FETCH_ALIAS === "1" });
|
|
44
67
|
await server.connect(new StdioServerTransport());
|
|
45
68
|
}
|
|
46
69
|
else {
|
package/dist/wallet.d.ts
CHANGED
|
@@ -22,6 +22,31 @@ export declare function newWallet(home?: string): Promise<{
|
|
|
22
22
|
address: `0x${string}`;
|
|
23
23
|
file: string;
|
|
24
24
|
}>;
|
|
25
|
+
/** The wallet `wallet new` writes, used by `wallet register` when no key is configured in the environment. */
|
|
26
|
+
export declare const defaultKeyFile: (home?: string) => string;
|
|
27
|
+
/** paidfor refused or could not answer a registration. The message never includes a key. */
|
|
28
|
+
export declare class RegisterError extends Error {
|
|
29
|
+
name: string;
|
|
30
|
+
}
|
|
31
|
+
export type Registered = {
|
|
32
|
+
address: `0x${string}`;
|
|
33
|
+
already: boolean;
|
|
34
|
+
moved: boolean;
|
|
35
|
+
paused: boolean;
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* `paidfor-mcp wallet register`: proves to a paidfor team that this wallet is the agent's, by signing the challenge
|
|
39
|
+
* the team's key asks for. The wallet is the configured one, or ~/.paidfor/wallet.key when nothing is configured.
|
|
40
|
+
* The key signs one message and is sent nowhere; the team key authenticates the two calls.
|
|
41
|
+
*/
|
|
42
|
+
export declare function registerWallet(o: {
|
|
43
|
+
baseUrl: string;
|
|
44
|
+
teamKey: string;
|
|
45
|
+
label?: string;
|
|
46
|
+
env?: Env;
|
|
47
|
+
home?: string;
|
|
48
|
+
fetchFn?: typeof fetch;
|
|
49
|
+
}): Promise<Registered>;
|
|
25
50
|
export type Limits = {
|
|
26
51
|
maxPerCallUsd: number;
|
|
27
52
|
dailyCapUsd: number;
|
package/dist/wallet.js
CHANGED
|
@@ -72,6 +72,57 @@ export async function newWallet(home = homedir()) {
|
|
|
72
72
|
}
|
|
73
73
|
return { address: privateKeyToAccount(key).address, file };
|
|
74
74
|
}
|
|
75
|
+
/** The wallet `wallet new` writes, used by `wallet register` when no key is configured in the environment. */
|
|
76
|
+
export const defaultKeyFile = (home = homedir()) => join(paidforDir(home), "wallet.key");
|
|
77
|
+
/** paidfor refused or could not answer a registration. The message never includes a key. */
|
|
78
|
+
export class RegisterError extends Error {
|
|
79
|
+
name = "RegisterError";
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* `paidfor-mcp wallet register`: proves to a paidfor team that this wallet is the agent's, by signing the challenge
|
|
83
|
+
* the team's key asks for. The wallet is the configured one, or ~/.paidfor/wallet.key when nothing is configured.
|
|
84
|
+
* The key signs one message and is sent nowhere; the team key authenticates the two calls.
|
|
85
|
+
*/
|
|
86
|
+
export async function registerWallet(o) {
|
|
87
|
+
const env = { ...(o.env ?? process.env) };
|
|
88
|
+
const none = new WalletConfigError("no wallet to register: run `paidfor-mcp wallet new` first, or set PAIDFOR_WALLET_KEY_FILE");
|
|
89
|
+
if (!env.PAIDFOR_WALLET_KEY_FILE?.trim() && !env.PAIDFOR_WALLET_KEY?.trim()) {
|
|
90
|
+
const file = defaultKeyFile(o.home);
|
|
91
|
+
if (!(await stat(file).catch(() => null)))
|
|
92
|
+
throw none;
|
|
93
|
+
env.PAIDFOR_WALLET_KEY_FILE = file;
|
|
94
|
+
}
|
|
95
|
+
const loaded = await loadWallet(env);
|
|
96
|
+
if (!loaded)
|
|
97
|
+
throw none;
|
|
98
|
+
const f = o.fetchFn ?? fetch;
|
|
99
|
+
const base = o.baseUrl.replace(/\/$/, "");
|
|
100
|
+
// The team key travels in a header. Plain http is for a server on this machine only.
|
|
101
|
+
const u = new URL(base);
|
|
102
|
+
if (u.protocol !== "https:" && !["localhost", "127.0.0.1", "[::1]"].includes(u.hostname)) {
|
|
103
|
+
throw new RegisterError(`refusing to send a team key over ${u.protocol.replace(":", "")} to ${u.hostname}; use https`);
|
|
104
|
+
}
|
|
105
|
+
const post = async (path, body) => {
|
|
106
|
+
let res;
|
|
107
|
+
try {
|
|
108
|
+
res = await f(`${base}${path}`, { method: "POST", headers: { Authorization: `Bearer ${o.teamKey}`, "Content-Type": "application/json" }, body: JSON.stringify(body) });
|
|
109
|
+
}
|
|
110
|
+
catch (e) {
|
|
111
|
+
throw new RegisterError(`could not reach ${base}: ${e instanceof Error ? e.message : String(e)}`);
|
|
112
|
+
}
|
|
113
|
+
const j = (await res.json().catch(() => ({})));
|
|
114
|
+
if (!res.ok)
|
|
115
|
+
throw new RegisterError(`paidfor answered ${res.status}${typeof j.error === "string" ? `: ${j.error}` : ""}`);
|
|
116
|
+
return j;
|
|
117
|
+
};
|
|
118
|
+
const c = await post("/v1/team/wallets/challenge", { address: loaded.account.address });
|
|
119
|
+
if (typeof c.message !== "string" || typeof c.token !== "string")
|
|
120
|
+
throw new RegisterError("paidfor did not return a challenge to sign");
|
|
121
|
+
const signature = await loaded.account.signMessage({ message: c.message });
|
|
122
|
+
const r = await post("/v1/team/wallets", { message: c.message, token: c.token, signature, label: o.label ?? "" });
|
|
123
|
+
const w = (r.wallet ?? {});
|
|
124
|
+
return { address: (w.address ?? loaded.account.address), already: r.already === true, moved: r.moved === true, paused: w.rules?.paused === true };
|
|
125
|
+
}
|
|
75
126
|
function positive(env, name, dflt) {
|
|
76
127
|
const raw = env[name]?.trim();
|
|
77
128
|
if (!raw)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@paidfor/mcp",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.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",
|
|
@@ -51,6 +51,8 @@
|
|
|
51
51
|
"start": "node dist/index.js",
|
|
52
52
|
"dev": "tsc -p tsconfig.json && node dist/index.js",
|
|
53
53
|
"eval": "node --env-file-if-exists=eval/.env eval/run.mjs",
|
|
54
|
+
"eval:routing": "node --env-file-if-exists=eval/.env eval/routing.mjs",
|
|
55
|
+
"test": "pnpm build && node --test \"test/*.test.mjs\"",
|
|
54
56
|
"mcpb": "node mcpb/build.mjs"
|
|
55
57
|
}
|
|
56
58
|
}
|
package/dist/http.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
package/dist/http.js
DELETED
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Standalone Streamable HTTP service (Railway / Fly / any Node host). Stateless: one
|
|
3
|
-
* transport per request. GET /health for the platform health check.
|
|
4
|
-
*/
|
|
5
|
-
import { createServer as createHttpServer } from "node:http";
|
|
6
|
-
import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
|
|
7
|
-
import { createServer, TOOL_NAMES, VERSION } from "./server.js";
|
|
8
|
-
const port = Number(process.env.PORT ?? 3402);
|
|
9
|
-
const counts = new Map();
|
|
10
|
-
const bump = (k) => counts.set(k, (counts.get(k) ?? 0) + 1);
|
|
11
|
-
const CORS = { "Access-Control-Allow-Origin": "*", "Access-Control-Allow-Methods": "GET, POST, DELETE, OPTIONS", "Access-Control-Allow-Headers": "*" };
|
|
12
|
-
createHttpServer(async (req, res) => {
|
|
13
|
-
const path = (req.url ?? "/").split("?")[0];
|
|
14
|
-
if (req.method === "OPTIONS") {
|
|
15
|
-
res.writeHead(204, CORS);
|
|
16
|
-
res.end();
|
|
17
|
-
return;
|
|
18
|
-
}
|
|
19
|
-
if (path === "/health") {
|
|
20
|
-
res.writeHead(200, { "Content-Type": "text/plain", ...CORS });
|
|
21
|
-
res.end("ok");
|
|
22
|
-
return;
|
|
23
|
-
}
|
|
24
|
-
if (path === "/usage") {
|
|
25
|
-
res.writeHead(200, { "Content-Type": "application/json", ...CORS });
|
|
26
|
-
res.end(JSON.stringify(Object.fromEntries(counts)));
|
|
27
|
-
return;
|
|
28
|
-
}
|
|
29
|
-
if (path === "/" || path === "/mcp") {
|
|
30
|
-
if (req.method === "GET" && !(req.headers.accept ?? "").includes("text/event-stream")) {
|
|
31
|
-
res.writeHead(200, { "Content-Type": "application/json", ...CORS });
|
|
32
|
-
res.end(JSON.stringify({ name: "paidfor", version: VERSION, transport: "streamable-http", tools: TOOL_NAMES, usage: "POST JSON-RPC 2.0 to this URL" }));
|
|
33
|
-
return;
|
|
34
|
-
}
|
|
35
|
-
bump("request");
|
|
36
|
-
for (const [k, v] of Object.entries(CORS))
|
|
37
|
-
res.setHeader(k, v);
|
|
38
|
-
const server = createServer({ onToolCall: bump });
|
|
39
|
-
const transport = new StreamableHTTPServerTransport({ sessionIdGenerator: undefined });
|
|
40
|
-
res.on("close", () => { void transport.close(); void server.close(); });
|
|
41
|
-
await server.connect(transport);
|
|
42
|
-
await transport.handleRequest(req, res);
|
|
43
|
-
return;
|
|
44
|
-
}
|
|
45
|
-
res.writeHead(404, CORS);
|
|
46
|
-
res.end();
|
|
47
|
-
}).listen(port, () => {
|
|
48
|
-
console.log(`paidfor MCP (streamable http) listening on :${port}, reading ${process.env.PAIDFOR_URL ?? "https://paidfor.dev"}`);
|
|
49
|
-
});
|