How do I install Obsidian Sync?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Obsidian Sync need an API key?

The publisher lists these environment variables: VAULT_PATH, COUCHDB_URL, COUCHDB_USER, COUCHDB_PASSWORD, COUCHDB_DATABASE, COUCHDB_PASSPHRASE, COUCHDB_OBFUSCATE_PROPERTIES, VAULT_NAME, MCP_AUTH_TOKEN, BASE_URL, PORT.

What transport does Obsidian Sync use?

Obsidian Sync runs locally over stdio.

When was Obsidian Sync last checked?

Last checked 2026-11-09. Give AI agents access to your Obsidian vault via local files or Self-hosted LiveSync.

Obsidian Sync MCP server

Power your agent

Add this server

The publisher's own command. Not a PlugMCP endpoint.

Add to Cursor Add to VS Code Run on PlugMCP

Host a copy with our keys and logs.

Local command

npx -y [email protected]

Credentials from the publisher

VAULT_PATH — Path to your Obsidian vault directory (filesystem mode)
COUCHDB_URL — CouchDB server URL (CouchDB mode)
COUCHDB_USER — CouchDB username
COUCHDB_PASSWORD — CouchDB password (required in CouchDB mode)
COUCHDB_DATABASE — CouchDB database name
COUCHDB_PASSPHRASE — 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 — Password for OAuth authentication
BASE_URL — Public URL for OAuth callbacks (required when using a tunnel)
PORT — HTTP port

Claude Code has no install link for a local command. Copy the command below and run it in a terminal.

shClaude Code

1VAULT_PATH=<value> COUCHDB_URL=<value> COUCHDB_USER=<value> COUCHDB_PASSWORD=<secret> COUCHDB_DATABASE=<value> COUCHDB_PASSPHRASE=<secret> COUCHDB_OBFUSCATE_PROPERTIES=<value> VAULT_NAME=<value> MCP_AUTH_TOKEN=<secret> BASE_URL=<value> PORT=<value> claude mcp add io.github.es617-obsidian-sync-mcp -- npx -y obsidian-sync-mcp@0.5.2

Run in a terminal.

jsonClaude Desktop

1{2  "mcpServers": {3    "io.github.es617-obsidian-sync-mcp": {4      "command": "npx",5      "args": [6        "-y",7        "[email protected]"8      ],9      "env": {10        "VAULT_PATH": "<value>",11        "COUCHDB_URL": "<value>",12        "COUCHDB_USER": "<value>",13        "COUCHDB_PASSWORD": "<secret>",14        "COUCHDB_DATABASE": "<value>",15        "COUCHDB_PASSPHRASE": "<secret>",16        "COUCHDB_OBFUSCATE_PROPERTIES": "<value>",17        "VAULT_NAME": "<value>",18        "MCP_AUTH_TOKEN": "<secret>",19        "BASE_URL": "<value>",20        "PORT": "<value>"21      }22    }23  }24}

claude_desktop_config.json

Local · npmPublisher installStep-by-step: add this in Claude

Remote URL or a command on your machine? How the two installs differ

Run on PlugMCP

Host a copy with our keys and logs.

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.

Launch

Server facts

Local

Transport: stdio
Version

Tools

No tool list yet. Remote servers get one after the first health check.

FAQ

Obsidian Sync

Add this server

Host a copy with our keys and logs.

Server facts

Tools

Questions

How do I install Obsidian Sync?

Does Obsidian Sync need an API key?

What transport does Obsidian Sync use?

When was Obsidian Sync last checked?

Documentation