vault-sync
Give any MCP-compatible AI assistant full access to your Obsidian vault. Read, search, create, and edit notes through natural language. Changes sync to every device through Obsidian Sync.
Agenten stärken
Installation vom Herausgeber. Kein PlugMCP-Endpunkt.
Host a copy with our keys and logs.
Noch kein paketiertes Release in der Registry. Folgen Sie der README des Repositorys.
Remote-URL oder ein Befehl auf Ihrem Rechner? Worin sich die beiden Installationen unterscheiden
Auf PlugMCP ausführen
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
Startenvault-sync connects to the Obsidian Sync service as a headless client and exposes your vault over MCP (Model Context Protocol). Any MCP client (Claude, Cursor, Windsurf, custom agents) can work with your notes directly, and every change propagates to your phone, tablet, and desktop through the same sync service your vault already uses.
This is an unofficial, third-party client. It is not affiliated with or endorsed by Obsidian. Requires an active Obsidian Sync subscription. Use at your own risk.
vault-sync is a single binary with two features that can be enabled independently.
.md files, shallow JSON merge for .obsidian/ configSee authentication documentation for setup and usage.
cp .env.example .env # fill in credentials
docker compose -f docker/docker-compose.yml up -d
See the getting started guide for full setup instructions including HTTPS configuration and MCP client setup.
All configuration via environment variables or .env file.
At least one of MCP_AUTH_USERS, MCP_CLIENT_CREDENTIALS, or MCP_API_KEYS is required when MCP is enabled.
These control which .obsidian/ files are synced. All default to false.
SYNC_MAIN_SETTINGS, SYNC_APPEARANCE, SYNC_THEMES_SNIPPETS, SYNC_HOTKEYS, SYNC_ACTIVE_CORE_PLUGINS, SYNC_CORE_PLUGIN_SETTINGS, SYNC_COMMUNITY_PLUGINS, SYNC_INSTALLED_PLUGINS
Requires Go 1.27+ and just.
just build # build binary to bin/vault-sync
just test # go test -v -race ./...
just lint # golangci-lint run
just lint-fix # golangci-lint run --fix
just check # lint + test + build
just test-coverage # run tests with coverage report
just docker-build # build Docker image
just clean # remove build artifacts
cmd/vault-sync/ Entry point
internal/
auth/ OAuth 2.1 server
config/ Environment variable parsing
errors/ Sentinel errors
logging/ Structured logging (slog)
mcpserver/ MCP tool registration
models/ Shared types
obsidian/ Sync protocol implementation
server/ HTTP mux construction
state/ bbolt persistence
vault/ Filesystem operations for MCP
docker/ Dockerfile and docker-compose.yml
docs/ MCP tool documentation
This is an unofficial, third-party client. It is not developed, maintained, or supported by the Obsidian team. The sync protocol is undocumented and may change without notice. No warranty is provided. The authors are not responsible for data loss or account issues.
MIT
Headless Obsidian Sync client with MCP server for AI assistants
Tools
Noch keine Tool-Liste. Remote-Server erhalten eine nach dem ersten Health-Check.
FAQ
Kopieren Sie auf dieser Seite die stdio-Konfiguration für Cursor, Claude Desktop, Claude Code oder VS Code. Sie nutzt die Installation des Herausgebers, keinen PlugMCP-Proxy.
In diesem Eintrag ist keine erforderliche Umgebungsvariable aufgeführt.
Vault Sync läuft lokal über stdio.
Zuletzt geprüft: 2026-10-28. Headless Obsidian Sync client with MCP server for AI assistants