@appsoftwareltd/etherpk-mcp 0.4.2 → 0.5.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 CHANGED
@@ -37,8 +37,10 @@ claude mcp add etherpk -- npx @appsoftwareltd/etherpk-mcp serve --sync-server ht
37
37
  ```client
38
38
 
39
39
  `npx @appsoftwareltd/etherpk-mcp graphs` lists the graphs each signed-in account can reach, by
40
- name and id. For a scripted setup, `ETHERPK_PAT` and `ETHERPK_RECOVERY_CODE` stand in for the
41
- prompts.
40
+ name and id. A graph listed as `(no name yet - open it in EtherPK once)` has not been opened by
41
+ anyone since the Sync Server learned to carry an encrypted copy of each name; opening it once,
42
+ in EtherPK or with `serve`, publishes it. For a scripted setup, `ETHERPK_PAT` and
43
+ `ETHERPK_RECOVERY_CODE` stand in for the prompts.
42
44
 
43
45
  ## More than one Sync Server
44
46
 
@@ -69,6 +71,12 @@ unique old→new replacement that merges with anyone typing elsewhere on the pag
69
71
  `append_document` (a page, or a day's journal entry, created if needed) and `create_page`.
70
72
  One running instance serves one graph.
71
73
 
74
+ No skill or extra setup is needed for the agent to use it: the server describes its tools and
75
+ the graph, and Claude Code reaches for them when you ask about your notes or journal. To make
76
+ that a rule rather than a good guess, add one line to your `CLAUDE.md`: *"My notes live in
77
+ EtherPK; use the etherpk MCP tools for anything I've written down, and `search` in semantic
78
+ mode for questions."*
79
+
72
80
  ## Searching by meaning
73
81
 
74
82
  `search` matches words. With one more step it can also match **meaning** - "when do I pay my
@@ -101,6 +109,12 @@ model files into `~/.cache/etherpk/mcp/models/all-MiniLM-L6-v2-int8/`.
101
109
  between model calls; `ETHERPK_MCP_SEMANTIC_THREADS=8` in the registration's `env` makes it
102
110
  faster and hotter. `ETHERPK_MCP_DEBUG_MEMORY=1` logs the process's memory if you ever need
103
111
  to see it.
112
+ - **Only while it runs.** The store is built and kept current by the `serve` process, which
113
+ exists only while an agent session has it open (Claude Code starts it with the session and
114
+ stops it after). Nothing runs in between. While it runs, the on-disk snapshot `semantic
115
+ status` reads is refreshed 5 s after any change arrives, every 30 s during a build, and at
116
+ shutdown, whether or not the agent is calling it. To keep a graph current without an agent
117
+ open, run `serve` by hand: `npx @appsoftwareltd/etherpk-mcp serve --graph <id> </dev/null &`.
104
118
  - **One cache directory for both.** Setup and `serve` must see the same cache root - by default
105
119
  `~/.cache/etherpk/mcp` (`C:\Users\<you>\.cache\etherpk\mcp` on Windows). If you set
106
120
  `ETHERPK_MCP_CACHE_DIR` in your shell, put it in the agent registration's `env` too, since