Obsidian Sync MCP

Name: Obsidian Sync MCP
Author: es617

作者：es617版本 0.5.2i★ –i在你的电脑上运行

注册名称io.github.es617/obsidian-sync-mcp

安装

概览

作者提供的说明（英文原文）

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

PopNx MCP 的三大支柱

这三项永远不会合并成一个分数：意见、测量和人气是不同的东西。

用户评价i暂无评价评价功能将在后续阶段与账户功能一起开放
我们的基础检查i1 项中通过 1 项依据公开信息检查；尚未扫描代码
使用情况i尚未统计★ –

它能帮你做什么

我们还没有为它写通俗的介绍。下面是我们从注册中心读取到的事实。

连接方式: 在你的电脑上运行
传输方式: Streamable HTTP
分类: 文档、表格与办公
你需要填写：COUCHDB_PASSWORD, COUCHDB_PASSPHRASE, MCP_AUTH_TOKEN

安装

选择你使用的 AI 应用，然后复制设置。

安装之前

基础检查：1 项中通过 1 项
在你的电脑上运行，拥有你的用户账户的权限（文件、网络、应用）。
需要你自己填写： VAULT_PATH, COUCHDB_URL, COUCHDB_USER, COUCHDB_PASSWORD, COUCHDB_DATABASE, COUCHDB_PASSPHRASE, COUCHDB_OBFUSCATE_PROPERTIES, VAULT_NAME, MCP_AUTH_TOKEN, BASE_URL, PORT

标为机密的值是你账户的钥匙。千万不要分享给别人，也不要粘贴到聊天里。

你需要

npm已安装 Node.js（用于 npx 命令）

你用的是哪个应用？

ClaudeClaude CodeCursorVS CodeChatGPT

在上方选择你的应用。我们会记住它，下次按钮会显示“安装到 …”。

打开 Claude Desktop → Settings → Developer → Edit Config，把下面的内容粘贴到 claude_desktop_config.json

{
  "mcpServers": {
    "obsidian-sync": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "your-value",
        "COUCHDB_URL": "your-value",
        "COUCHDB_USER": "your-value",
        "COUCHDB_PASSWORD": "your-value",
        "COUCHDB_DATABASE": "your-value",
        "COUCHDB_PASSPHRASE": "your-value",
        "COUCHDB_OBFUSCATE_PROPERTIES": "your-value",
        "VAULT_NAME": "your-value",
        "MCP_AUTH_TOKEN": "your-value",
        "BASE_URL": "your-value",
        "PORT": "your-value"
      }
    }
  }
}

在终端中运行这条命令

claude mcp add obsidian-sync --env VAULT_PATH=your-value --env COUCHDB_URL=your-value --env COUCHDB_USER=your-value --env COUCHDB_PASSWORD=your-value --env COUCHDB_DATABASE=your-value --env COUCHDB_PASSPHRASE=your-value --env COUCHDB_OBFUSCATE_PROPERTIES=your-value --env VAULT_NAME=your-value --env MCP_AUTH_TOKEN=your-value --env BASE_URL=your-value --env PORT=your-value -- npx -y obsidian-sync-mcp

运行前请先填写空着的值。

在 Cursor 中打开

或者自己复制设置

粘贴到项目中的 .cursor/mcp.json，或 ~/.cursor/mcp.json

{
  "mcpServers": {
    "obsidian-sync": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "your-value",
        "COUCHDB_URL": "your-value",
        "COUCHDB_USER": "your-value",
        "COUCHDB_PASSWORD": "your-value",
        "COUCHDB_DATABASE": "your-value",
        "COUCHDB_PASSPHRASE": "your-value",
        "COUCHDB_OBFUSCATE_PROPERTIES": "your-value",
        "VAULT_NAME": "your-value",
        "MCP_AUTH_TOKEN": "your-value",
        "BASE_URL": "your-value",
        "PORT": "your-value"
      }
    }
  }
}

浏览器会先询问是否打开应用，然后应用会显示设置并请你确认。密钥的值会留空，由你自己填写。

在 VS Code 中打开

或者自己复制设置

粘贴到项目中的 .vscode/mcp.json

