MCP Server

io.github.es617/obsidian-sync-mcp MCP Server

Name: io.github.es617/obsidian-sync-mcp MCP Server
Author: io.github.es617

io.github.es617/obsidian-sync-mcp

Repository Registry

What is the io.github.es617/obsidian-sync-mcp MCP server?

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

How to install io.github.es617/obsidian-sync-mcp

Copy-paste configuration for popular MCP clients.

transport: stdio

Config generated by PluginBench — verify against the source before use.

Environment / auth

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

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "<YOUR_VAULT_PATH>",
        "COUCHDB_URL": "<YOUR_COUCHDB_URL>",
        "COUCHDB_USER": "<YOUR_COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<YOUR_COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<YOUR_COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<YOUR_VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<YOUR_MCP_AUTH_TOKEN>",
        "BASE_URL": "<YOUR_BASE_URL>",
        "PORT": "<YOUR_PORT>"
      }
    }
  }
}

Cursor

~/.cursor/mcp.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "<YOUR_VAULT_PATH>",
        "COUCHDB_URL": "<YOUR_COUCHDB_URL>",
        "COUCHDB_USER": "<YOUR_COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<YOUR_COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<YOUR_COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<YOUR_VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<YOUR_MCP_AUTH_TOKEN>",
        "BASE_URL": "<YOUR_BASE_URL>",
        "PORT": "<YOUR_PORT>"
      }
    }
  }
}

Windsurf

~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "obsidian-sync-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "<YOUR_VAULT_PATH>",
        "COUCHDB_URL": "<YOUR_COUCHDB_URL>",
        "COUCHDB_USER": "<YOUR_COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<YOUR_COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<YOUR_COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<YOUR_VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<YOUR_MCP_AUTH_TOKEN>",
        "BASE_URL": "<YOUR_BASE_URL>",
        "PORT": "<YOUR_PORT>"
      }
    }
  }
}

VS Code

.vscode/mcp.json

{
  "servers": {
    "obsidian-sync-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "<YOUR_VAULT_PATH>",
        "COUCHDB_URL": "<YOUR_COUCHDB_URL>",
        "COUCHDB_USER": "<YOUR_COUCHDB_USER>",
        "COUCHDB_PASSWORD": "<YOUR_COUCHDB_PASSWORD>",
        "COUCHDB_DATABASE": "<YOUR_COUCHDB_DATABASE>",
        "COUCHDB_PASSPHRASE": "<YOUR_COUCHDB_PASSPHRASE>",
        "COUCHDB_OBFUSCATE_PROPERTIES": "<YOUR_COUCHDB_OBFUSCATE_PROPERTIES>",
        "VAULT_NAME": "<YOUR_VAULT_NAME>",
        "MCP_AUTH_TOKEN": "<YOUR_MCP_AUTH_TOKEN>",
        "BASE_URL": "<YOUR_BASE_URL>",
        "PORT": "<YOUR_PORT>"
      }
    }
  }
}

Claude Code

claude mcp add obsidian-sync-mcp --env VAULT_PATH=<YOUR_VAULT_PATH> --env COUCHDB_URL=<YOUR_COUCHDB_URL> --env COUCHDB_USER=<YOUR_COUCHDB_USER> --env COUCHDB_PASSWORD=<YOUR_COUCHDB_PASSWORD> --env COUCHDB_DATABASE=<YOUR_COUCHDB_DATABASE> --env COUCHDB_PASSPHRASE=<YOUR_COUCHDB_PASSPHRASE> --env COUCHDB_OBFUSCATE_PROPERTIES=<YOUR_COUCHDB_OBFUSCATE_PROPERTIES> --env VAULT_NAME=<YOUR_VAULT_NAME> --env MCP_AUTH_TOKEN=<YOUR_MCP_AUTH_TOKEN> --env BASE_URL=<YOUR_BASE_URL> --env PORT=<YOUR_PORT> -- npx -y obsidian-sync-mcp

Related MCP servers

io.github.es617/ble-mcp-server

Let AI agents interact with real BLE hardware — scan, connect, read, write, and subscribe.

View repository →

io.github.es617/dbgprobe-mcp-server

Let AI agents interact with debug probes — connect, flash, read/write memory, and reset.

View repository →

io.github.es617/serial-mcp-server

Let AI agents interact with serial devices — list ports, connect, send, and read.

View repository →