zk-agent-cli 1.0.1 → 1.1.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 +58 -10
- package/dist/index.js +16077 -10449
- package/dist/mcp.js +12512 -0
- package/dist/sdk.js +12526 -0
- package/package.json +11 -2
package/README.md
CHANGED
|
@@ -16,8 +16,8 @@ For npm users evaluating it quickly, the product claim is simple:
|
|
|
16
16
|
- pay first on one local-first zkSync-native path
|
|
17
17
|
- keep Agent Pay follow-up on the same runtime instead of splitting it into
|
|
18
18
|
another product
|
|
19
|
-
- use `payment publish -> payment serve` as the current
|
|
20
|
-
proof, not as a claim of multi-tenant hosting
|
|
19
|
+
- use `payment publish -> payment serve -> verify-preview` as the current
|
|
20
|
+
public hosted-preview proof, not as a claim of multi-tenant hosting
|
|
21
21
|
|
|
22
22
|
## Install in 30 Seconds
|
|
23
23
|
|
|
@@ -26,13 +26,44 @@ Use the install path that matches your environment:
|
|
|
26
26
|
```bash
|
|
27
27
|
npx skills add https://github.com/AgiWeb3/zk-agent-cli
|
|
28
28
|
npx zk-agent-cli --help
|
|
29
|
+
npx zk-agent-cli mcp
|
|
29
30
|
npm install -g zk-agent-cli
|
|
30
31
|
```
|
|
31
32
|
|
|
32
33
|
- `skills add`: install into an agent harness
|
|
33
34
|
- `npx zk-agent-cli`: one-shot evaluation without a global install
|
|
35
|
+
- `npx zk-agent-cli mcp`: start the AI-facing MCP stdio server instead of the human CLI
|
|
34
36
|
- `npm install -g zk-agent-cli`: keep `zk-agent` on your shell path
|
|
35
37
|
|
|
38
|
+
## AI-native entrypoint
|
|
39
|
+
|
|
40
|
+
When the consumer already speaks MCP and wants tools rather than CLI text,
|
|
41
|
+
start:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx zk-agent-cli mcp
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Current boundary:
|
|
48
|
+
|
|
49
|
+
- the MCP server is built on top of `packages/agent-tools`
|
|
50
|
+
- it exposes the same standard tool catalog plus `zkAgentRecommendedSequence`
|
|
51
|
+
- keep shell automation on `zk-agent --json ...` or
|
|
52
|
+
`zk-agent --format json ...`; use `mcp` when the client already speaks MCP
|
|
53
|
+
- `1.1.0` completes the packaged MCP baseline; it does not yet claim
|
|
54
|
+
framework-specific adapters or a fully expanded MCP ecosystem layer
|
|
55
|
+
|
|
56
|
+
Minimal import surface:
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import {
|
|
60
|
+
createZkAgentToolContext,
|
|
61
|
+
listZkAgentTools,
|
|
62
|
+
runZkAgentTool
|
|
63
|
+
} from 'zk-agent-cli';
|
|
64
|
+
import { createZkAgentMcpServer } from 'zk-agent-cli/mcp';
|
|
65
|
+
```
|
|
66
|
+
|
|
36
67
|
## First Minute After Install
|
|
37
68
|
|
|
38
69
|
If you only want the shortest public proof, do this and stop at the first
|
|
@@ -60,7 +91,8 @@ That is the current packaged story in one minute:
|
|
|
60
91
|
- stay on one runtime: keep Agent Pay follow-up, workspace, handoff, and feed
|
|
61
92
|
on the same wallet runtime
|
|
62
93
|
- current public hosted-preview proof:
|
|
63
|
-
`zk-agent payment publish` + `zk-agent payment serve`
|
|
94
|
+
`zk-agent payment publish` + `zk-agent payment serve` +
|
|
95
|
+
`zk-agent payment verify-preview`
|
|
64
96
|
already mark the hosted-preview boundary without claiming a multi-tenant
|
|
65
97
|
control plane
|
|
66
98
|
|
|
@@ -73,7 +105,7 @@ That is the current packaged story in one minute:
|
|
|
73
105
|
- one Agent Pay layer that stays attached to the same wallet runtime instead
|
|
74
106
|
of splitting into a separate product
|
|
75
107
|
- one public hosted-preview proof on top of that same request/export layer:
|
|
76
|
-
`payment publish -> payment serve`
|
|
108
|
+
`payment publish -> payment serve -> verify-preview`
|
|
77
109
|
|
|
78
110
|
## Best Fit
|
|
79
111
|
|
|
@@ -163,6 +195,9 @@ cross-request export. The scoped form remains `zk-agent payment feed`.
|
|
|
163
195
|
`workspace` / `feed` / `handoff` Agent Pay bundle as a hostable static export.
|
|
164
196
|
`zk-agent payment serve` hosts that same bundle from one operator-controlled
|
|
165
197
|
static endpoint.
|
|
198
|
+
`zk-agent payment verify-preview` validates that one hosted preview URL still
|
|
199
|
+
matches the current `health` / `index` / `manifest` / `workspace` / `feed` /
|
|
200
|
+
`handoff` export contract.
|
|
166
201
|
|
|
167
202
|
If you are new, stop at the first successful `zk-agent pay`. Ignore
|
|
168
203
|
`suite`, `payment`, and `relay` until that baseline path works once, unless
|
|
@@ -188,11 +223,13 @@ The packaged default story is payment-first: send native value now, stay on
|
|
|
188
223
|
the approval-based pay path when fee-token/default state matters, and recover
|
|
189
224
|
funding only when the workflow says the write path is blocked.
|
|
190
225
|
|
|
191
|
-
The
|
|
226
|
+
The four public proof paths today are:
|
|
192
227
|
|
|
193
228
|
- flagship pay: prove the default ready-wallet zkSync-native send path
|
|
194
229
|
- Agent Pay: prove local request capture plus follow-up surfaces around the
|
|
195
230
|
same wallet runtime
|
|
231
|
+
- hosted Agent Pay preview: prove that the current workspace/feed/handoff
|
|
232
|
+
bundle can already be published and served behind one operator-controlled URL, then validated against that same public export contract
|
|
196
233
|
- hosted approval recovery: prove remote-browser session recovery on the
|
|
197
234
|
current single-host relay baseline
|
|
198
235
|
|
|
@@ -279,10 +316,19 @@ That same `workspace -> handoff -> feed` chain is also the current public
|
|
|
279
316
|
Agent Pay proof on the hosted-preview boundary: an external dashboard, agent,
|
|
280
317
|
or backend can consume the stable exports today from the same runtime or one
|
|
281
318
|
operator-controlled host. `zk-agent payment publish` is the static half of
|
|
282
|
-
that proof,
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
319
|
+
that proof, `zk-agent payment serve` is the hosted half, and
|
|
320
|
+
`zk-agent payment verify-preview` is the operator validation follow-up against
|
|
321
|
+
the public URL. That preview is already proven on one stable public URL; the
|
|
322
|
+
next step is to grow from that proof toward clearer hosted platform semantics
|
|
323
|
+
without claiming a multi-tenant control plane too early.
|
|
324
|
+
|
|
325
|
+
The fastest hosted Agent Pay preview proof path is:
|
|
326
|
+
|
|
327
|
+
```bash
|
|
328
|
+
zk-agent payment publish --public-base-url <https-url>
|
|
329
|
+
zk-agent payment serve --public-origin <https-url>
|
|
330
|
+
zk-agent payment verify-preview --url <https-url>
|
|
331
|
+
```
|
|
286
332
|
|
|
287
333
|
For the shortest product demo narrative behind that path, use
|
|
288
334
|
[`docs/20-agent-pay-demo-narrative.md`](../../docs/20-agent-pay-demo-narrative.md).
|
|
@@ -567,7 +613,8 @@ Current `suite` catalog categories:
|
|
|
567
613
|
Current `suite` handoff surfaces:
|
|
568
614
|
|
|
569
615
|
- `workflow`: flagship pay, approval-based pay, and funding recovery
|
|
570
|
-
- `payment`: request capture, follow-up, sharing, export,
|
|
616
|
+
- `payment`: request capture, follow-up, sharing, export, approval repair,
|
|
617
|
+
and hosted preview
|
|
571
618
|
- `discovery`: assets/defaults/token inspection
|
|
572
619
|
- `relay`: hosted approval recovery
|
|
573
620
|
|
|
@@ -575,6 +622,7 @@ Current `suite` product journeys:
|
|
|
575
622
|
|
|
576
623
|
- `send value now`
|
|
577
624
|
- `capture and track payments`
|
|
625
|
+
- `host current Agent Pay preview`
|
|
578
626
|
- `inspect before acting`
|
|
579
627
|
- `unstick a write`
|
|
580
628
|
- `recover remote approval`
|