@cmdoss/suipay-mcp 0.2.2-dev.3 → 0.2.2-dev.31

package/README.md

@@ -5,15 +5,21 @@ buyer-funded spend account. The buyer owns the account. The agent holds the
 delegate key and can spend only under the on-chain grant (recipient bind,
 per-payment cap, budget).
 
-Pin `@cmdoss/suipay-mcp@0.2.2` in MCP config. `1.0.1` remains on the
-registry as a historical release; do not install it for new agents.
+Pin `@cmdoss/suipay-mcp@0.2.2-dev.31` in MCP config for the `latest` dist-tag.
+`npx -y @cmdoss/suipay-mcp@dev` tracks the `dev` prerelease line.
+`1.0.1` remains on the registry as a historical release; do not install it
+for new agents.
 
 ## Install
 
 ```bash
-claude mcp add --scope user suipay -- npx -y @cmdoss/suipay-mcp@0.2.2
+claude mcp add --scope user suipay -- npx -y @cmdoss/suipay-mcp@0.2.2-dev.31
 ```
 
+`@dev` installs the Railway-dev gateway/console defaults. A workspace
+checkout still defaults to localhost. `SUIPAY_GATEWAY_URL` and
+`SUIPAY_CONSOLE_URL` always override.
+
 No wallet secret belongs in this command or MCP config. There is no
 Sign-In With Sui (SIWS) step. To reuse an existing delegate seed locally,
 set `SUIPAY_MCP_KEY` (64-hex or `suiprivkey1…`) in the MCP env — never in
@@ -51,7 +57,7 @@ missing, expired, or revoked.
 | Tool | Purpose |
 | --- | --- |
 | `discover` | Search live gateway resources. After login: `name`, `path`, `url`, `targetHash`, catalog price, and `affordable` (can this session cover one call — not authorization). `pay({ url })` still settles |
-| `pay` | Fetch resource, prepare `spend_account` settlement, settle when this process holds the grant key |
+| `pay` | Fetch resource, prepare `spend_account` settlement, settle when this process holds the grant key. POST `json` is the paid body. Optional stdio `file` + `fileField` fill one JSON key from a local file as canonical base64 (Walrus `contentBase64`); requires `SUIPAY_MCP_FILE_ROOT`; hosted `/mcp` refuses `file` |
 | `receipts` | List settlement receipts, optionally by challenge ID |
 | `access_context` | Report current session / delegate / policy state (no secret material) |
 | `suipay_login` | Mint or reuse the local delegate key and return a clickable console URL (does not wait for the wallet). Default target is Railway suipay-dev; pass `target: "local"` for the laptop stack |
