MCP Obsidian

🚀 MCP Obsidian

MCP Obsidian 是專為 Obsidian 保險庫集成打造的 Model Context Protocol 服務器端工具。它支持 Claude Desktop（或其他 MCP 客戶端）搜索和閱讀你的 Obsidian 筆記，為筆記的高效利用提供了便利。

🚀 快速開始

先決條件

• Node.js 18+，可通過brew install node進行安裝。
• 擁有一個 Obsidian 保險庫。
• 安裝 Claude Desktop，可從此處下載並安裝。

配置步驟

1. 打開你的 Claude Desktop 配置文件，其路徑為：~/Library/Application Support/Claude/claude_desktop_config.json。你可以按以下方式找到該文件：
   1. 打開 Claude Desktop。
   2. 點擊菜單欄中的“Claude”。
   3. 選擇“設置”。
   4. 再次點擊“開發者”。
2. 在配置文件中添加以下內容：

{
  "tools": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-obsidian"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

⚠️ 重要提示

請將/path/to/your/obsidian/vault替換為你的實際 Obsidian 保險庫路徑。

📚 詳細文檔

開發者指南

先決條件

• Node.js 18+，可通過brew install node進行安裝。
• 擁有一個 Obsidian 保險庫。
• 安裝 Claude Desktop，可從此處下載並安裝。
• 安裝 tsx，可通過npm install -g tsx進行安裝。

安裝步驟

git clone https://github.com/kazuph/mcp-obsidian.git
cd mcp-obsidian
npm install
npm run build

配置指南

1. 確保 Claude Desktop 已安裝並運行。
2. 如果尚未安裝，全局安裝 tsx：

npm install -g tsx
# 或者使用pnpm
pnpm add -g tsx

3. 修改你的 Claude Desktop 配置文件，路徑為：~/Library/Application Support/Claude/claude_desktop_config.json。可通過以下步驟輕鬆找到該文件：
   1. 打開 Claude Desktop。
   2. 點擊菜單欄中的“Claude”。
   3. 選擇“設置”。
   4. 再次點擊“開發者”。 在配置文件中添加以下內容：

{
  "tools": {
    "obsidian": {
      "args": ["tsx", "/path/to/mcp-obsidian/index.ts"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

可用工具

• obsidian_read_notes：讀取多個筆記的內容，每個筆記的內容將與其路徑一同返回。
• obsidian_search_notes：按名稱搜索筆記（不區分大小寫，支持部分匹配和正則表達式）。
• obsidian_read_notes_dir：列出指定路徑下的目錄結構。
• obsidian_write_note：在指定路徑下創建新筆記。