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
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。