← Index

io.github.es617/obsidian-sync-mcp

io.github.es617/obsidian-sync-mcp·v0.5.2·Security
Quality Score
80
/100

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

§01  Install
Claude Desktop (claude_desktop_config.json)
{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "<vault_path>",
        "COUCHDB_URL": "<couchdb_url>",
        "COUCHDB_USER": "<couchdb_user>",
        "COUCHDB_PASSWORD": "<your-couchdb_password>",
        "COUCHDB_DATABASE": "<couchdb_database>",
        "COUCHDB_PASSPHRASE": "<your-couchdb_passphrase>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<couchdb_obfuscate_properties>",
        "VAULT_NAME": "<vault_name>",
        "MCP_AUTH_TOKEN": "<your-mcp_auth_token>",
        "BASE_URL": "<base_url>",
        "PORT": "<port>"
      }
    }
  }
}
Cursor (.cursor/mcp.json)
{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "<vault_path>",
        "COUCHDB_URL": "<couchdb_url>",
        "COUCHDB_USER": "<couchdb_user>",
        "COUCHDB_PASSWORD": "<your-couchdb_password>",
        "COUCHDB_DATABASE": "<couchdb_database>",
        "COUCHDB_PASSPHRASE": "<your-couchdb_passphrase>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<couchdb_obfuscate_properties>",
        "VAULT_NAME": "<vault_name>",
        "MCP_AUTH_TOKEN": "<your-mcp_auth_token>",
        "BASE_URL": "<base_url>",
        "PORT": "<port>"
      }
    }
  }
}
Cline (cline_mcp_settings.json)
npx -y obsidian-sync-mcp
§02  Environment variables
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

MCP_AUTH_TOKEN
secret

Password for OAuth authentication

BASE_URL

Public URL for OAuth callbacks (required when using a tunnel)

PORT

HTTP port

§03  MCP Quality Score  ·  methodology
freshness
25
completeness
10
installability
25
documentation
15
stability
5
§04  Alternatives in Security