wave3d-agent-sdk 0.2.4 → 0.2.6

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 CHANGED
@@ -14,24 +14,26 @@ Vocabulary:
14
14
  - WaveEngine Agent SDK: same-machine live MCP transport from `wave3d-agent-sdk start`.
15
15
  - HTTP Gateway: Wave Studio Next/Vercel MCP transport for remote/cloud/sandbox fallback Studio operations.
16
16
  - WaveEngine SDK Cache: package-bundled public-safe skill/API/example lookup data.
17
- - MCP Session: paired Wave Studio browser session and bearer-token state.
17
+ - MCP Session: paired Wave Studio browser session and MCP_TOKEN state.
18
+ - Local Pairing Secret: MCP_TOKEN on localhost. It pairs the local SDK process to the current Studio session; it is not account/cloud auth.
19
+ - HTTP Gateway Bearer: MCP_TOKEN on an HTTP Gateway URL. It can be adopted locally, but localhost health remains the source of truth for SDK state.
18
20
  - VFS Mirror: HTTP Gateway read/edit snapshot. Local SDK live reads/writes use browser VFS.
19
21
  - Project: user workspace content. Reading a project is not opening/replacing live workspace.
20
22
 
21
23
  ```bash
22
- npx -y wave3d-agent-sdk@0.2.4 start
24
+ npx -y wave3d-agent-sdk@0.2.6 start
23
25
  ```
24
26
 
25
- After Copy to Agent, restart stale SDK processes with the copied bearer preserved. Keep the token hidden:
27
+ After Copy to Agent, restart stale SDK processes with MCP_TOKEN preserved as the local pairing secret. Keep it hidden:
26
28
 
27
29
  ```bash
28
- WAVE3D_MCP_TOKEN="$MCP_TOKEN" npx -y wave3d-agent-sdk@0.2.4 start
30
+ WAVE3D_MCP_TOKEN="$MCP_TOKEN" npx -y wave3d-agent-sdk@0.2.6 start
29
31
  ```
30
32
 
31
33
  Check SDK build before trusting a running SDK process:
32
34
 
33
35
  ```bash
34
- npx -y wave3d-agent-sdk@0.2.4 --version
36
+ npx -y wave3d-agent-sdk@0.2.6 --version
35
37
  ```
36
38
 
37
39
  The package bundles the WaveEngine SDK lookup corpus. No normal session needs a separate protected zip download.
@@ -41,12 +43,12 @@ The package bundles the WaveEngine SDK lookup corpus. No normal session needs a
41
43
  Wave Studio Copy to Agent defaults same-machine live MCP transport to this SDK:
42
44
 
43
45
  ```bash
44
- npx -y wave3d-agent-sdk@0.2.4 start
46
+ npx -y wave3d-agent-sdk@0.2.6 start
45
47
  ```
46
48
 
47
49
  Agents choose topology first:
48
50
 
49
- - Same computer as Wave Studio browser: try copied localhost `MCP_URL`, call `self_check_wave_mcp` with copied `expectedVersion` and `expectedBuildHash`, and restart exact SDK command from Copy to Agent if `self_check_wave_mcp` is missing, SDK is stale, tools are missing, or the SDK prints bearer tokens before fallback. If restart happens after Copy to Agent, preserve the copied bearer with `WAVE3D_MCP_TOKEN="$MCP_TOKEN"` so the new SDK process can authorize that local bearer.
51
+ - Same computer as Wave Studio browser: try copied localhost `MCP_URL`, call `self_check_wave_mcp` with copied `expectedVersion` and `expectedBuildHash`, and restart exact SDK command from Copy to Agent if `self_check_wave_mcp` is missing, SDK is stale, tools are missing, or the SDK prints secrets before fallback. If restart happens after Copy to Agent, preserve MCP_TOKEN with `WAVE3D_MCP_TOKEN="$MCP_TOKEN"` so the new SDK process can authorize that local pairing secret. HTTP Gateway is degraded fallback only after SDK cannot run, update, or adopt; successful Gateway auth or convenience is not a same-machine fallback reason.
50
52
  - Different machine, remote container, cloud agent, sandbox without shell/Node/npm, or localhost points to agent machine instead of user browser machine: use `MCP_HTTP_GATEWAY_FALLBACK_URL` directly. Do not start WaveEngine Agent SDK on wrong machine.
51
53
 
52
54
  Call `get_wave_mcp_health` (aliases: `mcp_health`, `mcp_status`) whenever transport, SDK, or session status is unclear. It reports endpoint kind, SDK version/build, tool catalog hash/count, paired sessions, and WaveEngine SDK Cache state.
@@ -56,13 +58,13 @@ Use `MCP_HTTP_GATEWAY_FALLBACK_URL` only for topology mismatch, remote/sandboxed
56
58
  For unfamiliar authoring, use the local SDK tools:
57
59
 
58
60
  ```bash
59
- npx -y wave3d-agent-sdk@0.2.4 cache search "continuous left rotation"
61
+ npx -y wave3d-agent-sdk@0.2.6 cache search "continuous left rotation"
60
62
  ```
61
63
 
62
64
  `cache refresh` without MCP arguments reinstalls the bundled SDK into `~/.wave3d/agent-cache`:
63
65
 
64
66
  ```bash
65
- npx -y wave3d-agent-sdk@0.2.4 cache refresh
67
+ npx -y wave3d-agent-sdk@0.2.6 cache refresh
66
68
  ```
67
69
 
68
70
  Old `cache refresh --mcp-url <url> --token <token>` arguments are ignored. Normal users update the npm package; no separate zip download exists.
@@ -98,4 +100,4 @@ wave3d-agent-sdk cache clear
98
100
 
99
101
  ## Token Safety
100
102
 
101
- Treat Wave Studio MCP bearer tokens as secrets. Prefer passing them through `WAVE3D_MCP_TOKEN` or `WAVESTUDIO_MCP_TOKEN` rather than shell history when possible.
103
+ Treat Wave Studio MCP_TOKEN values as secrets. Prefer passing them through `WAVE3D_MCP_TOKEN` or `WAVESTUDIO_MCP_TOKEN` rather than shell history when possible.