@danielmarbach/mnemonic-mcp 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to `mnemonic` will be documented in this file.
+
+The format is loosely based on Keep a Changelog and uses semver-style version headings.
+
+## [0.1.0] - 2026-03-08
+
+First public release candidate.
+
+### Added
+
+- Plain markdown + JSON storage with git-backed main and project vaults.
+- MCP tools for capture, recall, relationships, consolidation, project identity, policies, migrations, and vault operations.
+- Project-scoped memory routing with separate storage location and project association semantics.
+- Structured MCP responses for tool consumers.
+- Migration framework with per-vault schema versioning and `v0.1.0-backfill-memory-versions`.
+- CI-safe MCP integration tests plus unit coverage for storage, vault routing, and migration behavior.
+
+### Changed
+
+- `move_memory` now rewrites project metadata when moving into a project vault and preserves project association when moving to the main vault.
+- Migration execution now serializes per vault to avoid concurrent atomic-write collisions.
+- Legacy notes normalize missing or invalid `memoryVersion` values to `0` when read.
+- Vault search order now stays focused on the current project vault plus main vault fallback.
+
+### Fixed
+
+- Malformed markdown files without frontmatter are no longer treated as valid notes.
+- Explicit migration runs now persist schema version updates correctly.
+- Recent stale migration, storage, and vault tests were reconciled with the actual runtime invariants.
+
+### Caveats
+
+- This is still an early release. Storage format, migration flow, and some MCP ergonomics may continue to evolve.
+- Existing vaults should be considered migratable rather than permanently stable at this stage.
+- Ollama is required locally for embeddings; CI uses a fake embeddings endpoint for hermetic tests.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,395 @@
+# mnemonic
+
+A local MCP memory server backed by plain markdown files, synced via git. No database. Project-scoped memory with semantic search.
+
+For the high-level system map, see [`ARCHITECTURE.md`](ARCHITECTURE.md). For release notes, see [`CHANGELOG.md`](CHANGELOG.md).
+
+## Why mnemonic
+
+- 🧠 Your MCP client remembers decisions, fixes, and context across sessions — no re-explaining the same project.
+- 📁 Memories are plain markdown with YAML frontmatter: readable, diffable, mergeable, and easy to back up.
+- 🚫 No database or always-on service: just files, git, and a local Node process.
+- 🎯 Project-scoped recall surfaces the right repo context first while keeping global memories accessible.
+- 🤝 Shared `.mnemonic/` notes travel with the repository, so project knowledge isn't trapped in one person's chat history.
+- 🔒 Embeddings stay local and gitignored — semantic search without committing generated vector data.
+
+## Stability
+
+mnemonic is at the inception stage. The storage format (frontmatter schema, vault layout, config structure) is still stabilizing and **may change in breaking ways** between releases. Migrations are provided when possible, but treat your vault as something you can afford to rebuild or re-migrate during this period. Keep an eye on the changelog; mnemonic surfaces pending migrations at startup and `list_migrations` shows pending work per vault after each update.
+
+**Scale:** Designed for simplicity and portability — not large-scale knowledge bases.
+
+- Hundreds to low thousands of notes: excellent fit.
+- Several thousand: often fine, depending on note size, machine speed, and embedding throughput.
+- Very large collections: expect pain points around reindex time, recall latency, and git churn.
+- Many concurrent writers or massive scale: consider a dedicated database and indexing layer instead.
+
+## Prerequisites
+
+[Ollama](https://ollama.com) must be running locally with an embedding model pulled:
+
+```bash
+ollama pull nomic-embed-text-v2-moe
+```
+
+`qwen3-embedding:0.6b` is an alternative with a larger context window for longer notes:
+
+```bash
+ollama pull qwen3-embedding:0.6b
+```
+
+No code changes required — set `EMBED_MODEL=qwen3-embedding:0.6b` in your environment or MCP config.
+
+## Setup
+
+### Native (Node.js 18+)
+
+```bash
+npm install
+npm run build
+npm test
+```
+
+`npm run build` already runs `typecheck`, but running it explicitly first gives a faster failure loop when iterating on the codebase.
+
+For local dogfooding, start the built MCP server with:
+
+```bash
+npm run mcp:local
+```
+
+This rebuilds first, then launches `build/index.js`, so MCP clients always point at the latest source.
+
+### Docker
+
+```bash
+docker compose build
+docker compose up ollama-init  # pulls nomic-embed-text-v2-moe into the ollama volume (one-time)
+```
+
+Ollama runs as a container with a named volume (`ollama-data`) so downloaded models persist across restarts. The vault directory (`~/mnemonic-vault` by default) is bind-mounted from the host. Git credentials (`~/.gitconfig` and `~/.ssh`) are mounted read-only so push/pull work inside the container.
+
+Override the vault location:
+
+```bash
+VAULT_PATH=/path/to/your-vault docker compose run --rm mnemonic
+```
+
+## Installing from GitHub Packages
+
+Staging builds are published to GitHub Packages under the `staging` dist-tag. To install outside GitHub Actions, you need a GitHub token with at least the `read:packages` scope.
+
+Create an `.npmrc` in the consuming project (or your home directory):
+
+```ini
+@danielmarbach:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
+```
+
+Then install:
+
+```bash
+# Latest staging build
+npm install @danielmarbach/mnemonic-mcp@staging
+
+# Specific prerelease
+npm install @danielmarbach/mnemonic-mcp@0.1.0-staging.12
+
+# Stable release
+npm install @danielmarbach/mnemonic-mcp@0.1.0
+```
+
+## MCP client config
+
+### Claude Desktop / Cursor (native)
+
+```json
+{
+  "mcpServers": {
+    "mnemonic": {
+      "command": "npx",
+      "args": ["@danielmarbach/mnemonic-mcp@staging"],
+      "env": {
+        "VAULT_PATH": "/Users/you/mnemonic-vault"
+      }
+    }
+  }
+}
+```
+
+For a fixed installed version, point at the local binary instead:
+
+```json
+{
+  "mcpServers": {
+    "mnemonic": {
+      "command": "/path/to/your/project/node_modules/.bin/mnemonic",
+      "env": {
+        "VAULT_PATH": "/Users/you/mnemonic-vault"
+      }
+    }
+  }
+}
+```
+
+### Claude Desktop / Cursor (Docker)
+
+```json
+{
+  "mcpServers": {
+    "mnemonic": {
+      "command": "docker",
+      "args": ["compose", "-f", "/path/to/mnemonic/compose.yaml", "run", "--rm", "mnemonic"],
+      "env": {
+        "VAULT_PATH": "/Users/you/mnemonic-vault"
+      }
+    }
+  }
+}
+```
+
+> Ollama must be running before the MCP client invokes mnemonic. Start it once with `docker compose up ollama -d` and it will stay up between calls.
+
+For local development against this repository's source tree, use `npm run mcp:local` or point your MCP client at `scripts/mcp-local.sh`.
+
+## Configuration
+
+| Variable      | Default                   | Description                      |
+|---------------|---------------------------|----------------------------------|
+| `VAULT_PATH`  | `~/mnemonic-vault`        | Path to your markdown vault      |
+| `OLLAMA_URL`  | `http://localhost:11434`  | Ollama server URL                |
+| `EMBED_MODEL` | `nomic-embed-text-v2-moe` | Ollama embedding model           |
+| `DISABLE_GIT` | `false`                   | Set `true` to skip all git ops   |
+
+## How it works
+
+### Vault layout
+
+Two vault types store notes:
+
+**Main vault** — private global memories at `~/mnemonic-vault` (its own git repo):
+
+```
+~/mnemonic-vault/
+  .gitignore             ← auto-created, gitignores embeddings/
+  notes/
+    setup-notes-a1b2c3.md
+  embeddings/            ← local only, never committed
+    setup-notes-a1b2c3.json
+```
+
+**Project vault** — project-specific memories committed into the project repo:
+
+```
+<git-root>/
+  .mnemonic/
+    .gitignore           ← auto-created, gitignores embeddings/
+    notes/
+      auth-bug-fix-d4e5f6.md
+    embeddings/          ← local only, never committed
+      auth-bug-fix-d4e5f6.json
+```
+
+### Routing
+
+`cwd` sets project context; `scope` picks storage:
+
+- `cwd` + `scope: "project"` *(default when `cwd` is present)* → project vault (`.mnemonic/`)
+- `cwd` + `scope: "global"` → main vault, with project association in frontmatter
+- no `cwd` → main vault as a plain global memory
+
+Use `set_project_memory_policy` to save a per-project default. Supported values: `project`, `global`, `ask`. When policy is `ask`, `remember` returns a clear choice instead of guessing.
+
+### Project identity
+
+Project identity derives from the **git remote URL**, normalized to a stable slug (e.g. `github-com-acme-myapp`). The same project is recognized consistently across machines regardless of local clone paths. The default remote is `origin`; use `set_project_identity` to switch to `upstream` for fork workflows. If no remote exists, the git root folder name is used; if not in a git repo, the directory name.
+
+### Recall
+
+`recall` with `cwd` searches both vaults. Project notes get a **+0.15 similarity boost** — a soft signal, not a hard filter — so global memories remain accessible while project context floats to the top.
+
+The `scope` parameter on `recall` narrows results:
+
+- `"all"` *(default)* — project memories boosted, then global
+- `"project"` — only memories for the detected project
+- `"global"` — only memories with no project association
+
+### Note lifecycle
+
+Each note carries a `lifecycle`:
+
+- `"permanent"` *(default)* — durable knowledge for future sessions
+- `"temporary"` — working-state scaffolding (plans, WIP checkpoints) that can be cleaned up once consolidated
+
+### Note format
+
+Notes are standard markdown with YAML frontmatter:
+
+```markdown
+---
+title: Auth bug fix approach
+tags: [auth, bugfix]
+project: github-com-acme-myapp
+projectName: myapp
+createdAt: 2026-03-07T10:00:00.000Z
+updatedAt: 2026-03-07T10:00:00.000Z
+---
+
+We fixed the JWT expiry issue by switching to RS256 and...
+```
+
+Content is markdown-linted on `remember`/`update`: fixable issues are auto-corrected before save; non-fixable issues are rejected.
+
+### Embeddings and migrations
+
+Embeddings are generated by Ollama's `/api/embed` with truncation enabled, stored as local JSON alongside notes, and gitignored. `sync` backfills missing embeddings on every run; `sync { force: true }` rebuilds all.
+
+Each vault has its own `config.json` with a `schemaVersion`, so main and project vaults migrate independently:
+
+- `list_migrations` reports schema version and pending migrations per vault.
+- Startup warns when a vault is behind schema, but does not auto-migrate.
+- `execute_migration` supports dry-run to preview changes before applying.
+- Failed migration runs roll staged note writes back instead of leaving partial edits.
+- Metadata-only migrations do not re-embed automatically; re-embedding happens on title/content change or during `sync` backfill.
+
+The main vault `config.json` also controls mutation push behavior:
+
+- `mutationPushMode: "main-only"` *(default)* - auto-push main-vault mutations, but leave project-vault commits local until the user pushes or runs `sync`
+- `mutationPushMode: "all"` - auto-push mutating writes in both vault types
+- `mutationPushMode: "none"` - never auto-push mutating writes; use `sync` or manual git commands instead
+
+This keeps unpublished project branches from failing on `remember`/`update`, while still letting the main vault stay in sync by default.
+
+## CLI commands
+
+mnemonic ships CLI commands in addition to the MCP server.
+
+### `mnemonic migrate`
+
+Apply pending schema migrations to your vaults. Always preview with `--dry-run` first.
+
+```bash
+# Preview what would change
+mnemonic migrate --dry-run
+
+# Apply and auto-commit
+mnemonic migrate
+
+# Limit to one project vault
+mnemonic migrate --dry-run --cwd=/path/to/project
+mnemonic migrate --cwd=/path/to/project
+
+# List available migrations and pending count
+mnemonic migrate --list
+```
+
+### `mnemonic import-claude-memory`
+
+Import [Claude Code auto-memory](https://docs.anthropic.com/en/docs/claude-code/memory) into your vault. Claude Code stores per-project auto-memory at `~/.claude/projects/<encoded-path>/memory/*.md`. Each `##` heading becomes a separate mnemonic note tagged with `claude-memory` and `imported`. Notes whose titles already exist in the vault are skipped, so the command is safe to re-run.
+
+```bash
+# Preview what would be imported
+mnemonic import-claude-memory --dry-run
+
+# Import from the current directory's Claude memory
+mnemonic import-claude-memory
+
+# Import for a specific project path
+mnemonic import-claude-memory --cwd=/path/to/project
+
+# Use a non-default Claude home
+mnemonic import-claude-memory --claude-home=/custom/.claude
+```
+
+Imported notes are written to the main vault with `lifecycle: permanent` and `scope: global`. After importing, run `sync` to embed them and push to your remote.
+
+## Tools
+
+| Tool                        | Description                                                              |
+|-----------------------------|--------------------------------------------------------------------------|
+| `consolidate`               | Merge multiple notes into one with relationship to sources               |
+| `detect_project`            | Resolve `cwd` to stable project id via git remote URL                   |
+| `execute_migration`         | Execute a named migration (supports dry-run)                             |
+| `forget`                    | Delete note + embedding, git commit + push, cleanup relationships        |
+| `get`                       | Fetch one or more notes by exact id                                      |
+| `get_project_identity`      | Show effective project identity and remote override                      |
+| `get_project_memory_policy` | Show saved default write scope                                           |
+| `list`                      | List notes filtered by scope/tags/storage                                |
+| `list_migrations`           | List available migrations and pending count                              |
+| `memory_graph`              | Show compact adjacency list of relationships                             |
+| `move_memory`               | Move note between vaults without changing id                             |
+| `project_memory_summary`    | Summarize what mnemonic knows about a project                            |
+| `recall`                    | Semantic search with optional project boost                              |
+| `recent_memories`           | Show most recently updated notes for scope                               |
+| `remember`                  | Write note + embedding; `cwd` sets context, `scope` picks storage, `lifecycle` picks temporary vs permanent |
+| `relate`                    | Create typed relationship between notes (bidirectional)                  |
+| `set_project_identity`      | Save which git remote defines project identity                           |
+| `set_project_memory_policy` | Save default write scope for project (`project`, `global`, `ask`)       |
+| `sync`                      | Git sync when remote exists plus embedding backfill always; `force=true` rebuilds all embeddings |
+| `unrelate`                  | Remove relationship between notes                                        |
+| `update`                    | Update note content/title/tags/lifecycle, re-embeds always               |
+| `where_is_memory`           | Show note's project association and storage location                     |
+
+### Relationships
+
+Notes can be linked with typed edges stored in frontmatter:
+
+```yaml
+relatedTo:
+  - id: auth-bug-fix-a1b2c3d4
+    type: related-to
+  - id: security-policy-b5c6d7e8
+    type: explains
+```
+
+| Type         | Meaning                                  |
+|--------------|------------------------------------------|
+| `related-to` | Generic association (default)            |
+| `explains`   | `fromId` explains `toId`                 |
+| `example-of` | `fromId` is a concrete example of `toId` |
+| `supersedes` | `fromId` is the newer version of `toId`  |
+
+`relate` is bidirectional by default. `forget` automatically removes any edges pointing at the deleted note.
+
+## Multi-machine workflow
+
+**Main vault:**
+
+```bash
+# First time on a new machine:
+git clone git@github.com:you/mnemonic-vault.git ~/mnemonic-vault
+# Then ask Claude to run `sync` — it pulls, pushes, and backfills embeddings in one step.
+```
+
+**Project vault:**
+
+```bash
+# Already in the project repo — clone the project as normal.
+# The .mnemonic/ directory comes along with it.
+# Ask Claude to run `sync` with the project cwd to pull/push and backfill embeddings.
+```
+
+After the first sync, call `sync` (with `cwd` for project vaults) whenever you switch machines. It handles pull, push, and embeddings in one shot.
+
+## FAQ
+
+**Are mnemonic's embeddings the same as what Claude uses?**
+
+No. The embeddings here are **local vector representations** generated by Ollama on your machine — nothing is sent to Anthropic or any cloud service. They are produced by a small embedding model (`nomic-embed-text-v2-moe` by default) and stored as plain JSON files. This is the same idea as retrieval-augmented generation (RAG): each note is converted to a dense numeric vector so `recall` can find semantically related notes even when you don't remember the exact words you used. It has nothing to do with how Claude processes tokens internally.
+
+**Why do project memories appear first in `recall` results even when global memories are more similar?**
+
+When you call `recall` with `cwd`, mnemonic adds a fixed **+0.15 boost** to the cosine similarity score of every note belonging to the detected project. This is a soft boost, not a hard filter — global memories are still included when relevant. The boost ensures project-specific context floats to the top when you're working inside a repo while cross-project knowledge remains accessible further down the list.
+
+## Repository layout
+
+```
+src/       TypeScript runtime code
+tests/     Vitest test files
+build/     Compiled JavaScript output
+.mnemonic/ Project-scoped memories for this repo
+```
+
+## Agent instructions
+
+See [`SYSTEM_PROMPT.md`](SYSTEM_PROMPT.md) for the system prompt to use with your MCP client.

package/build/config.d.ts

@@ -0,0 +1,34 @@
+import type { ProjectMemoryPolicy } from "./project-memory-policy.js";
+import type { ProjectIdentityOverride } from "./project.js";
+export type MutationPushMode = "all" | "main-only" | "none";
+export interface MnemonicConfig {
+    schemaVersion: string;
+    reindexEmbedConcurrency: number;
+    mutationPushMode: MutationPushMode;
+    projectMemoryPolicies: Record<string, ProjectMemoryPolicy>;
+    projectIdentityOverrides: Record<string, ProjectIdentityOverride>;
+}
+/**
+ * Read the schema version from a vault's config.json.
+ * Works for both main vault and project vaults.
+ * Returns the default schema version if no config exists.
+ */
+export declare function readVaultSchemaVersion(vaultPath: string): Promise<string>;
+/**
+ * Write the schema version to a vault's config.json.
+ * Preserves any existing fields in the file.
+ */
+export declare function writeVaultSchemaVersion(vaultPath: string, schemaVersion: string): Promise<void>;
+export declare class MnemonicConfigStore {
+    readonly filePath: string;
+    constructor(mainVaultPath: string);
+    load(): Promise<MnemonicConfig>;
+    getProjectPolicy(projectId: string): Promise<ProjectMemoryPolicy | undefined>;
+    getProjectIdentityOverride(projectId: string): Promise<ProjectIdentityOverride | undefined>;
+    setProjectPolicy(policy: ProjectMemoryPolicy): Promise<void>;
+    setProjectIdentityOverride(projectId: string, override: ProjectIdentityOverride): Promise<void>;
+    setSchemaVersion(schemaVersion: string): Promise<void>;
+    private readAll;
+    private writeAll;
+}
+//# sourceMappingURL=config.d.ts.map

package/build/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAE5D,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,WAAW,GAAG,MAAM,CAAC;AAE5D,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,uBAAuB,EAAE,MAAM,CAAC;IAChC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC3D,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;CACnE;AAmED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAS/E;AAED;;;GAGG;AACH,wBAAsB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAWrG;AAED,qBAAa,mBAAmB;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAEd,aAAa,EAAE,MAAM;IAI3B,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC;IAI/B,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAK7E,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;IAK3F,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5D,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/F,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAM9C,OAAO;YAgBP,QAAQ;CAGvB"}