{
  "servers": {
    "obsidian-sync": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "obsidian-sync-mcp"
      ],
      "env": {
        "VAULT_PATH": "your-value",
        "COUCHDB_URL": "your-value",
        "COUCHDB_USER": "your-value",
        "COUCHDB_PASSWORD": "your-value",
        "COUCHDB_DATABASE": "your-value",
        "COUCHDB_PASSPHRASE": "your-value",
        "COUCHDB_OBFUSCATE_PROPERTIES": "your-value",
        "VAULT_NAME": "your-value",
        "MCP_AUTH_TOKEN": "your-value",
        "BASE_URL": "your-value",
        "PORT": "your-value"
      }
    }
  }
}

浏览器会先询问是否打开应用，然后应用会显示设置并请你确认。密钥的值会留空，由你自己填写。

这个服务器在你的电脑上运行，而 ChatGPT 只能连接互联网上的服务器。请选择其他应用。

你的选择通过 Cookie 保存在这台设备上，无需账户。

需要你填写的值

VAULT_PATH env
Path to your Obsidian vault directory (filesystem mode)
COUCHDB_URL env
CouchDB server URL (CouchDB mode)
COUCHDB_USER env
CouchDB username
COUCHDB_PASSWORD 机密 env
CouchDB password (required in CouchDB mode)
COUCHDB_DATABASE env
CouchDB database name
COUCHDB_PASSPHRASE 机密 env
LiveSync E2E encryption passphrase (must match plugin setting)
COUCHDB_OBFUSCATE_PROPERTIES env
Set to 'true' if 'Obfuscate Properties' is enabled in LiveSync (obfuscates file paths, sizes, dates)
VAULT_NAME env
Vault name for deep links and index storage
MCP_AUTH_TOKEN 机密 env
Password for OAuth authentication
BASE_URL env
Public URL for OAuth callbacks (required when using a tunnel)
PORT env
HTTP port

这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同，请以 README 为准。

它能做什么

它在你的电脑上运行；安装后，工具列表会显示在你的 AI 应用中。

基础检查i

我们检查的是任何人都能看到的信息；我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月7日

✓ 通过
作者与仓库一致
注册名称已通过 GitHub 账户 es617 验证，该账户拥有此仓库
… 尚未检查
仍在维护
我们还没有从 GitHub 读取这个仓库
… 尚未检查
有许可证
我们还没有从 GitHub 读取这个仓库
– 不适用
端点有响应
它在你的电脑上运行，没有互联网端点
– 不适用
使用 OAuth 登录
在你的电脑上运行，改用本地设置
… 尚未检查
工具描述中没有隐藏指令
它在你的电脑上运行；我们只能读取互联网端点的工具列表

与“文档、表格与办公”中的其他服务器比较i

星标数多于此分类中其他 2197 个服务器的 0%
发布到注册中心的时间比此分类中其他 2197 个服务器的 6% 更新
基础检查结果等于或优于此分类中其他 2197 个服务器的 100%

与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时，星标数才计入。

常见问题

Obsidian Sync MCP 安全吗？

它在 1 项适用的基础检查中通过了 1 项。我们没有阅读代码。在添加密钥或令牌之前，请先看看这个服务器要求哪些权限，并使用只具备所需权限的密钥。

它需要哪些密钥或代码？

你需要填写：COUCHDB_PASSWORD, COUCHDB_PASSPHRASE, MCP_AUTH_TOKEN

它在我的电脑上运行还是在云端？

它在你的电脑上运行。你的 AI 应用会在需要时启动它，数据不会经过作者的服务器（除非它自己调用在线服务）。

它还在维护吗？

GitHub 仓库最后更新于–，最新版本（0.5.2）于7个月前进入注册中心。

哪些应用可以使用它？

支持 MCP 的应用，例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Node.js。

有什么可以替代它？

同一分类中有：Agent-Native Calendar, Excel MCP Server, MCP Server for Excel

替代选择

同一分类中其他作者的服务器，按星标数排序。

如何看卡片：★ GitHub 星标i三大支柱：评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i

Agent-Native Calendar

作者：BuilderIO

Agent-Native Google Calendar - manage events, sync, and public booking

