Obsidian Sync Mcp

io.github.es617/obsidian-sync-mcp · v0.5.2

Give AI agents access to your Obsidian vault via local files or Self-hosted LiveSync.

Source code Set it up

Connect Runs on your machine

Terminal

claude mcp add obsidian-sync-mcp -e VAULT_PATH=<VAULT_PATH> -e COUCHDB_URL=<COUCHDB_URL> -e COUCHDB_USER=<COUCHDB_USER> -e COUCHDB_PASSWORD=<COUCHDB_PASSWORD> -e COUCHDB_DATABASE=<COUCHDB_DATABASE> -e COUCHDB_PASSPHRASE=<COUCHDB_PASSPHRASE> -e COUCHDB_OBFUSCATE_PROPERTIES=<COUCHDB_OBFUSCATE_PROPERTIES> -e VAULT_NAME=<VAULT_NAME> -e MCP_AUTH_TOKEN=<MCP_AUTH_TOKEN> -e BASE_URL=<BASE_URL> -e PORT=<PORT> -- npx -y [email protected]

claude_desktop_config.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "[email protected]"
      ],
      "env": {
        "VAULT_PATH": "<VAULT_PATH>",
        "COUCHDB_URL": "<COUCHDB_URL>",
        "COUCHDB_USER": "<COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<MCP_AUTH_TOKEN>",
        "BASE_URL": "<BASE_URL>",
        "PORT": "<PORT>"
      }
    }
  }
}

~/.cursor/mcp.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "[email protected]"
      ],
      "env": {
        "VAULT_PATH": "<VAULT_PATH>",
        "COUCHDB_URL": "<COUCHDB_URL>",
        "COUCHDB_USER": "<COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<MCP_AUTH_TOKEN>",
        "BASE_URL": "<BASE_URL>",
        "PORT": "<PORT>"
      }
    }
  }
}

.vscode/mcp.json

{
  "servers": {
    "obsidian-sync-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "[email protected]"
      ],
      "env": {
        "VAULT_PATH": "<VAULT_PATH>",
        "COUCHDB_URL": "<COUCHDB_URL>",
        "COUCHDB_USER": "<COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<MCP_AUTH_TOKEN>",
        "BASE_URL": "<BASE_URL>",
        "PORT": "<PORT>"
      }
    }
  }
}

Replace the values in angle brackets with your own. Keys stay on your machine; we never see them.

Tools

This server runs locally, so its tools are listed by your MCP client once it starts.

Environment variables

Name	Description
`VAULT_PATH` Optional	Path to your Obsidian vault directory (filesystem mode)
`COUCHDB_URL` Optional	CouchDB server URL (CouchDB mode)
`COUCHDB_USER` Optional	CouchDB username
`COUCHDB_PASSWORD` Optional, secret	CouchDB password (required in CouchDB mode)
`COUCHDB_DATABASE` Optional	CouchDB database name
`COUCHDB_PASSPHRASE` Optional, secret	LiveSync E2E encryption passphrase (must match plugin setting)
`COUCHDB_OBFUSCATE_PROPERTIES` Optional	Set to 'true' if 'Obfuscate Properties' is enabled in LiveSync (obfuscates file paths, sizes, dates)
`VAULT_NAME` Optional	Vault name for deep links and index storage
`MCP_AUTH_TOKEN` Optional, secret	Password for OAuth authentication
`BASE_URL` Optional	Public URL for OAuth callbacks (required when using a tunnel)
`PORT` Optional	HTTP port

Details

Package	`[email protected]` (NPM, streamable-http)
First published	30 Mar 2026
Last updated	30 Mar 2026
Registry name	`io.github.es617/obsidian-sync-mcp`

More productivity servers See all

Live status

Local install

Installed and run on your own machine, so there is no public endpoint to check.

Pair it with live search

Agents that use Obsidian Sync Mcp often also need current facts. NestDaddy MCP gives your AI today's internet: web search, real-time breaking news and full page reading in one connector.

See NestDaddy MCP

For maintainers

[![NestDaddy MCP](https://nestdaddy.com/mcp/servers/io-github-es617-obsidian-sync-mcp/badge.svg)](https://nestdaddy.com/mcp/servers/io-github-es617-obsidian-sync-mcp)

Add the badge to your README. It turns green while your server passes our daily check. Listing details come from the official MCP registry; update them there.

Listing data from the official MCP registry. Status and tools from NestDaddy's daily check. Browse all MCP servers.