@appsoftwareltd/etherpk-mcp 0.8.0 → 0.8.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 +14 -8
- package/dist/main.js +1641 -232
- package/dist/main.js.map +1 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -59,10 +59,16 @@ and every tool refuses a protected document.
|
|
|
59
59
|
| Find and read | `graph_info`, `list_documents`, `read_document`, `read_documents`, `search`, `backlinks`, `tasks` | `list_documents` can narrow to a range of journal days. `read_document` returns the body as text and the frontmatter as data. |
|
|
60
60
|
| Edit | `edit_document`, `append_document`, `create_page`, `set_task`, `set_frontmatter`, `set_aliases` | `edit_document` replaces one exact, unique piece of text; on a synced graph it merges with edits made elsewhere at the same time. `append_document` creates a day's journal entry when there is none. `set_frontmatter` sets any key except `title`, `aliases` and `publication`, which have tools of their own. |
|
|
61
61
|
| Rename | `plan_rename`, `rename` | Links to the old name are rewritten by default and scoped concepts move with it. Renaming onto a name that is taken merges two documents and needs confirming. |
|
|
62
|
-
| Images and files | `upload_asset`, `read_asset`, `list_assets` | `upload_asset` returns the markdown to paste into a document
|
|
62
|
+
| Images and files | `upload_asset`, `read_asset`, `list_assets` | `upload_asset` returns the markdown to paste into a document. It refuses hidden files and folders (`.ssh`, `.env`), the Headless Client's own config and cache, and files over 100 MiB. `read_asset` writes an asset to a local file. |
|
|
63
63
|
| Publishing | `list_publications`, `create_publication`, `update_publication`, `publish` | `publish` writes into the folder you set with the `publish` command; the agent can't choose one. |
|
|
64
64
|
| Themes | `list_themes`, `read_theme`, `read_theme_file`, `create_theme`, `customise_publication_theme`, `write_theme_file`, `delete_theme_file`, `import_theme_folder`, `delete_theme`, `preview_theme` | Bundled themes are read-only; customising one copies it into the graph. `preview_theme` renders a site to inspect, with screenshots when a browser is set up. |
|
|
65
65
|
|
|
66
|
+
`read_asset`, `read_theme` and `preview_theme` write only under the graph's **downloads directory**,
|
|
67
|
+
`downloads` inside the graph's folder in the cache directory, and `import_theme_folder` reads only
|
|
68
|
+
from there. An agent names a folder relative to it and gets the full path back; a folder outside it
|
|
69
|
+
is refused, so a prompt hidden in a note cannot steer the agent into writing or reading elsewhere.
|
|
70
|
+
Copy a file out with your own tools when you want it somewhere else.
|
|
71
|
+
|
|
66
72
|
## Search by meaning
|
|
67
73
|
|
|
68
74
|
`search` matches words. After one setup step it also matches **meaning**: "when do I pay my taxes"
|
|
@@ -107,8 +113,8 @@ directory, once per computer.
|
|
|
107
113
|
- With no EtherPK to hand, press `r` while it waits, or pass `--recovery-code`, and type your
|
|
108
114
|
Recovery Code instead. `ETHERPK_RECOVERY_CODE` supplies the code for a scripted setup.
|
|
109
115
|
|
|
110
|
-
When it is done it lists the graphs the account can reach.
|
|
111
|
-
|
|
116
|
+
When it is done it lists the graphs the account can reach. For a Sync Server other than EtherPK's,
|
|
117
|
+
give its address to `login`.
|
|
112
118
|
|
|
113
119
|
### Choosing a graph
|
|
114
120
|
|
|
@@ -118,9 +124,9 @@ stored on the server is opened once to read its name; `(unnamed)` means it has n
|
|
|
118
124
|
|
|
119
125
|
### Several Sync Servers
|
|
120
126
|
|
|
121
|
-
One computer can be signed in to several Sync Servers
|
|
122
|
-
|
|
123
|
-
|
|
127
|
+
One computer can be signed in to several Sync Servers. Run `login` once for each. `--sync-server`
|
|
128
|
+
then says which server a command means. It can be left out while only one server is signed in,
|
|
129
|
+
and the commands the Agents tab shows always include it.
|
|
124
130
|
|
|
125
131
|
## Local folders in detail
|
|
126
132
|
|
|
@@ -239,8 +245,8 @@ pnpm --filter @appsoftwareltd/etherpk-mcp test # unit tests, no server needed
|
|
|
239
245
|
pnpm --filter @appsoftwareltd/etherpk-mcp build # dist/main.js; run it with node dist/main.js
|
|
240
246
|
```
|
|
241
247
|
|
|
242
|
-
Releases are published to npm by the repository's CI, at the version the Client
|
|
243
|
-
|
|
248
|
+
Releases are published to npm by the repository's CI, at the same version as the Client. To check
|
|
249
|
+
that a version is on the registry:
|
|
244
250
|
|
|
245
251
|
```sh
|
|
246
252
|
npx -y @appsoftwareltd/etherpk-mcp@<version> --version
|