waterbox 0.1.0-alpha.1

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Waterbox contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,90 @@
1
+ # waterbox
2
+
3
+ `waterbox` is the supported local stdio MCP for isolated, stateful coding
4
+ sandboxes. It requires Node.js 24.15.0 or newer, opens no listener, and supports
5
+ explicitly configured Box and Vercel Sandbox accounts. There is no hosted
6
+ Waterbox mode and no JavaScript library API.
7
+
8
+ ## Install And Configure
9
+
10
+ ```sh
11
+ npx add-mcp waterbox@next
12
+ ```
13
+
14
+ This prerelease is distributed under the npm `next` tag. The command installs
15
+ MCP client configuration equivalent to `{ "command": "npx", "args": ["-y",
16
+ "waterbox@next"] }`. It does not collect provider credentials. Running `npx
17
+ waterbox@next` directly starts the stdio server; use an explicit argument for
18
+ terminal-only onboarding:
19
+
20
+ ```sh
21
+ npx waterbox@next setup
22
+ npx waterbox@next status
23
+ npx waterbox@next logout
24
+ ```
25
+
26
+ Interactive setup stores only the provider credential in the native keyring.
27
+ Non-secret settings are written atomically to `~/.waterbox/config.json` using
28
+ the exact official endpoints `https://ascii.dev/api/box/v1` and
29
+ `https://api.vercel.com/`. Status never prints credentials. Logout removes
30
+ local settings and both keyring entries but does not alter remote resources or
31
+ the SQLite resource registry.
32
+
33
+ For headless systems without a usable keyring, place a complete provider
34
+ configuration in the MCP client's environment/secret facility. Do not put
35
+ secrets in command arguments:
36
+
37
+ ```text
38
+ Box: WATERBOX_PROVIDER=box, BOX_API_KEY=<client-managed secret>
39
+ Vercel: WATERBOX_PROVIDER=vercel, VERCEL_TOKEN=<client-managed secret>,
40
+ VERCEL_TEAM_ID=<team identifier>, VERCEL_PROJECT_ID=<project identifier>
41
+ ```
42
+
43
+ Custom Box/Vercel endpoints are supported only when the complete provider
44
+ selection and credentials come from process environment. Environment and
45
+ persisted sources are never mixed. `.env` is never loaded implicitly.
46
+
47
+ An unconfigured server remains connected and returns setup guidance from all
48
+ tools before filesystem, SQLite, artifact, or provider I/O.
49
+
50
+ ## Configuration
51
+
52
+ | Variable | Required | Default |
53
+ | --- | --- | --- |
54
+ | `WATERBOX_PROVIDER` | Environment setup: `box` or `vercel` | none |
55
+ | `BOX_API_KEY` | Box environment setup | none |
56
+ | `BOX_API_BASE_URL` | Environment-only override | `https://ascii.dev/api/box/v1` |
57
+ | `BOX_POLL_INTERVAL_MS` | No | `1000` |
58
+ | `BOX_POLL_TIMEOUT_MS` | No | `120000` |
59
+ | `VERCEL_TOKEN` | Vercel environment setup | none |
60
+ | `VERCEL_TEAM_ID` | Vercel environment setup | none |
61
+ | `VERCEL_PROJECT_ID` | Vercel environment setup | none |
62
+ | `VERCEL_API_ORIGIN` | Environment-only HTTPS-origin override | `https://api.vercel.com/` |
63
+ | `VERCEL_POLL_INTERVAL_MS` | No | `1000` |
64
+ | `VERCEL_POLL_TIMEOUT_MS` | No | `120000` |
65
+ | `VERCEL_REQUEST_TIMEOUT_MS` | No | `30000` |
66
+ | `WATERBOX_AUTO_STOP` | No; whole minutes/hours such as `30m` or `2h` | provider default |
67
+ | `WATERBOX_SQLITE_PATH` | No | `~/.waterbox/direct.sqlite` |
68
+
69
+ ## Lifecycle And Tools
70
+
71
+ Waterbox exposes `create_sandbox`, `probe_sandbox`, `stop_sandbox`,
72
+ `delete_sandbox`, `list_snapshots`, `create_snapshot`, `delete_snapshot`,
73
+ `send_file_securely`, `read`, `write`, `edit`, `patch`, `glob`, `grep`, and
74
+ `bash`. Resource IDs are explicit; there is no selected sandbox or
75
+ `list_sandboxes` tool.
76
+
77
+ Waterbox owns only records in its local SQLite database and does not infer
78
+ ownership from provider inventory. Sandboxes persist after the MCP exits.
79
+ Changing provider scope does not migrate or clean old resources, which may
80
+ continue to incur charges. Fresh and snapshot-sourced sandboxes receive the
81
+ current packaged Node CLI without a shared system snapshot, Bun, or daemon.
82
+
83
+ Secure transfer keeps file contents out of MCP arguments and model context in
84
+ transit, but the destination is plaintext and provider/sandbox-readable.
85
+ Ordinary operations are not retried after ambiguous execution. Provider quotas,
86
+ automatic stopping, snapshot retention, and optional capabilities remain
87
+ provider-defined.
88
+
89
+ Official MCP registry and catalog discovery are deferred; no `server.json` is
90
+ included in the npm package.
@@ -0,0 +1,113 @@
1
+ # Third-Party Notices
2
+
3
+ Waterbox bundles the following third-party packages in `dist/waterbox.js` or
4
+ `dist/waterbox-cli.js`. Versions are the exact versions in the reviewed build
5
+ closure. The build fails if that closure changes without updating this file.
6
+
7
+ ## MIT-Licensed Packages
8
+
9
+ - `@asteasolutions/zod-to-openapi@9.1.0`, copyright (c) 2022 Astea Solutions.
10
+ - `@hono/zod-openapi@1.6.1`, `@hono/zod-validator@0.9.0`, and `hono@4.13.3`, copyright (c) 2021-present Yusuke Wada and Hono contributors.
11
+ - `@modelcontextprotocol/sdk@1.25.3`, copyright (c) 2024 Anthropic, PBC.
12
+ - `@noble/ciphers@2.4.0`, copyright (c) 2022 Paul Miller and copyright (c) 2016 Thomas Pornin.
13
+ - `@noble/curves@2.0.1` and `@noble/curves@2.4.0`, copyright (c) 2022 Paul Miller.
14
+ - `@noble/hashes@2.0.1` and `@noble/hashes@2.4.0`, copyright (c) 2022 Paul Miller.
15
+ - `@noble/post-quantum@0.5.4`, copyright (c) 2024 Paul Miller.
16
+ - `@scure/base@2.4.0`, copyright (c) 2022 Paul Miller.
17
+ - `ajv@8.20.0`, copyright (c) 2015-2021 Evgeny Poberezkin.
18
+ - `ajv-formats@3.0.1`, copyright (c) 2020 Evgeny Poberezkin.
19
+ - `fast-deep-equal@3.1.3` and `json-schema-traverse@1.0.0`, copyright (c) 2017 Evgeny Poberezkin.
20
+ - `zod@4.1.8`, copyright (c) 2025 Colin McDonnell.
21
+
22
+ Required notice text for the packages above:
23
+
24
+ MIT License
25
+
26
+ Permission is hereby granted, free of charge, to any person obtaining a copy
27
+ of this software and associated documentation files (the "Software"), to deal
28
+ in the Software without restriction, including without limitation the rights
29
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
30
+ copies of the Software, and to permit persons to whom the Software is
31
+ furnished to do so, subject to the following conditions:
32
+
33
+ The above copyright notice and this permission notice shall be
34
+ included in all copies or substantial portions of the Software.
35
+
36
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
37
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
38
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
39
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
40
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
41
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
42
+ SOFTWARE.
43
+
44
+ ## BSD-3-Clause Packages
45
+
46
+ - `age-encryption@0.3.1`, copyright 2023 The age Authors.
47
+ - `fast-uri@3.1.6`, copyright (c) 2011-2021 Gary Court and copyright (c) 2021-present The Fastify team.
48
+
49
+ Required notice text for the packages above:
50
+
51
+ Redistribution and use in source and binary forms, with or without
52
+ modification, are permitted provided that the following conditions are met:
53
+
54
+ 1. Redistributions of source code must retain the above copyright notice,
55
+ this list of conditions and the following disclaimer.
56
+ 2. Redistributions in binary form must reproduce the applicable copyright
57
+ notice above, this list of conditions and the following disclaimer in the
58
+ documentation and/or other materials provided with the distribution.
59
+ 3. Neither the name of the copyright holder nor the names of its contributors
60
+ may be used to endorse or promote products derived from this software
61
+ without specific prior written permission.
62
+
63
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
64
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
65
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
66
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
67
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
68
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
69
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
70
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
71
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
72
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
73
+ POSSIBILITY OF SUCH DAMAGE.
74
+
75
+ ## ISC-Licensed Package
76
+
77
+ - `zod-to-json-schema@3.25.2`, copyright (c) 2020 Stefan Terdell.
78
+
79
+ Required notice text:
80
+
81
+ Permission to use, copy, modify, and/or distribute this software for any
82
+ purpose with or without fee is hereby granted, provided that the above
83
+ copyright notice and this permission notice appear in all copies.
84
+
85
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
86
+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
87
+ AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
88
+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
89
+ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
90
+ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
91
+ PERFORMANCE OF THIS SOFTWARE.
92
+
93
+ ## Glitch Friendly Words
94
+
95
+ The readable-ID corpora in
96
+ `packages/control-plane-local/src/vendor/friendly-words/` are copied from
97
+ [glitchdotcom/friendly-words](https://github.com/glitchdotcom/friendly-words)
98
+ commit `f94b4639c71c26875f7684fa86a214c7f30deaad`.
99
+
100
+ MIT License. Copyright (c) 2018 Glitch. The MIT terms above apply.
101
+
102
+ ## anomalyco/opencode
103
+
104
+ The files `packages/sandbox-runtime/src/vendor/opencode-patch.ts` and
105
+ `packages/sandbox-runtime/src/vendor/opencode-edit.ts` contain code adapted
106
+ from [anomalyco/opencode](https://github.com/anomalyco/opencode) commit
107
+ `c29a7c152da09e2828e9529a21d979d6f4d6a120`.
108
+
109
+ MIT License. Copyright (c) 2025 opencode. The MIT terms above apply.
110
+
111
+ `@inquirer/prompts@7.8.6` and `@napi-rs/keyring@2.0.0` remain external runtime
112
+ dependencies and are not included in either Waterbox JavaScript bundle. Their
113
+ npm package manifests identify compatible MIT licenses.