@appsoftwareltd/etherpk-mcp 0.9.6 → 0.10.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/README.md CHANGED
@@ -38,8 +38,10 @@ No sign-in and no Sync Server:
38
38
  claude mcp add etherpk -- npx @appsoftwareltd/etherpk-mcp serve --folder /path/to/your/notes
39
39
  ```
40
40
 
41
- The folder must already be an EtherPK graph, so open it in EtherPK once. **Settings → Agents**
42
- shows this command with the path filled in once the folder's path is set on the General tab.
41
+ The folder must already be an EtherPK graph, with `pages/` and `journals/` folders in it. EtherPK
42
+ makes them when it opens a folder, and the [agent skill](#the-agent-skill) makes them for a new
43
+ one. **Settings → Agents** shows this command with the path filled in once the folder's path is set
44
+ on the General tab.
43
45
 
44
46
  ### Ask about your notes
45
47
 
@@ -169,9 +171,13 @@ npx @appsoftwareltd/etherpk-mcp publish --graph <id or name> --publication <id>
169
171
 
170
172
  - `--out` is remembered for that graph and publication. Later runs without it, and the agent's
171
173
  `publish` tool, write to the same folder.
172
- - The top-level `.html` files, `assets/`, `theme/` and the search, feed and report files are
173
- rewritten, and files that no longer belong are removed. Everything else in the folder is left
174
- alone.
174
+ - The top-level `.html` files, `assets/`, `theme/` and the search and feed files are rewritten,
175
+ and files that no longer belong are removed. Everything else in the folder is left alone.
176
+ - The folder must be one of its own, outside the graph's folder. A publish refuses the graph's
177
+ folder, a folder inside it and a folder that holds it, because it would remove the graph's files.
178
+ - `--dry-run` in place of `--out` renders and checks the publication and prints the whole report,
179
+ with the names of the pages it mentions, without writing anything. It needs no folder. Keep its
180
+ output out of public logs. The agent's `publish` tool takes `dryRun: true` for the same check.
175
181
  - Deploying the folder is up to you. Run the command from cron for a site that republishes itself.
176
182
  - Mermaid diagrams and maps need a browser. A map is published as a picture of the map, drawn over
177
183
  EtherPK's map host unless `ETHERPK_MAP_STYLE_URL` names another style. `diagrams setup` installs a
@@ -180,6 +186,17 @@ npx @appsoftwareltd/etherpk-mcp publish --graph <id or name> --publication <id>
180
186
  computer instead, which NixOS needs.
181
187
  - `list_publications`, or **Settings → Publish** in EtherPK, shows the publication ids.
182
188
 
189
+ ## The agent skill
190
+
191
+ The `etherpk` agent skill teaches an agent to make a blog, docs site or wiki folder in EtherPK's
192
+ format inside any project, to check it with `publish --dry-run`, and to publish it with this
193
+ command. For a synced graph it sends the agent to the tools above. Install it in the project the
194
+ agent works in, or with `-g` for every project:
195
+
196
+ ```sh
197
+ npx skills add appsoftwareltd/etherpk-client
198
+ ```
199
+
183
200
  ## Reference
184
201
 
185
202
  Every command is `npx @appsoftwareltd/etherpk-mcp <command>`. For the short form, `etherpk-mcp`,