在云端运行★ 7,620MIT2个月前更新

安装

Excel MCP Server

作者：haris-musa

Create and edit Excel files with AI: charts, PivotTables, formulas. No Excel needed.

在你的电脑上运行★ 4,276MIT6天前更新

安装

MCP Server for Excel

作者：sbroenne

Excel automation for AI - Sheets, Power Query, DAX, VBA, Tables, Ranges and more. Windows only.

在你的电脑上运行★ 847MIT4天前更新

安装

作者的 README

打开 README

按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。

Obsidian Sync MCP

Give any AI agent access to your Obsidian vault over MCP. Run it locally against your vault files, or pair it with Self-hosted LiveSync and deploy to the cloud so it works even when your machine is off.

Example: From your phone, ask your AI: "What's in my daily note for today?" — and get the full content back, with a link to open it in Obsidian.

How it works

The server connects to your vault in two ways:

Filesystem mode — reads .md files directly from your vault folder. No database needed.
CouchDB mode — reads from a CouchDB database, locally or in the cloud. Your vault syncs to CouchDB via Self-hosted LiveSync, the community Obsidian plugin (600k+ downloads). The MCP server reads from CouchDB directly using livesync-commonlib — the same library that powers the plugin — for proper chunk handling and E2E encryption support.

Both modes expose the same MCP tools over HTTP, so any MCP-compatible agent can connect: Claude, Copilot, custom agents, anything that speaks the Model Context Protocol.

Choose your setup

Need it always available?	Have LiveSync?	Go to
Yes	Yes	Setup A — add MCP alongside your existing CouchDB
Yes	No	Setup B — CouchDB + MCP + LiveSync from scratch
No	—	Setup C — filesystem or CouchDB, npx or Docker

A. Deploy MCP to the cloud

You already have LiveSync and CouchDB on an always-on server. You just need the MCP server deployed alongside it.

Using Fly.io setup script (macOS/Linux, or WSL on Windows):

git clone https://github.com/es617/obsidian-sync-mcp.git

cd obsidian-sync-mcp ./deploy/setup.sh # choose option 2 (MCP only)

The script asks for your CouchDB connection details, vault name, and encryption passphrase.

Or run the Docker image on any always-on server:

docker run -p 8787:8787 \

-v mcp-data:/data -e DATA_DIR=/data \ -e COUCHDB_URL=https://your-couchdb:5984 \ -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=yourpassword \ -e COUCHDB_DATABASE=obsidian -e VAULT_NAME=MyVault \ -e COUCHDB_PASSPHRASE=your-encryption-passphrase \ -e COUCHDB_OBFUSCATE_PROPERTIES=false \ -e MCP_AUTH_TOKEN=yourpassword \ -e BASE_URL=https://your-server-url \ ghcr.io/es617/obsidian-sync-mcp:latest

Set COUCHDB_PASSPHRASE if you use E2E encryption in LiveSync. Set COUCHDB_OBFUSCATE_PROPERTIES=true if "Obfuscate Properties" is also enabled in your LiveSync settings. For an existing vault the server detects the actual setting from the database at startup and corrects a mismatch with a warning; only for a brand-new empty database does the value need to match your LiveSync settings. If the vault was created with LiveSync 1.0.33+ and path obfuscation, also set COUCHDB_ID_DERIVATION_KEY to your LiveSync recovery code (sls-id-v1:..., from "Show current recovery code") so the server can resolve note paths. Set BASE_URL to your public URL (required for OAuth callbacks when agents connect over HTTPS).

Your MCP endpoint is https://your-app.fly.dev/mcp (Fly.io) or https://your-server:8787/mcp (Docker behind HTTPS).

See Cost for Fly.io pricing.

Requires flyctl for the Fly.io path:

curl -L https://fly.io/install.sh | sh

export PATH="$HOME/.fly/bin:$PATH" # add to ~/.zshrc or ~/.bashrc fly auth login

B. Deploy everything to the cloud

Starting fresh — no LiveSync yet. Deploy CouchDB and MCP together, then set up LiveSync in Obsidian.

Using Fly.io setup script (macOS/Linux, or WSL on Windows):

