story-vault-mcp 2.0.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 +80 -0
- package/dist/index.cjs +50850 -0
- package/package.json +28 -0
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# story-vault-mcp
|
|
2
|
+
|
|
3
|
+
MCP server for **Story Vault** — a local-first writing app. This server lets any
|
|
4
|
+
MCP-compatible AI client (Claude Desktop, Cursor, Cline, Qwen Chat, …) read and write
|
|
5
|
+
your encrypted Story Vault project data: scenes, characters, world notes, ideas, the
|
|
6
|
+
main story/manuscript, and project memory.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npm install -g story-vault-mcp
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Or run on demand with `npx` (no install needed):
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
npx story-vault-mcp
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Configuration
|
|
21
|
+
|
|
22
|
+
The server needs three environment variables (your vault PIN is used **only** to
|
|
23
|
+
decrypt the database and is never exposed to the AI):
|
|
24
|
+
|
|
25
|
+
| Variable | Required | Purpose |
|
|
26
|
+
| --- | --- | --- |
|
|
27
|
+
| `STORY_VAULT_PIN` | yes | Your vault PIN. |
|
|
28
|
+
| `STORY_VAULT_DATA_DIR` | no | Path to the vault data dir (default `<cwd>/data`). |
|
|
29
|
+
| `STORY_VAULT_PROJECT_ID` | no | Default project ID — tools can omit `project_id`. |
|
|
30
|
+
|
|
31
|
+
### Claude Desktop
|
|
32
|
+
|
|
33
|
+
Edit `claude_desktop_config.json`:
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"mcpServers": {
|
|
38
|
+
"story-vault": {
|
|
39
|
+
"command": "npx",
|
|
40
|
+
"args": ["story-vault-mcp"],
|
|
41
|
+
"env": {
|
|
42
|
+
"STORY_VAULT_PIN": "your-pin",
|
|
43
|
+
"STORY_VAULT_PROJECT_ID": "1",
|
|
44
|
+
"STORY_VAULT_DATA_DIR": "C:/path/to/your/vault/data"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
> On Windows, `npx` may need `cmd /c npx story-vault-mcp` depending on your client.
|
|
52
|
+
|
|
53
|
+
### Other clients (Cursor, Cline, …)
|
|
54
|
+
|
|
55
|
+
Use the same `command`/`args`/`env` shape in the client's MCP configuration.
|
|
56
|
+
|
|
57
|
+
## Tools
|
|
58
|
+
|
|
59
|
+
37 tools covering the full project surface — see the project's `ARCHITECTURE.md`
|
|
60
|
+
("MCP Server (External AI Access)" section) for the complete list. Highlights:
|
|
61
|
+
|
|
62
|
+
- `list_projects` / `get_project` / `create_project` / `update_project`
|
|
63
|
+
- `list_scenes` / `read_scene_content` / `create_scene` / `save_scene_version` (writes prose)
|
|
64
|
+
- `list_characters` / `create_character` / `update_character`
|
|
65
|
+
- `list_world_notes` / `create_world_note`
|
|
66
|
+
- `list_ideas` / `create_idea`
|
|
67
|
+
- `get_main_story` / `add_scene_to_story` / `reorder_main_story`
|
|
68
|
+
- `list_memory` / `add_memory` / `search_memory`
|
|
69
|
+
|
|
70
|
+
## Security
|
|
71
|
+
|
|
72
|
+
- The PIN is consumed only to derive the SQLCipher key (scrypt, N=4096). No tool
|
|
73
|
+
output contains it.
|
|
74
|
+
- User metadata, AI provider settings/API keys, and filesystem paths are never returned.
|
|
75
|
+
- Every call enforces project ownership against the vault's local user.
|
|
76
|
+
|
|
77
|
+
## HTTP mode (optional)
|
|
78
|
+
|
|
79
|
+
`story-vault-mcp --http` starts a Streamable HTTP server on `127.0.0.1:3100/mcp`
|
|
80
|
+
(port via `STORY_VAULT_PORT`).
|