Skip to content
MCP server

Obsidian Sync MCP

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

Install
Pricing
Open source
Runs
Remotely
Version
0.5.2
Listing updated
4 days ago

About Obsidian Sync MCP

Obsidian Sync MCP is an open-source MCP server for knowledge and memory. It runs as a hosted remote server, so there is nothing to install locally.

Install

Run in a terminal

claude mcp add obsidian-sync-mcp --env COUCHDB_PASSWORD='<COUCHDB_PASSWORD>' --env COUCHDB_PASSPHRASE='<COUCHDB_PASSPHRASE>' --env MCP_AUTH_TOKEN='<MCP_AUTH_TOKEN>' -- npx -y obsidian-sync-mcp

Add to claude_desktop_config.json

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

Add to ~/.cursor/mcp.json

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

Add to .vscode/mcp.json

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

Add to ~/.codeium/windsurf/mcp_config.json

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

Add to your client's MCP settings (most use this shape)

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

Configuration

  • VAULT_PATHPath to your Obsidian vault directory (filesystem mode)
  • COUCHDB_URLCouchDB server URL (CouchDB mode)
  • COUCHDB_USERCouchDB username
  • COUCHDB_PASSWORDCouchDB password (required in CouchDB mode)
  • COUCHDB_DATABASECouchDB database name
  • COUCHDB_PASSPHRASELiveSync E2E encryption passphrase (must match plugin setting)
  • COUCHDB_OBFUSCATE_PROPERTIESSet to 'true' if 'Obfuscate Properties' is enabled in LiveSync (obfuscates file paths, sizes, dates)
  • VAULT_NAMEVault name for deep links and index storage
  • MCP_AUTH_TOKENPassword for OAuth authentication
  • BASE_URLPublic URL for OAuth callbacks (required when using a tunnel)
  • PORTHTTP port

Pricing

Open source

Obsidian Sync MCP FAQ

Is Obsidian Sync MCP free?

Yes. Obsidian Sync MCP is open source, so you can use and self-host it for free.

How do I add Obsidian Sync MCP to Claude Code?

Run this command in your terminal: claude mcp add obsidian-sync-mcp --env COUCHDB_PASSWORD='<COUCHDB_PASSWORD>' --env COUCHDB_PASSPHRASE='<COUCHDB_PASSPHRASE>' --env MCP_AUTH_TOKEN='<MCP_AUTH_TOKEN>' -- npx -y obsidian-sync-mcp

What are the best alternatives to Obsidian Sync MCP?

The closest alternatives to Obsidian Sync MCP are Codebase Memory, XERJ, Claude Code Ultimate Guide, Nautilus Compass Memory and note1.

Alternatives to Obsidian Sync MCP

  1. Codebase Memory

    MCP server

    Local MCP server that builds a code knowledge graph for AI coding agents

    Runs locally
    • Open source
    • 48.7K GitHub stars
    • Knowledge and memory
  2. XERJ

    MCP server

    Local search engine for AI agents with cited answers over your code and docs

    Runs locally
    • Open source
    • 19.2K GitHub stars
    • Knowledge and memory
  3. MCP server for searching the Claude Code Ultimate Guide from any MCP client

    Runs locally
    • Open source
    • 6.5K GitHub stars
    • AI models and LLM tooling
  4. Local-first long-term memory layer for AI agents, served over MCP

    Not checked yet
    • 5 tools
    • Remote
    • Open source
    • 1.3K GitHub stars
    • Knowledge and memory
  5. note1

    MCP server

    MCP server giving AI assistants search and summaries across your note1 meetings

    • 4 tools
    • Remote
    • Free trial
    • 1 GitHub star
    • Productivity