grill-mcp 0.1.2 → 0.1.4
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 +4 -2
- package/dist/grill-mcp.js +34 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ codex mcp add grill -- npx -y grill-mcp --vault "/path/to/your/vault"
|
|
|
13
13
|
|
|
14
14
|
Any other MCP client runs the same command, `npx -y grill-mcp --vault <path>`, over stdio. It requires Node.js 18 or later.
|
|
15
15
|
|
|
16
|
-
Without `--vault`, grill-mcp uses the vault it is started in, including from one of the vault's subfolders, or the folder named by the `GRILL_VAULT` environment variable. `--dir <path>` keeps a record in
|
|
16
|
+
Without `--vault`, grill-mcp uses the vault it is started in, including from one of the vault's subfolders, or the folder named by the `GRILL_VAULT` environment variable. `--dir <path>` keeps a record in that folder instead.
|
|
17
17
|
|
|
18
18
|
## Tools
|
|
19
19
|
|
|
@@ -45,7 +45,9 @@ grill-mcp never writes to the record files themselves, since the plugin may hold
|
|
|
45
45
|
|
|
46
46
|
## Outside a vault
|
|
47
47
|
|
|
48
|
-
Run
|
|
48
|
+
Run outside an Obsidian vault, for instance in a code repository, grill-mcp keeps the record in `~/.grill/record/` (or the folder `GRILL_HOME` names), never in the project itself. There is one record for the person across all their projects. Each concept is named by its project (`cors/lib/index.js`), and each project's reads show only its own. A project that already has a `.grill/` folder, or a `--dir`, keeps a record of its own instead.
|
|
49
|
+
|
|
50
|
+
Answers are written one at a time, and a readable log of each day's questions and answers is kept in the record's `Sessions/` folder. A record file that cannot be read is reported as an error and never written over.
|
|
49
51
|
|
|
50
52
|
## Privacy
|
|
51
53
|
|