MCP Obsidian

🚀 Obsidian 的 MCP 服務器

MCP 服務器可藉助 Obsidian 社區插件的 Local REST API 與 Obsidian 進行交互，為用戶提供便捷的操作體驗。

🚀 快速開始

📦 安裝指南

Obsidian REST API

需安裝並啟用 Obsidian REST API 社區插件：https://github.com/coddingtonbear/obsidian-local-rest-api 。在設置中完成安裝與啟用操作後，複製 API 密鑰。

Claude Desktop

• MacOS：配置文件路徑為 ~/Library/Application\ 支持/Claude/claude_desktop_config.json。
• Windows：配置文件路徑為 %APPDATA%/Claude/claude_desktop_config.json%。

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY" : "<YOUR_OBSIDIAN_API_KEY>"
      }
    }
  }
}

✨ 主要特性

🔧 工具

該服務器實現了多個工具以與 Obsidian 交互：

• list_files_in_vault：列出 vault 根目錄中的所有文件和目錄。
• list_files_in_dir：列出特定 Obsidian 目錄中的所有文件和目錄。
• get_file_contents：返回 vault 中單個文件的內容。
• search：在 vault 中的所有文件中搜索與指定文本查詢匹配的文檔。
• patch_content：相對於標題、塊引用或前端字段插入內容到現有筆記中。
• append_content：追加內容到新文件或現有文件中。
• delete_file：從 vault 中刪除文件或目錄。

💡 示例提示

首先指示 Claude 使用 Obsidian，然後它將始終調用工具。可使用以下提示：

• 獲取上次架構通話筆記的內容並總結它們。
• 搜索所有提到 Azure CosmosDb 的文件，並快速解釋其上下文。
• 總結上次會議記錄並將它們放入新筆記 'summary meeting.md' 中。添加介紹以便我可以通過電子郵件發送。

📚 詳細文檔

⚙️ 配置

Obsidian REST API 密鑰

有兩種方式配置環境以使用 Obsidian REST API 密鑰。

1. 添加到服務器配置（推薦）

{
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY": "<your_api_key_here>",
      "OBSIDIAN_HOST": "<your_obsidian_host>"
    }
  }
}

2. 在工作目錄中創建一個 .env 文件 包含以下所需變量：

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host

⚠️ 重要提示

您可以在 Obsidian 插件配置中找到密鑰。

🔧 技術細節

🛠️ 構建

要準備分發包，需同步依賴項並更新鎖定文件：

uv sync

🐞 調試

由於 MCP 服務器通過 stdio 運行，調試可能具有挑戰性。為了獲得最佳的調試體驗，我們強烈推薦使用 MCP 檢查器。

您可以通過以下命令啟動 MCP 檢查器：

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian

啟動後，檢查器會顯示一個 URL，您可以在瀏覽器中訪問以開始調試。

您還可以通過以下命令查看服務器日誌：

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log