gitwtfhub

wtf is obsidian-vault-mcp?

nazimjamil/obsidian-vault-mcp — explained in plain English

Analysis updated 2026-05-18

1ShellAudience · developerComplexity · 3/5LicenseSetup · moderate

TL;DR

A Docker setup that keeps a copy of your Obsidian notes vault synced and exposes it to AI tools over the network using MCP.

Mindmap

mindmap
  root((obsidian-vault-mcp))
    What it does
      Syncs Obsidian vault
      Exposes it via MCP
      Runs headless
    Tech stack
      Docker
      MCP
      Obsidian Sync
    Use cases
      AI access to notes
      Raspberry Pi hosting
      Self hosted knowledge base
    Audience
      Developers
      Obsidian power users
    Setup
      Docker Compose
      Needs Obsidian Sync account

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Let an AI assistant read and write your Obsidian notes over the network from a small always-on server.

REASON 2

Keep a headless, continuously synced copy of an Obsidian vault running on a Raspberry Pi.

REASON 3

Give MCP capable AI clients on your home network access to a personal knowledge base.

REASON 4

Set up a self-hosted bridge between Obsidian Sync and any tool that speaks the MCP protocol.

What's in the stack?

ShellDockerDocker ComposeMCPObsidian

How it stacks up

nazimjamil/obsidian-vault-mcp100/dotfilesadams549659584/my-openwrt-actions
Stars111
LanguageShellShellShell
Last pushed2016-11-182020-06-06
MaintenanceDormantDormant
Setup difficultymoderateeasyhard
Complexity3/51/53/5
Audiencedeveloperdeveloperops devops

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · moderate Time to first run · 30min

Requires an Obsidian account with Obsidian Sync enabled plus Docker and Docker Compose.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

Wtf does this do

obsidian-vault-mcp lets you run a copy of your Obsidian notes vault on a small always-on machine, like a Raspberry Pi, and make it readable and writable by AI tools over the network. Obsidian is a popular note-taking app, and this project connects it to MCP, a standard way for AI assistants and agents to read and write data from outside services. The setup uses two Docker containers built from the same image. One container keeps a local copy of your vault continuously synced with your Obsidian Sync account in the cloud. The other container reads and writes that same local vault folder and exposes it as an MCP server over HTTP on port 3000, so any MCP capable AI client on your network can connect to it. The two containers never talk to each other directly, they simply share the same folder on disk, which keeps the setup simple. To use it, you need Docker and Docker Compose installed, an Obsidian account with Obsidian Sync turned on for the vault you want to share, and an API key for the plugin the MCP server expects. Setup involves copying an example environment file, filling in your values, and running an interactive setup script that logs into Obsidian Sync, lists your remote vaults, and pulls down an initial copy of the one you choose. After that, starting both containers with one Docker Compose command brings the whole system online. The project is careful about security: your notes, configuration, and API keys are stored in folders that are excluded from version control by default, and the README repeats more than once that these should never be committed to git. If you rotate your API key, you simply update the environment file and restart the containers. The project is released under the MIT License.

Yoink these prompts

Prompt 1
Help me set up obsidian-vault-mcp on a Raspberry Pi and connect it to my Obsidian Sync account.
Prompt 2
Explain how the obsidian-sync and obsidian-mcp containers in this project share data without talking to each other directly.
Prompt 3
Walk me through configuring my .env file and running setup.sh for obsidian-vault-mcp.
Prompt 4
Show me how to connect an MCP client to the obsidian-mcp server this project exposes on port 3000.
Prompt 5
Explain what security precautions this project takes with my Obsidian API key and vault data.

Frequently asked questions

wtf is obsidian-vault-mcp?

A Docker setup that keeps a copy of your Obsidian notes vault synced and exposes it to AI tools over the network using MCP.

What language is obsidian-vault-mcp written in?

Mainly Shell. The stack also includes Shell, Docker, Docker Compose.

What license does obsidian-vault-mcp use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is obsidian-vault-mcp to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is obsidian-vault-mcp for?

Mainly developer.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.