Obsidian Sync Mcp

MCP server · by es617

Productivity npm v0.5.2

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

View source ↗ Generate config for multiple servers More servers

Install

Pin version registry version 0.5.2

npm
npx -y obsidian-sync-mcp

npm
npx -y obsidian-sync-mcp@0.5.2

Setup by client

Pick your client — the config below is generated for this server (local stdio). Copy respects the “Pin version” switch above.

claude_desktop_config.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp@0.5.2"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

Format verified against the official Claude Desktop docs ↗.

terminal

claude mcp add --env COUCHDB_PASSWORD=<YOUR_COUCHDB_PASSWORD> --env COUCHDB_PASSPHRASE=<YOUR_COUCHDB_PASSPHRASE> obsidian-sync-mcp -- npx -y obsidian-sync-mcp

claude mcp add --env COUCHDB_PASSWORD=<YOUR_COUCHDB_PASSWORD> --env COUCHDB_PASSPHRASE=<YOUR_COUCHDB_PASSPHRASE> obsidian-sync-mcp -- npx -y obsidian-sync-mcp@0.5.2

Format verified against the official Claude Code docs ↗.

.cursor/mcp.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp@0.5.2"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

Format verified against the official Cursor docs ↗.

.vscode/mcp.json

{
  "servers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

{
  "servers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp@0.5.2"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

Format verified against the official VS Code docs ↗.

mcp_config.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp@0.5.2"
      ],
      "env": {
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>"
      }
    }
  }
}

Format verified against the official Windsurf docs ↗.

Environment variables

Defined in the server's official registry manifest. Required secrets are shown as <YOUR_…> placeholders in the configs above.

VAULT_PATH — Path to your Obsidian vault directory (filesystem mode)
COUCHDB_URL — CouchDB server URL (CouchDB mode)
COUCHDB_USER — CouchDB username
COUCHDB_PASSWORD secret — CouchDB password (required in CouchDB mode)
COUCHDB_DATABASE — CouchDB database name
COUCHDB_PASSPHRASE secret — LiveSync E2E encryption passphrase (must match plugin setting)
COUCHDB_OBFUSCATE_PROPERTIES — Set to 'true' if 'Obfuscate Properties' is enabled in LiveSync (obfuscates file paths, sizes, dates)
VAULT_NAME — Vault name for deep links and index storage

GitHub

⭐ 59 stars · 最近更新于 29 天前 · MIT license

About this server

Distributed as npm, listed under Productivity. Review our MCP security guide before granting access to real data.

Frequently asked questions

How do I install Obsidian Sync Mcp?

Run the install command shown above, then paste the config for your client (Claude Desktop, Claude Code, Cursor, VS Code or Windsurf) into its MCP settings and restart the client.

Is Obsidian Sync Mcp free to use?

The MCP server itself is free to install. The source is public on https://github.com/es617/obsidian-sync-mcp.git. Any third-party service it calls may require its own API key and account.

Which clients support Obsidian Sync Mcp?

Any MCP-compatible client can use it, including Claude Desktop, Claude Code, Cursor, VS Code, Windsurf and custom agents.

Add this badge

Publish this server? Link back with a badge on your README or site — copy either snippet.

Markdown

[![Listed on MCPNav](https://mcpnav.net/badge/obsidian-sync-mcp.svg)](https://mcpnav.net/server/obsidian-sync-mcp/)

HTML

<a href="https://mcpnav.net/server/obsidian-sync-mcp/"><img src="https://mcpnav.net/badge/obsidian-sync-mcp.svg" alt="Listed on MCPNav" height="20"></a>