obsidian-vault-mcp
Enables Claude to read and write notes in an Obsidian vault through Obsidian Sync, with tools for reading, writing, appending, patching, and searching.
README
obsidian-vault-mcp
MCP server + Obsidian Sync in one container. It keeps a live local copy of your Obsidian vault (via the official obsidian-headless sync client) and exposes it over MCP Streamable HTTP with bearer-token auth, so Claude can read and write your notes from any device: web, mobile, or desktop. Edits made by Claude sync back to all your devices through Obsidian Sync.
Claude (any device) --HTTPS--> obsidian-vault-mcp --/vault--> ob sync --continuous <--> Obsidian Sync <--> your devices
Requires an Obsidian Sync subscription. Not affiliated with Obsidian or Anthropic.
Quick start (Docker)
docker run -d --name obsidian-vault-mcp \
-p 3000:3000 \
-v /path/to/appdata/vault:/vault \
-v /path/to/appdata/data:/data \
-e OBSIDIAN_EMAIL=you@example.com \
-e OBSIDIAN_PASSWORD='...' \
-e OBSIDIAN_TOTP_SECRET='BASE32SECRET' \
-e OBSIDIAN_VAULT='My Vault' \
--restart unless-stopped \
ghcr.io/jakergirard/obsidian-vault-mcp:latest
Watch the log on first start: it installs obsidian-headless, logs in, pulls the vault, prints the generated MCP bearer token, then serves MCP at http://<host>:3000/mcp.
Prefer not to put credentials in env vars? Leave OBSIDIAN_EMAIL/OBSIDIAN_PASSWORD unset and run the interactive login once instead; the session persists in /data:
docker exec -it obsidian-vault-mcp ob login
Unraid
A Community Applications template lives in unraid/obsidian-vault-mcp.xml. Until it is listed in CA, add this repo as a template repository: Docker > Template Repositories > add https://github.com/jakergirard/obsidian-vault-mcp, then add the container from the template.
Environment variables
| Variable | Required | Default | Description |
|---|---|---|---|
OBSIDIAN_EMAIL |
no | Obsidian account email. Omit to use docker exec -it <name> ob login instead. |
|
OBSIDIAN_PASSWORD |
no | Obsidian account password. | |
OBSIDIAN_TOTP_SECRET |
no | Base32 TOTP secret if 2FA is enabled (the secret itself, not a 6-digit code). | |
OBSIDIAN_VAULT |
yes | Remote vault name, exactly as shown in Obsidian Sync (ob sync-list-remote lists them). |
|
MCP_TOKEN |
no | auto | Bearer token clients must send. Auto-generated, printed in the log, and saved to /data/mcp_token if unset. |
PORT |
no | 3000 |
MCP server port. |
READ_ONLY |
no | false |
true disables the write tools. |
OBSIDIAN_HEADLESS_VERSION |
no | latest |
Pin the obsidian-headless version installed on first start. |
Volumes: /vault (the synced vault) and /data (Obsidian Sync session, obsidian-headless install, generated token). Both should be persistent.
Exposing it to Claude
Important: Claude web and mobile connectors originate from Anthropic's cloud, not from your device. A LAN or Tailscale IP is not reachable from there. Pick one:
- Tailscale Funnel (recommended if you run Tailscale): on the Docker host,
tailscale funnel --bg 3000. You gethttps://<host>.<tailnet>.ts.netwith TLS, and nothing else on your network is exposed. Requires HTTPS certs and thefunnelnode attribute enabled in your tailnet policy. - Cloudflare Tunnel: point a
cloudflaredtunnel athttp://<host>:3000on a hostname you own. - Reverse proxy: any HTTPS reverse proxy (Nginx Proxy Manager, Caddy, Traefik) forwarding to port 3000.
- LAN / tailnet only: no public exposure, but then only clients that connect from your own machines work, e.g. Claude Desktop or Claude Code pointed at
http://<tailscale-ip>:3000/mcp. Claude web and mobile will not work in this mode.
Connecting Claude
- Claude
Settings>Connectors>Add custom connector - URL:
https://<your-public-hostname>/mcp - Request headers:
Authorization: Bearer <your token>(token is in the container log or/data/mcp_token) - Enable the connector in a chat and ask Claude to list your vault
Tools
| Tool | Description |
|---|---|
read_note |
Read a file (vault-relative path). |
write_note |
Create or overwrite a file. |
append_note |
Append to a file (created if missing). |
patch_note |
Replace an exact, unique string in a file. |
list_dir |
List a directory. |
search |
Case-insensitive fixed-string search via ripgrep. |
All paths are jailed to /vault.
Security notes
- Anyone with the URL and the bearer token can read and write your entire vault. Treat the token like a password; rotate it by changing
MCP_TOKEN(or deleting/data/mcp_token) and restarting. - Only expose the server over HTTPS (all three public recipes above provide it).
READ_ONLY=trueif you only want Claude reading notes.- Vault contents may include sensitive material; think before exposing.
Why isn't obsidian-headless in the image?
The obsidian-headless npm package is published as UNLICENSED, which does not grant redistribution rights, so this image does not bundle it. The entrypoint installs it from npm on first start (into /data, so it persists across container updates). The CLI surface (ob login, ob sync-setup, ob sync --continuous) may change upstream; pin OBSIDIAN_HEADLESS_VERSION if a new release breaks something, and file an issue.
License
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
E2B
Using MCP to run code via e2b.
Neon Database
MCP server for interacting with Neon Management API and databases
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.