@@ -76,13 +82,66 @@ json: {"prompt":"a cat"}
 maxAmount: 50000
 ```
 
-`pay` uses SDK `createPayer` internally. A binary body is written once under
-`~/.suipay/deliveries/` and named first in the JSON as `savedTo` (absolute
-path) and `savedToUrl` (`file://`). Any MIME — image, audio, pdf,
-octet-stream. JSON stays compact (no base64 wall). An MCP `image` block is an
-extra display hint when the type is `image/*`; hosts such as Claude Code's
-TUI may not render it. Always quote `savedTo` to the user. Do not call `pay`
-again to "save" a delivery that already settled.
+To store local bytes (Walrus), do not paste base64. Name the file and field.
+Set `SUIPAY_MCP_FILE_ROOT` to an absolute directory; `file` must resolve inside
+it (unset disables attach). Paths under `~/.suipay` are refused even if that
+directory falls inside the root.
+
+```
+Pay this SuiPay resource with the suipay MCP `pay` tool. Do not write SDK code.
+
+url: https://gateway.example/v1/walrus/store
+method: POST
+json: {"contentType":"text/plain"}
+file: /absolute/path/to/note.txt
+fileField: contentBase64
+maxAmount: 50000
+```
+
+`pay` uses SDK `createPayer` internally. When this process settles, a binary
+body is written once under `~/.suipay/deliveries/` and named first in the
+JSON as `savedTo` (absolute path) and `savedToUrl` (`file://`). Hosted `/mcp`
+is prepare-only and does not write a buyer file. Any MIME — image, audio,
+pdf, octet-stream. JSON stays compact (no base64 wall). An MCP `image` block
+is an extra display hint when the type is `image/*`; hosts such as Claude
+Code's TUI may not render it. Always quote `savedTo` when present. If
+`savedTo` is null, quote `saveError` and do not call `pay` again.
+
+## Tool errors — branch on `code`
+
+A tool result whose `status` is `failed` or `ambiguous` sets `isError: true`
+and puts the error model in `structuredContent`:
+
+| Field | Meaning |
+| --- | --- |
+| `status`, `paid` | As before. `paid` is `true`, `false` or `'unknown'`. |
+| `code` | Registered error code, e.g. `request.file_outside_root`. **Branch on this**, never on the text. |
+| `paymentState` | `charged`, `unknown` or `not_charged`; always agrees with `paid`. |
+| `retryable` | `true` only when a retry cannot charge twice. |
+| `nextAction` | `retry`, `retry_later`, `fix_request`, `sign_in`, `approve_access`, `add_funds`, `reconcile`, `contact_support` or `none`. |
+| `supportCode` | Always present. The gateway's when it produced the failure; otherwise minted by this MCP server and written, with the failure, to its stderr log. Find the cause in the MCP host's log by searching for it. |
+| `detail` | Developer text that states the fix. |
+| `txDigest`, `paymentId` | When known. |
+
+The text block holds the same object as JSON. When money moved or may have
+moved it **starts** with a line for the model:
+
+```
+You were charged. Do not pay again for this request.
+{ "status": "ambiguous", "paid": true, "code": "delivery.seller_unreachable", "paymentState": "charged", ... }
+```
+
+(`This payment may have gone through. Do not pay again until it is resolved.`
+when `paymentState` is `unknown`.) A result whose `status` is `ok` or
+`prepared` is never an error, including a free response that needed no
+payment.
+
+Common local codes: `auth.login_required` (run `suipay_login`),
+`request.file_outside_root` / `request.file_root_unset` (set
+`SUIPAY_MCP_FILE_ROOT`), `client.local_credentials_invalid` (log in again),
+`client.gateway_unreachable` (retry later). An unknown tool name is a JSON-RPC
+error, not a tool result; an invalid argument such as a relative `url` is a
+tool error with a `request.*` code and `nextAction: "fix_request"`.
 
 ## Targets
 
@@ -95,10 +154,10 @@ Default is Railway **suipay-dev**. `--local` / `target: "local"` is laptop-only.
 
 ```bash
 # Railway suipay-dev (default)
-npx @cmdoss/suipay-mcp@0.2.2
+npx @cmdoss/suipay-mcp@0.2.2-dev.31
 
 # Laptop stack
-npx @cmdoss/suipay-mcp@0.2.2 --local
+npx @cmdoss/suipay-mcp@0.2.2-dev.31 --local
 ```
 
 `SUIPAY_MCP_TARGET=local|dev` selects the same preset. Explicit
@@ -158,4 +217,8 @@ node packages/mcp/dist/bin/suipay.js
 Binary writes status banner to stderr only. Stdout stays reserved for
 MCP protocol.
 
-Do not publish `@cmdoss/suipay-mcp` from this change.
+Publishing is the `release-npm` workflow: merge to `dev` publishes
+`@cmdoss/suipay-mcp@<version>-dev.N` with dist-tag `dev` (OIDC, pack gate,
+provenance). `latest` is a gated dispatch from `main` (`dry_run` default
+true). Do not `npm publish` from a laptop. See
+[`docs/guide/npm-release.md`](../../docs/guide/npm-release.md).

package/dist/bin/suipay.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 import {
   main
-} from "../chunk-C2IYSV43.js";
-import "../chunk-SRMAH6MK.js";
+} from "../chunk-IH6HQD2V.js";
+import "../chunk-YMOMYFKL.js";
 
 // src/bin/suipay.ts
 main().catch((err) => {

package/dist/{chunk-C2IYSV43.js → chunk-IH6HQD2V.js}

@@ -4,7 +4,7 @@ import {
   loadLocalSigningKeyRecord,
   loadMcpConfig,
   loadPaymentProfile
-} from "./chunk-SRMAH6MK.js";
+} from "./chunk-YMOMYFKL.js";
 
 // src/index.ts
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
@@ -19,7 +19,7 @@ async function main() {
   const argv = process.argv.slice(2);
   const cfg = loadMcpConfig(process.env, argv);
   const target = cfg.target ?? "dev";
-  const server = createServer(cfg);
+  const server = createServer(cfg, void 0, void 0, { transport: "stdio" });
   await server.connect(new StdioServerTransport());
   try {
     const boundGateway = loadLocalSigningKeyRecord()?.gatewayUrl ?? cfg.gatewayUrl;