git clone https://github.com/es617/obsidian-sync-mcp.git

cd obsidian-sync-mcp ./deploy/setup.sh # choose option 1 (CouchDB + MCP)

The script generates credentials, creates the database, and deploys. Save the credentials it prints.

Or with Docker Compose on any always-on server:

git clone https://github.com/es617/obsidian-sync-mcp.git

cd obsidian-sync-mcp

cat > .env <<EOF COUCHDB_PASSWORD=changeme MCP_AUTH_TOKEN=changeme-too VAULT_NAME=MyVault EOF

docker compose up -d

After deployment:

In Obsidian, install Self-hosted LiveSync and configure it with the credentials from the setup output
Your MCP endpoint is https://your-app.fly.dev/mcp (Fly.io). With Docker Compose the MCP port is published on localhost:8787 only; to reach it from other machines, put an HTTPS tunnel or reverse proxy in front (see remote access) and set BASE_URL to its public URL
The MCP_AUTH_TOKEN is the password you enter when an agent connects

Always-on server

├── CouchDB + persistent storage └── MCP server ↑ ↑ Obsidian + LiveSync AI agents

Requires flyctl for the Fly.io path:

curl -L https://fly.io/install.sh | sh

export PATH="$HOME/.fly/bin:$PATH" # add to ~/.zshrc or ~/.bashrc fly auth login

Cost (Fly.io)

Applies to both Setup A and Setup B.

Component	Cost
CouchDB + MCP VM (shared, 512MB)	~$3-4/month (kept alive by LiveSync)
MCP-only VM (shared, 256MB)	~$0-2/month (suspends when idle)
1GB persistent volume	~$0.15/month

As of March 2026, Fly.io may waive charges under $5/month, which could make this effectively free with a shared IPv4. Either way, cheaper than Obsidian Sync ($4/month) and you own the data.

C. Run on your machine

Run the MCP server locally. Works with filesystem mode (reads vault files directly) or CouchDB mode (if you have LiveSync). Machine must stay on for agents to reach it.

Filesystem mode (simplest):

VAULT_PATH=~/Documents/MyVault \

VAULT_NAME=MyVault \ npx obsidian-sync-mcp

CouchDB mode (if you have LiveSync):

COUCHDB_URL=http://localhost:5984 \

COUCHDB_USER=admin \ COUCHDB_PASSWORD=yourpassword \ COUCHDB_DATABASE=obsidian \ COUCHDB_PASSPHRASE=your-encryption-passphrase \ COUCHDB_OBFUSCATE_PROPERTIES=false \ VAULT_NAME=MyVault \ npx obsidian-sync-mcp

Omit COUCHDB_PASSPHRASE if you don't use E2E encryption in LiveSync. Set COUCHDB_OBFUSCATE_PROPERTIES=true if "Obfuscate Properties" is also enabled in your LiveSync settings. For an existing vault the server detects the actual setting from the database at startup and corrects a mismatch with a warning; only for a brand-new empty database does the value need to match your LiveSync settings. If the vault was created with LiveSync 1.0.33+ and path obfuscation, also set COUCHDB_ID_DERIVATION_KEY to your LiveSync recovery code (sls-id-v1:...) so the server can resolve note paths.

Or with Docker:

docker run -p 127.0.0.1:8787:8787 \

-v mcp-data:/data -e DATA_DIR=/data \ -e VAULT_PATH=/vault -v ~/Documents/MyVault:/vault \ -e VAULT_NAME=MyVault \ ghcr.io/es617/obsidian-sync-mcp:latest

Your MCP endpoint is http://localhost:8787/mcp.

Want remote access? Add a tunnel (machine must stay on):

cloudflared tunnel --url http://localhost:8787    # free

tailscale funnel 8787 # or Tailscale ngrok http 8787 # or ngrok

Set BASE_URL to the tunnel URL when using authentication.

Tools

