README file from
GithubMemVault for Obsidian
Connect Obsidian to MemVault — a local-first, self-hosted memory store for AI agents.
Browse, search, and capture the memories your agents have accumulated (preferences, facts, MUST rules, reaction skills) without leaving your vault, and keep a folder of Markdown notes synced from the server.
Prerequisites
- A running MemVault REST backend. The managed setup is one command:
memvault-cli dashboard(defaulthttp://127.0.0.1:3777). - Optional: a MemVault API key if your server has auth enabled.
The plugin is desktop-only: its default server address is loopback, so Obsidian on a phone cannot reach a backend running on your computer.
Install
Install MemVault from the Obsidian community plugins directory (Settings → Community plugins → Browse), or see Manual / BRAT installation below.
Features
Memory panel
Open MemVault: Open Memory Panel to browse saved memories grouped by priority
(MUST / REFERENCE / BACKGROUND), search by keyword, and delete memories.
Capture from the editor
Save Selection as Memory— capture the current selection as a reference memorySave Selection as MUST Rule— capture the current selection as an instruction the agent must always followSearch and Insert Memory— search the store and insert a memory into the current noteExtract memories from selection— run rule-based extraction and send drafts to the review inbox
Folder sync
Sync Memories to Vault keeps the folder configured under Sync folder
(default MemVault) in sync with the server: one Markdown note per memory.
Turn on Delete orphaned notes on sync to trash notes whose memory was removed
on the server — off by default so manual edits are never silently lost.
Setup
- Start the backend:
memvault-cli dashboard. - Install the plugin and open Settings → MemVault.
- Leave Server URL at the default
http://127.0.0.1:3777, or click Detect server. Detection probes3777first, then the legacy8080port, and accepts only a/api/healthresponse that identifiesmemvault-mcp. - If needed, set API key, Sync folder, and Refresh interval.
If the panel shows a connection error, start the backend and press Retry; the exact recovery command is shown in the panel.
Manual / BRAT installation
Install from a GitHub release by downloading main.js, manifest.json, and
styles.css into <vault>/.obsidian/plugins/memvault/, or use
BRAT.
Development
npm ci
npm run build # esbuild → out/main.js
npm run typecheck
npm test
The plugin source is mirrored in the MemVault monorepo
under obsidian-plugin/ — that directory is the source of truth for code. This
repository is the release repo and owns its README, packaging, and release
metadata.
License
MIT