neuro-vault-mcp 1.7.2 → 2.0.0

package/README.md

@@ -20,38 +20,28 @@
 
 ---
 
-<details>
-<summary><b>📦 Install & MCP client config</b></summary>
-
-### Requirements
+## 🏗 How it works
 
-- Node.js 20+
-- Obsidian vault with the [Smart Connections](https://github.com/brianpetro/obsidian-smart-connections) plugin (embeddings must be generated)
-- Smart Connections data at `<vault>/.smart-env/multi/*.ajson`
-- _For vault operations (optional):_ the [Obsidian CLI](https://github.com/AlexMost/obsidian-cli) on `PATH` and Obsidian running. Pass `--no-operations` to disable, or `--obsidian-cli /path` to point at a custom binary.
+```mermaid
+flowchart LR
+    You([You]) --> AI[AI assistant]
+    AI <-->|MCP| NV[Neuro Vault]
+    NV <--> Vault[(Obsidian vault)]
+```
 
-### 1. Install
+You ask, the assistant calls Neuro Vault, Neuro Vault reads your vault — semantic search uses embeddings already in `.smart-env/`, vault operations go through the `obsidian` CLI. No database, no background processes.
 
-```bash
-npm install -g neuro-vault-mcp
-```
+For module wiring and internal data flow, see [docs/architecture/module-structure.md](./docs/architecture/module-structure.md).
 
-### 2. Configure your MCP client
+---
 
-For Claude Code (`~/.claude/settings.json` or `.claude/settings.json` in your project):
+## ⚡ Quickstart
 
-```json
-{
-  "mcpServers": {
-    "neuro-vault": {
-      "command": "neuro-vault-mcp",
-      "args": ["--vault", "/absolute/path/to/your/vault"]
-    }
-  }
-}
+```bash
+npm install -g neuro-vault-mcp
 ```
 
-For Cursor or Windsurf (`.cursor/mcp.json` / `.windsurf/mcp.json`):
+Add to your MCP client config (here: Claude Code's `~/.claude/settings.json`):
 
 ```json
 {
@@ -64,340 +54,27 @@ For Cursor or Windsurf (`.cursor/mcp.json` / `.windsurf/mcp.json`):
 }
 ```
 
-Or run without installing using `npx`:
-
-```json
-{
-  "mcpServers": {
-    "neuro-vault": {
-      "command": "npx",
-      "args": ["-y", "neuro-vault-mcp", "--vault", "/absolute/path/to/your/vault"]
-    }
-  }
-}
-```
-
-### 3. Try it
-
-Ask your assistant:
+Then ask your assistant:
 
 > "What did I write about building AI agents?"
->
-> "Find my notes on productivity systems"
->
-> "What are all my ideas related to embeddings?"
 
 On first run the embedding model downloads automatically (~40 MB). Subsequent starts are fast.
 
-</details>
-
----
-
-## 🔍 Semantic Search
-
-Find notes by meaning, not by filename. The server embeds your query with `TaylorAI/bge-micro-v2`, runs cosine similarity against the Smart Connections corpus loaded into memory at startup, and returns ranked results with optional block-level matches and semantic expansion.
-
-### Tools
-
-#### `search_notes`
-
-Search the vault by semantic similarity.
-
-```typescript
-search_notes({
-  query: string,               // short keyword query (1-4 words)
-  mode?: "quick" | "deep",     // default: "quick"
-  threshold?: number,          // override mode default (0–1)
-  expansion?: boolean,         // override mode default
-  expansion_limit?: number,    // how many top results to expand (default: 3)
-})
-```
-
-Returns `results` (ranked notes) and `blockResults` (ranked sections — scoped to matched notes in `quick` mode, all sources in `deep` mode).
-
-#### `get_similar_notes`
-
-Find notes similar to a given note path. Use this after `search_notes` finds a relevant note — it discovers related content without needing a text query.
-
-```typescript
-get_similar_notes({
-  note_path: string,  // vault-relative POSIX path, e.g. "Projects/neuro-vault.md"
-  limit?: number,     // default: 10
-  threshold?: number, // default: 0.5
-})
-```
-
-#### `find_duplicates`
-
-Find note pairs with high embedding similarity. Useful for vault maintenance: identifies notes that cover the same topic and could be merged.
-
-```typescript
-find_duplicates({
-  threshold?: number, // default: 0.9
-})
-```
-
-#### `get_stats`
-
-Report loaded corpus statistics. Returns `{ totalNotes, totalBlocks, embeddingDimension, modelKey }`.
-
-### Behavior
-
-Every search picks a mode that controls retrieval depth:
-
-| Mode    | Use when                          | Limit | Threshold | Expansion |
-| ------- | --------------------------------- | ----- | --------- | --------- |
-| `quick` | Specific question, need 1-2 notes | 3     | 0.50      | off       |
-| `deep`  | Broad topic, need an overview     | 8     | 0.35      | on        |
-
-The AI assistant picks the mode automatically based on your question, or you can pass it explicitly.
-
-- **Block-level results (deep mode)** — the server also searches by individual note sections, surfacing the exact paragraphs that match, not just the notes that contain them.
-- **Expansion (deep mode)** — after finding top results, the server uses their embeddings to discover neighboring notes that don't directly match your query but are semantically close to what you found.
-- **Automatic fallback** — when vector search returns nothing, the server retries with a lower similarity threshold (0.3). If still nothing, the assistant can fall back to its own file-search tools.
-
-### Tips for better results
-
-- Use short keyword queries (1–4 words), not full sentences.
-- Call multiple times for synonyms and translations: `"embeddings"`, then `"векторний пошук"`, then `"vector search"`.
-- Lower the threshold to `0.3` if nothing comes back.
-- Use `deep` mode for exploratory questions.
-
----
-
-## 🗂 Vault Operations
-
-> Requires the [Obsidian CLI](https://github.com/AlexMost/obsidian-cli) on `PATH` and Obsidian running. Pass `--no-operations` to disable.
-
-Read and write notes through Obsidian itself — the operations module shells out to the `obsidian` CLI, so changes are picked up by Smart Connections, sync, and any other plugin you have installed. No bypass of Obsidian's own state.
-
-### Tools
-
-#### `read_note`
-
-Read a note's contents. Provide exactly one of `name` or `path`.
-
-```typescript
-read_note({
-  name?: string,    // wikilink-style: "My Note"
-  path?: string,    // vault-relative: "Folder/My Note.md"
-})
-```
-
-Returns `{ path, content }`.
-
-#### `create_note`
-
-Create a new note. `overwrite: true` is destructive — the AI assistant will ask before passing it.
-
-```typescript
-create_note({
-  name?: string,
-  path?: string,
-  content?: string,
-  template?: string,
-  overwrite?: boolean,
-})
-```
-
-#### `edit_note`
-
-Add content to an existing note.
-
-```typescript
-edit_note({
-  name?: string,
-  path?: string,
-  content: string,
-  position: 'append' | 'prepend',
-})
-```
-
-#### `read_daily`
-
-Read today's daily note. Returns `{ path, content }`.
-
-#### `append_daily`
-
-Append content to today's daily note.
-
-```typescript
-append_daily({ content: string });
-```
-
-### Properties & Tags
-
-Inspect and modify frontmatter without paying the token cost of reading whole notes. Properties and tags are the metadata an LLM agent checks dozens of times per session — _"what's the `status` on Quarterly review?"_, _"mark this task done"_, _"how many notes tagged #mcp?"_. Short request, precise answer, no full-note reads.
-
-#### `set_property`
-
-Set a frontmatter property on a note. The YAML type is inferred from the JS value (`string` → text, `number` → number, `boolean` → checkbox, `Array` → list). For `date` / `datetime` pass `type` explicitly. List items must not contain commas (obsidian-cli limitation).
-
-```typescript
-set_property({
-  file?: string,           // wikilink-style: "My Note"
-  path?: string,           // vault-relative: "Tasks/Quarterly review.md"
-  name: string,            // property key, e.g. "status"
-  value: string | number | boolean | string[] | number[],
-  type?: 'text' | 'list' | 'number' | 'checkbox' | 'date' | 'datetime',
-})
-```
-
-Returns `{ ok: true }`. Existing properties are overwritten.
-
-#### `read_property`
-
-Read a single frontmatter property value. Use `read_note` if you need the full frontmatter or accurate type information.
-
-```typescript
-read_property({
-  file?: string,
-  path?: string,
-  name: string,
-})
-```
-
-Returns `{ value }`.
-
-#### `remove_property`
-
-Remove a frontmatter property. Idempotent — calling it on an absent property succeeds.
-
-```typescript
-remove_property({
-  file?: string,
-  path?: string,
-  name: string,
-})
-```
-
-Returns `{ ok: true }`.
-
-#### `list_properties`
-
-List all frontmatter properties used across the vault, sorted by occurrence count desc. Useful for understanding the vault's metadata ontology before calling `set_property`.
-
-Returns `[{ name, count }, ...]`.
-
-#### `list_tags`
-
-List all tags used across the vault, sorted by occurrence count desc.
-
-Returns `[{ name, count }, ...]`.
-
-#### `get_tag`
-
-Get count and (optionally) the file list for a single tag. Pass `include_files: false` for popular tags where the file list would be large.
-
-```typescript
-get_tag({
-  name: string,            // with or without leading "#"
-  include_files?: boolean, // default true
-})
-```
-
-Returns `{ name, count, files? }`.
-
----
-
-## 🏗 How it works
-
-```mermaid
-flowchart LR
-    You([You]) --> AI[AI assistant]
-    AI <-->|MCP| NV[Neuro Vault]
-    NV <--> Vault[(Obsidian vault)]
-```
-
-You ask, the assistant calls Neuro Vault, Neuro Vault reads your vault — semantic search uses embeddings already in `.smart-env/`, vault operations go through the `obsidian` CLI. No database, no background processes.
-
-For module wiring and internal data flow, see [docs/architecture/module-structure.md](./docs/architecture/module-structure.md).
+For other clients (Cursor / Windsurf / npx), see [docs/guide/installation.md](./docs/guide/installation.md).
 
 ---
 
-<details>
-<summary><b>🧭 Search routing guidance</b></summary>
-
-Tool routing and retrieval policy are related, but not the same thing.
-
-- Use **structural tools** first (your assistant's own file/path/title tools, or vault operations) for exact file, title, path, daily note, tag, property, wikilink, backlink, and link-traversal requests.
-- Use `search_notes` for fuzzy topic, concept, and semantic retrieval.
-- Use `get_similar_notes` after you already have a relevant note and want semantic expansion.
-- Treat the routing guidance as behavior, not enforcement; the server does not hard-block other tool choices.
-- Use semantic retrieval to find likely notes, then switch to structural tools when you need exact anchors.
-
-</details>
-
-<details>
-<summary><b>⚙️ Configuration</b></summary>
-
-### CLI Arguments
-
-| Argument         | Required | Default    | Description                                             |
-| ---------------- | -------- | ---------- | ------------------------------------------------------- |
-| `--vault`        | yes      | —          | Absolute path to the Obsidian vault directory           |
-| `--semantic`     | no       | `true`     | Enable semantic search module (`--no-semantic` to skip) |
-| `--operations`   | no       | `true`     | Enable vault operations module (`--no-operations`)      |
-| `--obsidian-cli` | no       | `obsidian` | Path to the `obsidian` CLI binary (override only)       |
-| `--help`         | no       | —          | Show help                                               |
-
-### Startup Behavior
-
-- Smart Connections `.ajson` files are loaded into memory once at startup.
-- The embedding model (`TaylorAI/bge-micro-v2`) is downloaded on first run and cached by `@xenova/transformers`.
-- If the vault path is missing or Smart Connections data is absent, the server exits immediately with an error.
-
-### AGENTS.md / CLAUDE.md snippet
-
-Add this to your `AGENTS.md` or `CLAUDE.md` to help the AI assistant use the vault effectively:
-
-```markdown
-## Vault search
-
-Use vault-aware tools when vault context matters.
-Do not guess about note contents when the vault can be searched.
-Follow the Neuro Vault MCP server instructions for routing between semantic search (`search_notes`, `get_similar_notes`) and operations (`read_note`, `create_note`, `edit_note`, `read_daily`, `append_daily`).
-```
-
-</details>
-
-<details>
-<summary><b>🩺 Troubleshooting</b></summary>
-
-**"Smart Connections directory does not exist"** — make sure the Smart Connections plugin has run and generated embeddings. Open Obsidian, let Smart Connections finish indexing, then restart the MCP server.
-
-**First startup is slow** — the embedding model (~40 MB) is downloading. Subsequent starts use the cached model.
-
-**Search returns nothing** — try lowering the threshold: `threshold: 0.3`. Also check that `get_stats` shows a non-zero `totalNotes`.
-
-**Vault operations fail with `CLI_NOT_FOUND` / `CLI_UNAVAILABLE`** — the `obsidian` CLI isn't on `PATH`, or Obsidian isn't running. Install the [Obsidian CLI](https://github.com/AlexMost/obsidian-cli), or pass `--obsidian-cli /absolute/path/to/obsidian`. Disable the module with `--no-operations` if you only want semantic search.
-
-</details>
-
-<details>
-<summary><b>🛠 Development</b></summary>
-
-```bash
-npm run build        # compile TypeScript to dist/
-npm run test         # run tests with vitest
-npm run lint         # ESLint
-npm run format       # check formatting with Prettier
-npm run format:write # fix formatting
-```
-
-</details>
+## 📚 Documentation
 
-<details>
-<summary><b>🚧 Limitations</b></summary>
+User guide lives in [`docs/guide/`](./docs/guide/README.md):
 
-- Requires Smart Connections `.ajson` files already present in the vault.
-- In-memory search only — no persistent index, no background re-indexing.
-- stdio transport only — not HTTP or SSE.
-- Local vault path only — no remote vaults.
-- Embedding model loaded at startup; first run can be slow.
-- Operations tools require the Obsidian CLI and a running Obsidian instance — they fail gracefully per call when unavailable.
+- [Installation](./docs/guide/installation.md)
+- [Semantic Search](./docs/guide/semantic-search.md) — `search_notes`, `get_similar_notes`, `find_duplicates`, `get_stats`
+- [Vault Operations](./docs/guide/vault-operations.md) — note CRUD, daily notes, properties, tags
+- [Routing Between Tools](./docs/guide/routing.md)
+- [Configuration](./docs/guide/configuration.md) — CLI args, troubleshooting, limitations, **migration to 2.0**, development
 
-</details>
+Architecture / internals: [`docs/architecture/`](./docs/architecture/).
 
 ---
 

package/dist/cli.d.ts

@@ -67,11 +67,9 @@ interface SearchNotesInput {
     mode?: SearchMode;
     limit?: number;
     threshold?: number;
-    expansion?: boolean;
-    expansion_limit?: number;
 }
 interface GetSimilarNotesInput {
-    note_path: string;
+    path: string;
     limit?: number;
     threshold?: number;
 }
@@ -126,14 +124,6 @@ type NoteIdentifier = {
     kind: 'path';
     value: string;
 };
-interface ReadNoteInput {
-    identifier: NoteIdentifier;
-}
-interface ReadNoteResult {
-    path: string;
-    frontmatter: Record<string, unknown> | null;
-    content: string;
-}
 interface CreateNoteInput {
     name?: string;
     path?: string;
@@ -195,7 +185,6 @@ interface GetTagResult {
     files?: string[];
 }
 interface VaultProvider {
-    readNote(input: ReadNoteInput): Promise<ReadNoteResult>;
     createNote(input: CreateNoteInput): Promise<CreateNoteResult>;
     editNote(input: EditNoteInput): Promise<void>;
     readDaily(): Promise<DailyNoteResult>;
@@ -221,8 +210,33 @@ interface ObsidianCLIProviderOptions {
     exec?: ExecFn;
 }
 
+type ReadNotesField = 'frontmatter' | 'content';
+interface ReadNotesItemSuccess {
+    path: string;
+    frontmatter: Record<string, unknown> | null;
+    content: string;
+}
+interface ReadNotesItemError {
+    path: string;
+    error: {
+        code: 'NOT_FOUND' | 'INVALID_ARGUMENT' | 'READ_FAILED';
+        message: string;
+    };
+}
+type ReadNotesItem = ReadNotesItemSuccess | ReadNotesItemError;
+interface ReadNotesInput {
+    paths: string[];
+    fields: ReadNotesField[];
+}
+interface VaultReader {
+    readNotes(input: ReadNotesInput): Promise<ReadNotesItem[]>;
+}
+
 interface OperationsModuleDeps {
     vaultProviderFactory?: (opts: ObsidianCLIProviderOptions) => VaultProvider;
+    vaultReaderFactory?: (opts: {
+        vaultRoot: string;
+    }) => VaultReader;
 }
 
 type ToolServer = Pick<McpServer, 'registerTool' | 'connect'>;