Tool	Description
`read_note`	Read a note's markdown content by path
`write_note`	Create or overwrite a note (replaces entire content)
`edit_note`	Edit a note without rewriting it — append, prepend (after frontmatter), or replace exact text
`list_folders`	List all folders in the vault with note counts — use to discover folder names
`list_tags`	List all tags in the vault with counts — use to discover tags before filtering
`list_notes`	List notes with timestamps. Filter by folder, name, tag, or date. Sort by name or modified.
`search_notes`	Search note text for terms (OR, case-insensitive substrings); paths and frontmatter titles are searched first. Filter by folder, tag, or date. Returns paths with one context line each, never the note body, after a status line that states which CouchDB sequence the index is caught up with.
`delete_note`	Delete a note
`move_note`	Move or rename a note — works across folders, creates destination folders automatically
`get_note_metadata`	Get frontmatter, tags, outgoing links, backlinks, size, and timestamps — navigate the knowledge graph

Every tool response includes an Obsidian deep link (obsidian://open?vault=...&file=...) that works on Mac and iOS.

"Add a bullet point to my daily note." "Find my notes about the MCP server and fix the typo in the second one."

Authentication

Set MCP_AUTH_TOKEN to a password to enable authentication:

MCP_AUTH_TOKEN=mysecretpassword npx obsidian-sync-mcp

The server includes a self-contained OAuth 2.1 provider. When an agent connects:

A browser window opens with a password page
Enter the MCP_AUTH_TOKEN password
The agent gets an access token and refreshes it transparently

The session is shared across all your Claude interfaces (Desktop, Web, Mobile) and persists across server restarts. You'll need to re-enter the password after 14 days of inactivity (configurable via MCP_REFRESH_DAYS).

For non-OAuth clients (curl, MCP Inspector, custom agents), you can also pass the token directly as Authorization: Bearer .

Without MCP_AUTH_TOKEN, the server runs without authentication — suitable for local use or behind a private network.

Environment variables

Variable	Required	Default	Description
`VAULT_PATH`	Filesystem mode	—	Path to your Obsidian vault directory
`COUCHDB_URL`	CouchDB mode	—	CouchDB server URL
`COUCHDB_USER`	CouchDB mode	`admin`	CouchDB username
`COUCHDB_PASSWORD`	CouchDB mode	—	CouchDB password (required)
`COUCHDB_DATABASE`	CouchDB mode	`obsidian`	CouchDB database name. The server never creates it: if it doesn't exist, startup fails with an error
`COUCHDB_PASSPHRASE`	CouchDB mode	—	LiveSync E2E encryption passphrase (must match plugin setting)
`COUCHDB_OBFUSCATE_PROPERTIES`	CouchDB mode	`false`	Set to `true` if "Obfuscate Properties" is enabled in LiveSync (obfuscates file paths, sizes, dates in the database). For existing vaults the actual setting is auto-detected at startup; this value only decides the format for a brand-new empty database
`COUCHDB_ID_DERIVATION_KEY`	CouchDB mode	—	LiveSync "independent ID derivation" recovery code (`sls-id-v1:...`). Needed to read and write notes on vaults created with LiveSync 1.0.33+ that use path obfuscation; leave unset for older (passphrase-derived) vaults. Get it from LiveSync's "Show current recovery code"
`COUCHDB_CASE_SENSITIVE`	CouchDB mode	`false`	Set to `true` only if your LiveSync vault has "Handle filenames as case-sensitive" enabled. It must match the vault, or obfuscated document IDs won't resolve (the server fails to start with a clear message). Leave unset otherwise
`VAULT_NAME`	Both	`MyVault`	Vault name (used for deep links and index storage)

| MCP_AUTH_TOKEN | Optional | — | Password fo

只显示了开头部分；其余内容请在仓库中阅读

Obsidian Sync MCP

概览

PopNx MCP 的三大支柱

它能帮你做什么

安装

安装之前

需要你填写的值

它能做什么

基础检查i

作者与仓库一致

仍在维护

有许可证

端点有响应

使用 OAuth 登录

工具描述中没有隐藏指令

与“文档、表格与办公”中的其他服务器比较i

常见问题

替代选择

Agent-Native Calendar

Excel MCP Server

MCP Server for Excel

作者的 README

Obsidian Sync MCP

How it works

Choose your setup

A. Deploy MCP to the cloud

B. Deploy everything to the cloud

Cost (Fly.io)

C. Run on your machine

Tools

Authentication

Environment variables