@squirrelnotes.app/mcp 2.1.1-test.344 → 2.1.1-test.346
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 +42 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ The passphrase lives in `claude_desktop_config.json` on your machine and is pass
|
|
|
31
31
|
| `get_note` | Returns a single note with decrypted title + full content. |
|
|
32
32
|
| `create_note` | Creates a note with encrypted title + content. |
|
|
33
33
|
| `update_note` | Updates title, content, or pinnedAt on a note. |
|
|
34
|
-
| `delete_note` |
|
|
34
|
+
| `delete_note` | Moves a note to trash (recoverable for 30 days). Its public share link is revoked at once. |
|
|
35
35
|
| `pin_note` | Pins or unpins a note (appears at top of sidebar). |
|
|
36
36
|
| `append_to_note` | Appends markdown content to an existing note. Saves the agent a get → update, but it is **not** race-free: it reads the note and writes it back whole, and the server has no version check, so an edit made elsewhere in between is overwritten. |
|
|
37
37
|
| `set_note_tags` | Replaces all tags on a note. |
|
|
@@ -39,6 +39,45 @@ The passphrase lives in `claude_desktop_config.json` on your machine and is pass
|
|
|
39
39
|
| `search_note_content` | Full-content search (slow — decrypts all notes). Use only when title search fails. |
|
|
40
40
|
| `move_note_to_collection` | Moves a note to a collection (or to scratchpad if collectionId is null). |
|
|
41
41
|
|
|
42
|
+
### Trash
|
|
43
|
+
|
|
44
|
+
| Tool | Description |
|
|
45
|
+
|------|-------------|
|
|
46
|
+
| `list_trash` | Lists trashed notes with decrypted titles and when each was trashed. Trashed notes are hard-deleted automatically 30 days after trashing. |
|
|
47
|
+
| `restore_note` | Restores a trashed note to its last collection. Public share links are not recreated. |
|
|
48
|
+
| `permanently_delete_note` | Permanently deletes one trashed note, its attachments and its encrypted content. Irreversible; the note must already be in trash. |
|
|
49
|
+
| `empty_trash` | Permanently deletes every trashed note and its attachments. Irreversible; requires `confirm: true`. |
|
|
50
|
+
|
|
51
|
+
### Collections
|
|
52
|
+
|
|
53
|
+
| Tool | Description |
|
|
54
|
+
|------|-------------|
|
|
55
|
+
| `list_collections` | Lists regular collections (folders) with decrypted names and `parentId` for nesting. Smart collections are left out: their notes are computed, so nothing can be placed in them. |
|
|
56
|
+
| `get_collection` | Returns one collection with its decrypted name. |
|
|
57
|
+
| `create_collection` | Creates a collection from a plaintext `name` (encrypted before the API call), optionally nested under `parentId`, with an optional `iconColor` hex code. |
|
|
58
|
+
| `update_collection` | Changes a collection's name, parent or icon colour. Its kind cannot be changed. |
|
|
59
|
+
| `delete_collection` | Deletes a collection. Its notes move to the scratchpad; they are not deleted. |
|
|
60
|
+
|
|
61
|
+
### Tags
|
|
62
|
+
|
|
63
|
+
| Tool | Description |
|
|
64
|
+
|------|-------------|
|
|
65
|
+
| `list_tags` | Lists tags with decrypted names and colours. Use it to find tag IDs for `set_note_tags`. |
|
|
66
|
+
| `get_tag` | Returns one tag with its decrypted name. |
|
|
67
|
+
| `create_tag` | Creates a tag from a plaintext `name` (encrypted before the API call) and an optional `color` hex code. |
|
|
68
|
+
| `update_tag` | Changes a tag's name or colour. |
|
|
69
|
+
| `delete_tag` | Deletes a tag and removes it from every note that had it. |
|
|
70
|
+
|
|
71
|
+
### Sharing
|
|
72
|
+
|
|
73
|
+
| Tool | Description |
|
|
74
|
+
|------|-------------|
|
|
75
|
+
| `share_note` | Publishes a note as a public link protected by a share passphrase, with optional `expiry` and `allowDownload` (default off). The note is decrypted here and re-encrypted under a key derived from the share passphrase, so the server never sees plaintext. Returns the share URL and token. The share passphrase is a tool argument, so it passes through your agent and its model provider; send it to recipients separately from the link. |
|
|
76
|
+
| `get_share_status` | Returns a note's share URL, view count, expiry and settings, or `null` if it is not shared. |
|
|
77
|
+
| `republish_share` | Re-encrypts an existing share with the note's latest content. Needs the share passphrase (the same one or a new one). |
|
|
78
|
+
| `update_share_settings` | Changes a share's `expiry` and/or `allowDownload` without changing its content. |
|
|
79
|
+
| `revoke_share` | Revokes a share link permanently; it stops working at once. The note is not affected. |
|
|
80
|
+
|
|
42
81
|
### Saved Searches (Pro)
|
|
43
82
|
|
|
44
83
|
| Tool | Description |
|
|
@@ -209,7 +248,7 @@ Add both servers to `claude_desktop_config.json`:
|
|
|
209
248
|
|
|
210
249
|
The server needs an API key and your passphrase, both set as env vars in your client's config (see Setup). The API key is sent to the Squirrel Notes API in the `Authorization` header; the passphrase is never sent anywhere.
|
|
211
250
|
|
|
212
|
-
Generate an API key in Squirrel Notes → Settings → API
|
|
251
|
+
Generate an API key in Squirrel Notes → Settings → API & Data (requires Pro tier).
|
|
213
252
|
|
|
214
253
|
---
|
|
215
254
|
|
|
@@ -397,7 +436,7 @@ Not logged:
|
|
|
397
436
|
| Variable | Required | Description |
|
|
398
437
|
|----------|----------|-------------|
|
|
399
438
|
| `SQUIRREL_API_BASE_URL` | ✅ | Base URL of the Squirrel Notes backend API (e.g. `https://api.squirrelnotes.app`) |
|
|
400
|
-
| `SQUIRREL_API_KEY` | ✅ | Your API key from Settings → API
|
|
439
|
+
| `SQUIRREL_API_KEY` | ✅ | Your API key from Settings → API & Data (requires Pro tier) |
|
|
401
440
|
| `SQUIRREL_PASSPHRASE` | ✅ | Your encryption passphrase — never leaves your machine |
|
|
402
441
|
| `SQUIRREL_LOG_FILE` | — | Absolute path to a log file. When set, all stderr output is also appended to this file. |
|
|
403
442
|
| `SQUIRREL_MEMORY_EMBEDDINGS`, `SQUIRREL_MEMORY_MODEL_DIR`, `SQUIRREL_MEMORY_CACHE_DIR` | — | Read only by the opt-in embeddings companion (`@squirrelnotes.app/mcp-embeddings`); see its README. |
|
package/package.json
CHANGED