agent-whiteboard 1.0.0 → 1.0.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/CHANGELOG.md +8 -0
- package/LICENSE +136 -21
- package/README.md +19 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
+
## 1.0.1 — 2026-07-19
|
|
2
|
+
|
|
3
|
+
**License change: MIT → PolyForm Noncommercial 1.0.0.** Free to use, modify, and redistribute for any non-commercial purpose; commercial use requires a separate agreement (contact bobpuley@gmail.com). This takes effect from `1.0.1` onward — `1.0.0` remains available under its original MIT terms, since that grant isn't retroactively revocable.
|
|
4
|
+
|
|
5
|
+
- `LICENSE` replaced with the PolyForm Noncommercial License 1.0.0 text, plus a `Required Notice:` copyright line and a commercial-licensing contact line.
|
|
6
|
+
- `package.json`: `"license"` updated to the SPDX id `PolyForm-Noncommercial-1.0.0`.
|
|
7
|
+
- `README.md`: new "License" section explaining the terms and commercial-licensing contact path.
|
|
8
|
+
|
|
1
9
|
## 1.0.0 — 2026-07-19
|
|
2
10
|
|
|
3
11
|
**Milestone v1.0 — 1.0 Release Readiness & npx Distribution (Sprints 75–78) complete.** The first public release: installable and runnable via `npx agent-whiteboard`, with a self-contained production entrypoint, publish-ready package metadata, an enforced local-only trust model, a CI pipeline, and a fix for the one HIGH-severity accessibility finding from the pre-1.0 review pass (FR28 in `01`, F27–F28/NF33–NF37 in `03`).
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,136 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
Required Notice: Copyright (c) 2026 Marco Pugliese (https://github.com/bobpuley/agent-whiteboard)
|
|
2
|
+
|
|
3
|
+
Commercial use is not covered by this license. To discuss a commercial
|
|
4
|
+
license, contact bobpuley@gmail.com.
|
|
5
|
+
|
|
6
|
+
PolyForm Noncommercial License 1.0.0
|
|
7
|
+
|
|
8
|
+
<https://polyformproject.org/licenses/noncommercial/1.0.0>
|
|
9
|
+
|
|
10
|
+
## Acceptance
|
|
11
|
+
|
|
12
|
+
In order to get any license under these terms, you must agree
|
|
13
|
+
to them as both strict obligations and conditions to all
|
|
14
|
+
your licenses.
|
|
15
|
+
|
|
16
|
+
## Copyright License
|
|
17
|
+
|
|
18
|
+
The licensor grants you a copyright license for the
|
|
19
|
+
software to do everything you might do with the software
|
|
20
|
+
that would otherwise infringe the licensor's copyright
|
|
21
|
+
in it for any permitted purpose. However, you may
|
|
22
|
+
only distribute the software according to [Distribution
|
|
23
|
+
License](#distribution-license) and make changes or new works
|
|
24
|
+
based on the software according to [Changes and New Works
|
|
25
|
+
License](#changes-and-new-works-license).
|
|
26
|
+
|
|
27
|
+
## Distribution License
|
|
28
|
+
|
|
29
|
+
The licensor grants you an additional copyright license
|
|
30
|
+
to distribute copies of the software. Your license
|
|
31
|
+
to distribute covers distributing the software with
|
|
32
|
+
changes and new works permitted by [Changes and New Works
|
|
33
|
+
License](#changes-and-new-works-license).
|
|
34
|
+
|
|
35
|
+
## Notices
|
|
36
|
+
|
|
37
|
+
You must ensure that anyone who gets a copy of any part of
|
|
38
|
+
the software from you also gets a copy of these terms or the
|
|
39
|
+
URL for them above, as well as copies of any plain-text lines
|
|
40
|
+
beginning with `Required Notice:` that the licensor provided
|
|
41
|
+
with the software. For example:
|
|
42
|
+
|
|
43
|
+
> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
|
|
44
|
+
|
|
45
|
+
## Changes and New Works License
|
|
46
|
+
|
|
47
|
+
The licensor grants you an additional copyright license to
|
|
48
|
+
make changes and new works based on the software for any
|
|
49
|
+
permitted purpose.
|
|
50
|
+
|
|
51
|
+
## Patent License
|
|
52
|
+
|
|
53
|
+
The licensor grants you a patent license for the software that
|
|
54
|
+
covers patent claims the licensor can license, or becomes able
|
|
55
|
+
to license, that you would infringe by using the software.
|
|
56
|
+
|
|
57
|
+
## Noncommercial Purposes
|
|
58
|
+
|
|
59
|
+
Any noncommercial purpose is a permitted purpose.
|
|
60
|
+
|
|
61
|
+
## Personal Uses
|
|
62
|
+
|
|
63
|
+
Personal use for research, experiment, and testing for
|
|
64
|
+
the benefit of public knowledge, personal study, private
|
|
65
|
+
entertainment, hobby projects, amateur pursuits, or religious
|
|
66
|
+
observance, without any anticipated commercial application,
|
|
67
|
+
is use for a permitted purpose.
|
|
68
|
+
|
|
69
|
+
## Noncommercial Organizations
|
|
70
|
+
|
|
71
|
+
Use by any charitable organization, educational institution,
|
|
72
|
+
public research organization, public safety or health
|
|
73
|
+
organization, environmental protection organization, or
|
|
74
|
+
government institution is use for a permitted purpose
|
|
75
|
+
regardless of the source of funding or obligations resulting
|
|
76
|
+
from the funding.
|
|
77
|
+
|
|
78
|
+
## Fair Use
|
|
79
|
+
|
|
80
|
+
You may have "fair use" rights for the software under the
|
|
81
|
+
law. These terms do not limit them.
|
|
82
|
+
|
|
83
|
+
## No Other Rights
|
|
84
|
+
|
|
85
|
+
These terms do not allow you to sublicense or transfer any of
|
|
86
|
+
your licenses to anyone else, or prevent the licensor from
|
|
87
|
+
granting licenses to anyone else. These terms do not imply
|
|
88
|
+
any other licenses.
|
|
89
|
+
|
|
90
|
+
## Patent Defense
|
|
91
|
+
|
|
92
|
+
If you make any written claim that the software infringes or
|
|
93
|
+
contributes to infringement of any patent, your patent license
|
|
94
|
+
for the software granted under these terms ends immediately. If
|
|
95
|
+
your company makes such a claim, your patent license ends
|
|
96
|
+
immediately for work on behalf of your company.
|
|
97
|
+
|
|
98
|
+
## Violations
|
|
99
|
+
|
|
100
|
+
The first time you are notified in writing that you have
|
|
101
|
+
violated any of these terms, or done anything with the software
|
|
102
|
+
not covered by your licenses, your licenses can nonetheless
|
|
103
|
+
continue if you come into full compliance with these terms,
|
|
104
|
+
and take practical steps to correct past violations, within
|
|
105
|
+
32 days of receiving notice. Otherwise, all your licenses
|
|
106
|
+
end immediately.
|
|
107
|
+
|
|
108
|
+
## No Liability
|
|
109
|
+
|
|
110
|
+
***As far as the law allows, the software comes as is, without
|
|
111
|
+
any warranty or condition, and the licensor will not be liable
|
|
112
|
+
to you for any damages arising out of these terms or the use
|
|
113
|
+
or nature of the software, under any kind of legal claim.***
|
|
114
|
+
|
|
115
|
+
## Definitions
|
|
116
|
+
|
|
117
|
+
The **licensor** is the individual or entity offering these
|
|
118
|
+
terms, and the **software** is the software the licensor makes
|
|
119
|
+
available under these terms.
|
|
120
|
+
|
|
121
|
+
**You** refers to the individual or entity agreeing to these
|
|
122
|
+
terms.
|
|
123
|
+
|
|
124
|
+
**Your company** is any legal entity, sole proprietorship,
|
|
125
|
+
or other kind of organization that you work for, plus all
|
|
126
|
+
organizations that have control over, are under the control of,
|
|
127
|
+
or are under common control with that organization. **Control**
|
|
128
|
+
means ownership of substantially all the assets of an entity,
|
|
129
|
+
or the power to direct its management and policies by vote,
|
|
130
|
+
contract, or otherwise. Control can be direct or indirect.
|
|
131
|
+
|
|
132
|
+
**Your licenses** are all the licenses granted to you for the
|
|
133
|
+
software under these terms.
|
|
134
|
+
|
|
135
|
+
**Use** means anything you do with the software requiring one
|
|
136
|
+
of your licenses.
|
package/README.md
CHANGED
|
@@ -64,6 +64,20 @@ Enable the MCP server in Claude Code the first time:
|
|
|
64
64
|
|
|
65
65
|
Select `agent-whiteboard` and enable it. The tools will be available immediately.
|
|
66
66
|
|
|
67
|
+
## Environment variables
|
|
68
|
+
|
|
69
|
+
| Variable | Default | Description |
|
|
70
|
+
|----------------------------|-----------------------|-------------|
|
|
71
|
+
| `PORT` | `3000` | Server port — serves the REST/MCP/WebSocket API, and (via `npx agent-whiteboard`) the built client too. |
|
|
72
|
+
| `HOST` | `localhost` | Bind address. Must resolve to a loopback address (`localhost`, `127.0.0.1`, `::1`) — the server refuses to start otherwise unless `ALLOW_NON_LOOPBACK` is set. See [Trust model](#trust-model). |
|
|
73
|
+
| `ALLOW_NON_LOOPBACK` | unset | Set to `1` to allow binding a non-loopback `HOST`. Not recommended — there is no authentication on any endpoint. |
|
|
74
|
+
| `WHITEBOARD_SNAPSHOTS_DIR` | `~/.agent-whiteboard` | Snapshot storage location. |
|
|
75
|
+
| `CHANNEL_PORT` | `3001` | Port for the stdio-channel HTTP relay used by Claude Code's channel forwarding (only relevant if Claude Code was started with channels enabled). |
|
|
76
|
+
|
|
77
|
+
**Port conflicts:** if `:3000` (or `:3001`/`:5173`, see below) is already in use on your machine, set `PORT` (and `CHANNEL_PORT` if needed) to a free port before starting.
|
|
78
|
+
|
|
79
|
+
> Dev-only (`npm run dev`, not `npx agent-whiteboard`): the Vite client dev server always runs on `:5173`, hardcoded in `client/vite.config.ts` — not currently configurable via an environment variable.
|
|
80
|
+
|
|
67
81
|
## MCP tools
|
|
68
82
|
|
|
69
83
|
### `render(type, payload[, options])`
|
|
@@ -310,4 +324,8 @@ npm run test:e2e # Playwright end-to-end tests (requires npm run dev:test first
|
|
|
310
324
|
}
|
|
311
325
|
```
|
|
312
326
|
|
|
313
|
-
The server must be running before Claude Code connects.
|
|
327
|
+
The server must be running before Claude Code connects. If you override `PORT`, update the URL above to match. See [Environment variables](#environment-variables) for the full list of overridable settings.
|
|
328
|
+
|
|
329
|
+
## License
|
|
330
|
+
|
|
331
|
+
[PolyForm Noncommercial License 1.0.0](LICENSE) — free to use, modify, and redistribute for any non-commercial purpose. Commercial use isn't covered by this license; if you want to use this commercially, reach out at bobpuley@gmail.com to discuss a license.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-whiteboard",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "A domain-agnostic interactive whiteboard for AI teacher agents — render diagrams, math, charts, and HTML to a local browser tab via MCP tools.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"url": "https://github.com/bobpuley/agent-whiteboard/issues"
|
|
23
23
|
},
|
|
24
24
|
"author": "Marco Pugliese",
|
|
25
|
-
"license": "
|
|
25
|
+
"license": "PolyForm-Noncommercial-1.0.0",
|
|
26
26
|
"keywords": [
|
|
27
27
|
"mcp",
|
|
28
28
|
"model-context-protocol",
|