@appsoftwareltd/etherpk-mcp 0.11.1 → 0.13.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
@@ -17,14 +17,14 @@ Needs Node.js 24 or later.
17
17
 
18
18
  ### A synced graph
19
19
 
20
- In EtherPK, open the graph's **Settings → Agents** and select **Make a setup code**. The tab shows
20
+ In EtherPK, open the graph's **Settings → Agents** and select **Create an Agent Setup Code**. The tab shows
21
21
  two commands with your server, the code and the graph filled in. On your own Sync Server, the tab
22
22
  links to the server's **Access tokens** page, which makes the code.
23
23
 
24
24
  ```sh
25
- # Once per computer. When this terminal and an unlocked EtherPK tab show the same code,
26
- # approve in the tab, then press y here.
27
- npx @appsoftwareltd/etherpk-mcp login --sync-server https://sync.etherpk.com --code <setup code>
25
+ # Once per computer. When this terminal and EtherPK, on a device where your Encryption Keys are
26
+ # unlocked, show the same code, approve there, then press y here.
27
+ npx @appsoftwareltd/etherpk-mcp login --sync-server https://sync.etherpk.com --code <Agent Setup Code>
28
28
 
29
29
  # Register the graph with your agent (Claude Code shown, the Agents tab has the others).
30
30
  claude mcp add etherpk -- npx @appsoftwareltd/etherpk-mcp serve --sync-server https://sync.etherpk.com --graph <graph id>
@@ -124,14 +124,15 @@ directory, once per computer.
124
124
 
125
125
  `login` makes this computer a device of your account.
126
126
 
127
- - **The token.** `--code` trades a setup code for an agent token. Make the code in a synced graph's
128
- **Settings → Agents** in EtherPK, or on the Sync Server's **Access tokens** page, where the token
129
- is then listed as "Agent on <computer name>". An agent token can read and write your graphs. It
127
+ - **The token.** `--code` trades an Agent Setup Code for an Agent Token. Create the code in
128
+ EtherPK's Agents settings (the Graphs page's **Agents** tab, or a synced graph's **Settings →
129
+ Agents**), or on the Sync Server's **Access tokens** page, where the token is then listed as
130
+ "Agent on <computer name>". An agent token can read and write your graphs. It
130
131
  cannot reset or replace your Encryption Keys, make tokens, invite people or delete graphs. It
131
132
  stops working after 30 days unused, when you revoke it, and when you reset your Encryption Keys.
132
- - **For a script**, or a Sync Server too old for setup codes, `--pat` or `ETHERPK_PAT` gives an
133
- account-wide access token instead. `login` unlocks with it, then swaps it for an agent token and
134
- revokes it.
133
+ - **For a script**, `--pat` or `ETHERPK_PAT` gives an account-wide access token instead. `login`
134
+ unlocks with it, then swaps it for an Agent Token and revokes it. If the swap fails, `login`
135
+ fails and keeps nothing.
135
136
  - **The keys** are unlocked by Device Approval. Open EtherPK in a browser where the account's
136
137
  Encryption Keys are unlocked. When the browser and the terminal show the same short code, select
137
138
  **Approve** in the browser and press `y` in the terminal. Press `n` if the codes differ.
@@ -207,7 +208,7 @@ install the package globally once with `npm install -g @appsoftwareltd/etherpk-m
207
208
 
208
209
  | Command | What it does |
209
210
  | --- | --- |
210
- | `login --sync-server <url> [--code <setup code>] [--recovery-code]` | Sign this computer in as a device of your account, unlock your Encryption Keys, and list the graphs the account can reach. |
211
+ | `login --sync-server <url> [--code <Agent Setup Code>] [--recovery-code]` | Sign this computer in as a device of your account, unlock your Encryption Keys, and list the graphs the account can reach. |
211
212
  | `graphs [--sync-server <url>]` | List the synced graphs each signed-in account can reach, with name, id and your role. |
212
213
  | `serve --graph <id or name> [--sync-server <url>] [--no-semantic]` | Serve one synced graph to the agent over stdio. |
213
214
  | `serve --folder <path> [--no-semantic]` | Serve a local graph folder the same way. |
@@ -226,8 +227,8 @@ install the package globally once with `npm install -g @appsoftwareltd/etherpk-m
226
227
  | Flag | Applies to | Meaning |
227
228
  | --- | --- | --- |
228
229
  | `--sync-server <url>` | `login`, `graphs`, `serve --graph`, `publish --graph`, `stop --graph`, `logout` | Which Sync Server the command means. Required for `login`, and elsewhere optional while only one server is signed in. `serve` and `logout` refuse to guess between several. |
229
- | `--code <setup code>` | `login` | The one-time setup code. It works once, within 10 minutes. |
230
- | `--pat <token>` | `login` | An account-wide access token instead of a setup code. `login` swaps it for an agent token and revokes it. |
230
+ | `--code <Agent Setup Code>` | `login` | The one-time Agent Setup Code. It works once, within 10 minutes. |
231
+ | `--pat <token>` | `login` | An account-wide access token instead of an Agent Setup Code. `login` swaps it for an agent token and revokes it. |
231
232
  | `--recovery-code` | `login` | Unlock with your Recovery Code instead of Device Approval. Pressing `r` while `login` waits does the same. |
232
233
  | `--graph <id or name>` | `serve`, `publish`, `stop` | The synced graph. Not with `--folder`. |
233
234
  | `--folder <path>` | `serve`, `publish`, `stop` | The local graph folder. Not with `--graph` or `--sync-server`. |