threadnote 0.3.0 → 0.3.2
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 +31 -5
- package/dist/mcp_server.cjs +765 -407
- package/dist/threadnote.cjs +4646 -4178
- package/docs/agent-instructions.md +7 -2
- package/docs/troubleshooting.md +12 -0
- package/package.json +16 -4
package/README.md
CHANGED
|
@@ -68,6 +68,27 @@ threadnote start
|
|
|
68
68
|
threadnote doctor --dry-run
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
+
### Update
|
|
72
|
+
|
|
73
|
+
Threadnote occasionally checks npm for a newer published version when you run human-facing commands such as `doctor`,
|
|
74
|
+
`start`, `install`, or `repair`. The check is cached under `THREADNOTE_HOME` and never runs in CI or when
|
|
75
|
+
`THREADNOTE_NO_UPDATE_CHECK` or `NO_UPDATE_NOTIFIER` is set.
|
|
76
|
+
|
|
77
|
+
Update the package and refresh local shims, user instructions, and MCP config with one command:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
threadnote update
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Check without changing anything:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
threadnote update --check
|
|
87
|
+
threadnote update --dry-run
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
After updating, restart Cursor, Codex, Claude, or open a fresh agent session so MCP tools reload.
|
|
91
|
+
|
|
71
92
|
### MCP
|
|
72
93
|
|
|
73
94
|
Make the agents you use aware of Threadnote. Use only the MCP install lines for agents you actually use. Open a fresh
|
|
@@ -152,6 +173,8 @@ This is it! Start working with your agents as usual. The agent will automaticall
|
|
|
152
173
|
- `doctor`: checks prerequisites, the generated command shim, manifest shape, templates, and local OpenViking health.
|
|
153
174
|
- `install`: installs `openviking[local-embed]==0.3.12` if missing, creates `~/.openviking` config files if absent,
|
|
154
175
|
writes the command shim, and upserts user-level agent instructions.
|
|
176
|
+
- `update`: updates the published Threadnote package, then runs `repair` so shims and MCP config point at the new
|
|
177
|
+
version.
|
|
155
178
|
- `repair`: fixes install/config/shim/manifest/server health issues and rewrites Codex/Claude/Cursor MCP configs from the
|
|
156
179
|
current checkout.
|
|
157
180
|
- `start`: starts `openviking-server` on `127.0.0.1:1933`.
|
|
@@ -174,6 +197,9 @@ This is it! Start working with your agents as usual. The agent will automaticall
|
|
|
174
197
|
|
|
175
198
|
## Source Checkout
|
|
176
199
|
|
|
200
|
+
TypeScript sources live under `src/`; `src/threadnote.ts` is the CLI entrypoint and `src/mcp_server.ts` is the stdio MCP
|
|
201
|
+
adapter entrypoint.
|
|
202
|
+
|
|
177
203
|
For local development from this repo:
|
|
178
204
|
|
|
179
205
|
```bash
|
|
@@ -212,6 +238,8 @@ Environment variables:
|
|
|
212
238
|
- `THREADNOTE_USER`: OpenViking user value, default local username.
|
|
213
239
|
- `THREADNOTE_AGENT_ID`: shared agent identity, default `threadnote`.
|
|
214
240
|
- `THREADNOTE_OPENVIKING_VERSION`: package version to install, default `0.3.12`.
|
|
241
|
+
- `THREADNOTE_NPM_REGISTRY`: npm registry used by the installer and updater, default `https://registry.npmjs.org/`.
|
|
242
|
+
- `THREADNOTE_NO_UPDATE_CHECK`: disables opportunistic update notifications.
|
|
215
243
|
- `THREADNOTE_BIN_DIR`: directory for the `threadnote` shim, default `~/.local/bin`.
|
|
216
244
|
- `THREADNOTE_HOST`: local bind host, default `127.0.0.1`.
|
|
217
245
|
- `THREADNOTE_PORT`: local bind port, default `1933`.
|
|
@@ -225,9 +253,6 @@ only occurs when another process already owns the same host and port. If that ha
|
|
|
225
253
|
See `docs/migration.md` for switching an existing repo workflow to `threadnote` without deleting canonical
|
|
226
254
|
`AGENTS.md`, `CLAUDE.md`, `.claude/`, or `.agents/` files.
|
|
227
255
|
|
|
228
|
-
See `docs/demo.md` for an engineer-facing demo script that shows recall, read, remember, handoff, and repair across
|
|
229
|
-
agents or worktrees.
|
|
230
|
-
|
|
231
256
|
See `docs/agent-instructions.md` for the user-level agent guidance installed by `threadnote install`.
|
|
232
257
|
|
|
233
258
|
## Recall And Read
|
|
@@ -241,5 +266,6 @@ threadnote read viking://agent/threadnote/memories/.abstract.md
|
|
|
241
266
|
threadnote list viking://agent/threadnote/memories --all --recursive
|
|
242
267
|
```
|
|
243
268
|
|
|
244
|
-
When MCP is installed, the agent should use
|
|
245
|
-
|
|
269
|
+
When MCP is installed, the agent should use Threadnote MCP `recall_context`, then `read_context` or `list_context`.
|
|
270
|
+
Agents must pass JSON arguments, for example `recall_context({"query":"agent context"})`. Older adapters expose
|
|
271
|
+
`search`, `read`, and `list` aliases. The CLI commands are the fallback path.
|