MCP Server MCP

io.github.es617/obsidian-sync-mcp

By github 👁 1 views ▲ 0 votes

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

Homepage Verified source GitHub

Install

npx -y [email protected]

Configuration Example

{
  "remotes": [],
  "packages": [
    {
      "registryType": "npm",
      "identifier": "obsidian-sync-mcp",
      "version": "0.5.2",
      "transport": {
        "type": "streamable-http",
        "url": "http://localhost:8787/mcp"
      },
      "environmentVariables": [
        {
          "description": "Path to your Obsidian vault directory (filesystem mode)",
          "format": "string",
          "name": "VAULT_PATH"
        },
        {
          "description": "CouchDB server URL (CouchDB mode)",
          "format": "string",
          "name": "COUCHDB_URL"
        },
        {
          "description": "CouchDB username",
          "format": "string",
          "name": "COUCHDB_USER"
        },
        {
          "description": "CouchDB password (required in CouchDB mode)",
          "format": "string",
          "isSecret": true,
          "name": "COUCHDB_PASSWORD"
        },
        {
          "description": "CouchDB database name",
          "format": "string",
          "name": "COUCHDB_DATABASE"
        },
        {
          "description": "LiveSync E2E encryption passphrase (must match plugin setting)",
          "format": "string",
          "isSecret": true,
          "name": "COUCHDB_PASSPHRASE"
        },
        {
          "description": "Set to 'true' if 'Obfuscate Properties' is enabled in LiveSync (obfuscates file paths, sizes, dates)",
          "format": "string",
          "name": "COUCHDB_OBFUSCATE_PROPERTIES"
        },
        {
          "description": "Vault name for deep links and index storage",
          "format": "string",
          "name": "VAULT_NAME"
        },
        {
          "description": "Password for OAuth authentication",
          "format": "string",
          "isSecret": true,
          "name": "MCP_AUTH_TOKEN"
        },
        {
          "description": "Public URL for OAuth callbacks (required when using a tunnel)",
          "format": "string",
          "name": "BASE_URL"
        },
        {
          "description": "HTTP port",
          "format": "string",
          "name": "PORT"
        }
      ]
    }
  ]
}

mcp model-context-protocol npm