Skip to main content
Glama
jakergirard

obsidian-vault-mcp

by jakergirard

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 access token, then serves MCP at http://<host>:3000/t/<token>/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.

Related MCP server: obsidian-mcp

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 (not the vault encryption password).

OBSIDIAN_VAULT_PASSWORD

e2ee vaults

Vault end-to-end encryption password, set when the remote vault was created. Required if the vault uses e2ee; leave unset for standard encryption.

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

Access token; clients connect at /t/<token>/mcp. 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:

  1. Tailscale Funnel (recommended if you run Tailscale): on the Docker host, tailscale funnel --bg 3000. You get https://<host>.<tailnet>.ts.net with TLS, and nothing else on your network is exposed. Requires HTTPS certs and the funnel node attribute enabled in your tailnet policy.

  2. Cloudflare Tunnel: point a cloudflared tunnel at http://<host>:3000 on a hostname you own. On Unraid: run the cloudflared container from Community Applications with a remotely-managed tunnel token, then add a public hostname in Zero Trust with service http://<unraid-ip>:3000.

  3. Reverse proxy: any HTTPS reverse proxy (Nginx Proxy Manager, Caddy, Traefik) forwarding to port 3000. No websockets needed; the server answers plain JSON. nginx-based proxies (including NPM) default to 1 MB request bodies, which fails large note writes with a 413; raise client_max_body_size to 16m to match the server limit.

  4. 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/t/<token>/mcp. Claude web and mobile will not work in this mode.

The template pre-stages the entire Tailscale config with Tailscale disabled; enabling it is one toggle:

  1. Edit the container > Use Tailscale > on

  2. Hostname, Funnel mode, port 3000, and state dir come pre-filled from the template; adjust the hostname if you want a different URL

  3. Apply, open the container log, click the To authenticate, visit... link to approve the node on your tailnet (approve Funnel if prompted)

  4. One-time, tailnet-wide: admin console > DNS > enable HTTPS Certificates (first cert issuance can take a minute and may log a few retries)

  5. Admin console > Machines > your container node > Disable key expiry, or the node silently drops off the tailnet after ~180 days

Connector URL: https://<hostname>.<tailnet>.ts.net/t/<token>/mcp

Connecting Claude

  1. Claude Settings > Connectors > Add custom connector

  2. URL: https://<your-public-hostname>/t/<your token>/mcp (token is in the container log or /data/mcp_token)

  3. Leave the OAuth fields blank

  4. Enable the connector in a chat and ask Claude to list your vault

The URL carries the token because Claude's custom connector dialog offers no header or token field, only OAuth. If that ever changes, header auth may return; for now the URL is the credential.

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

  • The URL is the credential: anyone who has it can read and write your entire vault. Treat the full URL like a password. Rotate by changing MCP_TOKEN (or deleting /data/mcp_token) and restarting; the old URL dies instantly.

  • URLs land in logs more readily than headers do, so don't paste the connector URL anywhere you wouldn't paste a password.

  • Only expose the server over HTTPS (all three public recipes above provide it).

  • READ_ONLY=true if 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

MIT

A
license - permissive license
-
quality - not tested
A
maintenance

Maintenance

Maintainers
Response time
0dRelease cycle
3Releases (12mo)
Commit activity

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Servers

  • A
    license
    A
    quality
    C
    maintenance
    Enables Claude Code read/write access to an Obsidian vault, including creating, editing, searching, and browsing notes.
    8
    MIT
  • A
    license
    -
    quality
    D
    maintenance
    Enables reading, writing, searching, and managing an Obsidian vault through Claude, operating directly on markdown files via Node.js fs without requiring the Obsidian app.
    7,173
    MIT
  • F
    license
    -
    quality
    C
    maintenance
    Enables Claude to create, read, update, and search notes in a local Obsidian vault, with automatic YAML frontmatter and folder management.
    1

View all related MCP servers

Related MCP Connectors

  • Search your Obsidian vault to quickly find notes by title or keyword, summarize related content, a…

  • Connect AI assistants to your GitHub-hosted Obsidian vault to seamlessly access, search, and analy…

  • Read and write your Fresh Jots notes from Claude, Cursor, and any MCP client.

View all MCP Connectors

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jakergirard/obsidian-vault-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server