Obsidian Everywhere

English | 한국어

🧠 Obsidian Everywhere

Turn linked notes into AI context, use that context from agents anywhere, and checkpoint approved changes with Git.

*Graph context · local semantic search · remote agents · guarded edits · opt-in Git checkpoints*

Watch the Remote Vault Bridge in 44 seconds

Remote setup guide

*Remote request → semantic search → graph context → guarded edit → mount-loss recovery.*

---

Obsidian Everywhere is built around three ideas:

1. Notes are a graph and a semantic knowledge base, not a folder of text files. Backlinks, n-hop neighborhoods, shortest paths, PageRank, full-text search, and local multilingual embeddings turn a topic into focused, token-budgeted context.
2. Your vault should be usable where your agents run. The Remote Vault Bridge exposes that same graph and its guarded write tools over authenticated Streamable HTTP. A Claude Code or Codex process on another server can search, reason over, append to, and reorganize a vault that remains on your own machine.
3. Version-control actions deserve a narrower boundary than file writes. If the vault or one configured folder inside it is already a Git repository, the opt-in Git tools can inspect status, bounded diffs, and local history. Commit and push each require a preview, explicit confirmation, and a short-lived one-use approval ID.

The local path stays the source of truth. Obsidian Everywhere does not create a hosted copy, telemetry service, or mandatory cloud account; optional Git push publishes only to a repository the operator already configured. Remote access is a transport you operate, not a vault-sync product.

Contents

• Watch the Remote Vault Bridge in 44 seconds
• Features
• Three core workflows
• Vault Git
• Try it without your vault
• Why Obsidian Everywhere?
• Where does this actually run?
• Quickstart
• Configuration
• Development
• Project status
• Contributing
• License

Features

vault (.md files)

│ parse · watch ▼ SQLite index (FTS5) ⇄ in-memory graph (graphology) │ n-hop · shortest path · PageRank ▼ 41 core MCP tools + 0–5 opt-in Git tools │ ▼ local stdio · authenticated remote HTTP · OAuth HTTP

• 🧩 Graph + semantic context engine — a markdown parser (wikilinks, embeds, frontmatter, nested tags, headings, block references), a SQLite index with full-text search, and an in-memory graphology layer for n-hop traversal, shortest paths, and PageRank. get_context_bundle packs a topic and its most useful neighbors into a requested token budget.
• 🌍 Remote Vault Bridge — agents on an external server get the same search, graph, context, and guarded editing tools over authenticated Streamable HTTP. Use a private network or an HTTPS tunnel such as ngrok; the vault itself stays on the machine you control.
• 📎 Vault-wide file reading — Markdown plus text/code/data files, PDF, DOCX, PPTX, XLSX, OpenDocument, EPUB, RTF, and common images are indexed and exposed without uploading them to a conversion service. Extraction is lazy, cached, size-limited, and searchable with search_files.
• 🧠 Optional local semantic search — semantic_search and get_related with method: "semantic" run a multilingual embedding model (multilingual-e5-small) entirely on your machine — no API key, cloud account, or Ollama process to run. Install the optional runtime with npm install @huggingface/transformers@^4.2.0; its model downloads once (~120MB, cached under ~/.obsidian-everywhere/), then works fully offline. It is disabled by default to keep the server below the 200 MiB memory target; opt in with OBSIDIAN_EVERYWHERE_ENABLE_SEMANTIC=true when extra memory is available.
• 🛡️ Safe writes and resilient mounts — partial edits, dry-run-first bulk operations, rollback snapshots, recoverable deletion, and an opt-in Beta mount guard. If a removable drive, NAS share, or container mount disappears, the index is preserved, writes are blocked, and a full reconciliation runs after it returns.
• 🌱 Reviewable Git checkpoints (off by default) — inspect status, bounded diffs, and local history for the vault or one configured repository folder. Higher modes add selected-file commits and operator-pinned HTTPS pushes, both behind preview and a five-minute one-use approval.
• 🛠️ 41 core MCP tools, up to 46 when Git is explicitly enabled — structured reads, attachment extraction, graph navigation, semantic retrieval, safe lifecycle operations, persisted Obsidian settings, and explicit health reporting.

Three core workflows

1. Turn a linked vault into focused AI context

Exact search finds the words you wrote. Semantic search finds the idea even when the wording or language differs. Graph traversal then explains how the matching notes relate. get_context_bundle combines those signals into a bounded context package instead of dumping an entire vault into the model.

2. Use and edit that context from an external server

Run Obsidian Everywhere beside the local vault, expose its HTTP endpoint through your private network or an HTTPS tunnel, and register the URL in the remote MCP client. The remote agent can read and search the local vault, then use the same guarded tools to create, append, move, tag, or clean up notes. The server reindexes each successful write before returning, so the next remote tool call sees the change.

For the complete ngrok path, see the [Remote Vault Bridge with ngrok tutorial](docs/ngrok-remote.md).

3. Review and checkpoint vault changes with Git

When the vault or one real folder inside it contains its own .git directory, an agent can inspect the same repository state you would inspect locally, then create a commit from an explicit file list. Set OBSIDIAN_EVERYWHERE_GIT_REPO_PATH to that vault-relative folder, or leave its default . to use the vault root. Push is a separate, stricter capability: it can only publish the current HEAD to its existing upstream branch through an operator-pinned HTTPS destination. It never pulls, fetches, changes branches, constructs a free-form refspec, or accepts arbitrary Git arguments.

Start with OBSIDIAN_EVERYWHERE_GIT_MODE=read; move to commit or push only after reviewing the safety model in the [Vault Git guide](docs/git-vault.md).

Full tool list

Read

Write

Vault Git — registered only when explicitly enabled

| Tool | Minim