Skip to content
VS Code

obsidian sync mcp for VS Code

io.github.es617/obsidian-sync-mcp

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

client:VS Code transport:stdio runtime:npm

Install obsidian sync mcp in VS Code

.vscode/mcp.json

{
  "inputs": [
    {
      "type": "promptString",
      "id": "vault-path",
      "description": "VAULT_PATH",
      "password": true
    },
    {
      "type": "promptString",
      "id": "couchdb-url",
      "description": "COUCHDB_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "couchdb-user",
      "description": "COUCHDB_USER",
      "password": true
    },
    {
      "type": "promptString",
      "id": "couchdb-password",
      "description": "COUCHDB_PASSWORD",
      "password": true
    },
    {
      "type": "promptString",
      "id": "couchdb-database",
      "description": "COUCHDB_DATABASE",
      "password": true
    },
    {
      "type": "promptString",
      "id": "couchdb-passphrase",
      "description": "COUCHDB_PASSPHRASE",
      "password": true
    },
    {
      "type": "promptString",
      "id": "couchdb-obfuscate-properties",
      "description": "COUCHDB_OBFUSCATE_PROPERTIES",
      "password": true
    },
    {
      "type": "promptString",
      "id": "vault-name",
      "description": "VAULT_NAME",
      "password": true
    },
    {
      "type": "promptString",
      "id": "mcp-auth-token",
      "description": "MCP_AUTH_TOKEN",
      "password": true
    },
    {
      "type": "promptString",
      "id": "base-url",
      "description": "BASE_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "port",
      "description": "PORT",
      "password": true
    }
  ],
  "servers": {
    "obsidian-sync-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "${input:vault-path}",
        "COUCHDB_URL": "${input:couchdb-url}",
        "COUCHDB_USER": "${input:couchdb-user}",
        "COUCHDB_PASSWORD": "${input:couchdb-password}",
        "COUCHDB_DATABASE": "${input:couchdb-database}",
        "COUCHDB_PASSPHRASE": "${input:couchdb-passphrase}",
        "COUCHDB_OBFUSCATE_PROPERTIES": "${input:couchdb-obfuscate-properties}",
        "VAULT_NAME": "${input:vault-name}",
        "MCP_AUTH_TOKEN": "${input:mcp-auth-token}",
        "BASE_URL": "${input:base-url}",
        "PORT": "${input:port}"
      }
    }
  }
}

VS Code prompts for each input the first time the server starts, so no secret is written to the file. VS Code docs

obsidian sync mcp in other clients