vault-cortex 0.10.4 → 0.10.6

package/README.md

@@ -49,9 +49,9 @@ What it does:
    - **Remote** — a VPS with [Obsidian Sync](https://obsidian.md/sync),
      reachable from any device
 2. Offers the most common optional settings — memory layer and folder,
-   daily notes folder and format, file tools, semantic search, port,
-   timezone (plus sync direction for remote) — press enter to keep the
-   defaults, or pick the ones you want to change
+   daily notes folder and format, file tools, read-only mode, semantic
+   search, port, timezone (plus sync direction for remote) — press enter
+   to keep the defaults, or pick the ones you want to change
 3. Generates a `.env` file with a securely generated `MCP_AUTH_TOKEN`
 4. Optionally starts the container and waits for the health check
 5. Prints your connection details — the MCP URL, your auth token, and how to

package/dist/env.js

@@ -58,6 +58,15 @@ MEMORY_ENABLED=true
 # Enable or disable file tools — vault_read_file and vault_list_files (default: true).
 # Set to false when Obsidian Sync has attachment syncing disabled.
 FILE_TOOLS_ENABLED=true
+# Run the server in read-only mode (default: false).
+# Set to true to hide every tool that changes the vault — clients can only
+# read and search. The memory folder is not auto-created in this mode.
+READONLY_MODE=false
+# Hide individual tools by name, comma-separated (default: none hidden).
+# Names match the README tools table: https://github.com/aliasunder/vault-cortex#tools
+# Subtractive only — it cannot re-enable a tool another setting hides; an
+# unknown tool name stops the server at startup so typos surface immediately.
+# DISABLED_TOOLS=vault_delete_note,vault_move_note
 # Memory folder name in your vault (default: About Me).
 MEMORY_DIR=About Me
 
@@ -85,6 +94,18 @@ MEMORY_DIR=About Me
 # Host port to expose (default: 8000).
 PORT=8000
 
+# Client-IP trust for OAuth rate limiting and logs (defaults shown).
+# With nothing in front of the server, leave both untouched — each visitor
+# is identified by their own connection, and faked Forwarded/X-Forwarded-For
+# headers are ignored.
+# With a proxy or tunnel you control in front (Caddy, nginx, Cloudflare
+# Tunnel), set TRUST_PROXY_HOPS=1 so visitors are told apart by their real
+# IP — otherwise they all share one rate-limit budget.
+# Set TRUST_FORWARDED_HEADER=true only if the proxy reports each visitor's
+# IP in the RFC 7239 Forwarded header (e.g. AWS API Gateway).
+# TRUST_PROXY_HOPS=0
+# TRUST_FORWARDED_HEADER=false
+
 # Log verbosity: debug | info | warn | error (default: info).
 LOG_LEVEL=info
 
@@ -160,6 +181,15 @@ MEMORY_ENABLED=true
 # Enable or disable file tools — vault_read_file and vault_list_files (default: true).
 # Set to false when Obsidian Sync has attachment syncing disabled.
 FILE_TOOLS_ENABLED=true
+# Run the server in read-only mode (default: false).
+# Set to true to hide every tool that changes the vault — clients can only
+# read and search. The memory folder is not auto-created in this mode.
+READONLY_MODE=false
+# Hide individual tools by name, comma-separated (default: none hidden).
+# Names match the README tools table: https://github.com/aliasunder/vault-cortex#tools
+# Subtractive only — it cannot re-enable a tool another setting hides; an
+# unknown tool name stops the server at startup so typos surface immediately.
+# DISABLED_TOOLS=vault_delete_note,vault_move_note
 # Memory folder name in your vault (default: About Me).
 MEMORY_DIR=About Me
 
@@ -188,6 +218,18 @@ MEMORY_DIR=About Me
 # Host port to expose (default: 8000).
 PORT=8000
 
+# Client-IP trust for OAuth rate limiting and logs (defaults shown).
+# With nothing in front of the server, leave both untouched — each visitor
+# is identified by their own connection, and faked Forwarded/X-Forwarded-For
+# headers are ignored.
+# With a proxy or tunnel you control in front (Caddy, nginx, Cloudflare
+# Tunnel), set TRUST_PROXY_HOPS=1 so visitors are told apart by their real
+# IP — otherwise they all share one rate-limit budget.
+# Set TRUST_FORWARDED_HEADER=true only if the proxy reports each visitor's
+# IP in the RFC 7239 Forwarded header (e.g. AWS API Gateway).
+# TRUST_PROXY_HOPS=0
+# TRUST_FORWARDED_HEADER=false
+
 # Log verbosity: debug | info | warn | error (default: info).
 LOG_LEVEL=info
 

package/dist/optional-settings.js

@@ -37,6 +37,13 @@ const OPTIONAL_SETTINGS = [
         label: "File tools",
         question: "Enable file tools (read images, PDFs, and other non-Markdown files)?",
     },
+    {
+        kind: "toggle",
+        name: "READONLY_MODE",
+        label: "Read-only mode",
+        question: "Run the server in read-only mode (hide all tools that change the vault)?",
+        defaultEnabled: false,
+    },
     {
         kind: "toggle",
         name: "EMBEDDING_ENABLED",
@@ -127,11 +134,12 @@ export const derivePublicUrlOverride = (envContent, overrides) => {
     return { ...overrides, PUBLIC_URL: `http://localhost:${newPort}` };
 };
 /**
- * The .env spellings the server reads as "off" — env-var's asBool accepts
- * 0/1 alongside true/false. An absent or unrecognized value falls to the
- * server default, which is enabled for every curated toggle.
+ * True unless the .env value is an explicit "off" spelling — env-var's asBool
+ * accepts 0/1 alongside true/false. An absent or unrecognized value falls to
+ * the server default, declared per-toggle via defaultEnabled (enabled unless
+ * stated otherwise).
  */
-const isDisabledToggleValue = (value) => ["false", "0"].includes((value ?? "").toLowerCase());
+const isEnabledToggleValue = (value) => !["false", "0"].includes((value ?? "").toLowerCase());
 /**
  * Plain digits in the TCP port range. Number() coercion is not enough:
  * it accepts "1e4"/"0x1F40"/"+9000", which readEnvPort's /^PORT=(\d+)/
@@ -222,7 +230,15 @@ const askSettingValue = async (params, prompts) => {
     const { setting, currentValue } = params;
     switch (setting.kind) {
         case "toggle": {
-            const enabled = await prompts.confirm(setting.question, !isDisabledToggleValue(currentValue));
+            // An unset or empty var means the server default applies — seed the
+            // confirm from defaultEnabled, not from the enabled-unless-"false"
+            // heuristic (wrong for default-off toggles like READONLY_MODE).
+            // Empty string matters: `READONLY_MODE=` in .env is read as unset
+            // by Compose's `${VAR:-default}` and env-var's `.default()`.
+            const currentlyEnabled = !currentValue
+                ? (setting.defaultEnabled ?? true)
+                : isEnabledToggleValue(currentValue);
+            const enabled = await prompts.confirm(setting.question, currentlyEnabled);
             return String(enabled);
         }
         case "port":
@@ -258,7 +274,7 @@ export const askOptionalSettings = async (params, prompts) => {
         const currentValue = readOptionalValue(envContent, setting.name);
         const requiredToggle = OPTIONAL_SETTINGS.find((candidate) => candidate.name === setting.requiresToggle);
         const dependencyNote = requiredToggle &&
-            isDisabledToggleValue(readOptionalValue(envContent, requiredToggle.name))
+            !isEnabledToggleValue(readOptionalValue(envContent, requiredToggle.name))
             ? ` · not used while ${requiredToggle.label} is off`
             : "";
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vault-cortex",
-  "version": "0.10.4",
+  "version": "0.10.6",
   "description": "Set up a Vault Cortex MCP server for your Obsidian vault in one command: npx vault-cortex@latest init",
   "license": "MIT",
   "type": "module",