mcp-obsidian 终极指南：如何通过 AI 助手快速管理你的 Obsidian 知识库

【免费下载链接】mcp-obsidian MCP server that interacts with Obsidian via the Obsidian rest API community plugin 项目地址: https://gitcode.com/gh_mirrors/mc/mcp-obsidian

mcp-obsidian 是一款强大的 MCP 服务器工具，它通过 Obsidian 的 Local REST API 社区插件实现与 Obsidian 的无缝交互，让你能够借助 AI 助手轻松管理 Obsidian 知识库，极大提升知识管理效率。

为什么选择 mcp-obsidian？🌟

在信息爆炸的时代，高效管理个人知识库变得越来越重要。Obsidian 作为一款优秀的本地知识库工具，深受知识工作者喜爱。而 mcp-obsidian 的出现，更是为 Obsidian 增添了强大的 AI 助力。它就像你的私人知识管家，能够帮助你快速检索、整理和管理笔记，让你从繁琐的手动操作中解放出来，专注于知识的创造和吸收。

核心功能一览 🚀

mcp-obsidian 提供了丰富的工具来满足你对 Obsidian 知识库的各种管理需求，主要包括以下几类：

文件管理工具

• 列出 vault 根目录文件：使用 obsidian_list_files_in_vault 工具，可以快速获取 Obsidian vault 根目录下的所有文件和目录信息，让你对知识库的整体结构一目了然。
• 列出指定目录文件：通过 obsidian_list_files_in_dir 工具，只需提供相对路径，就能列出该目录下的所有文件和目录，方便你定位特定位置的内容。
• 获取文件内容：借助 obsidian_get_file_contents 工具，输入文件相对路径，即可获取该文件的内容，无需手动打开文件查看。
• 批量获取文件内容：obsidian_batch_get_file_contents 工具允许你一次性获取多个文件的内容，并以带标题的形式拼接，方便你同时查看多篇笔记。
• 创建/更新文件内容：使用 obsidian_put_content 工具，可以创建新文件或更新现有文件的内容，轻松实现笔记的添加和修改。
• 追加内容到文件：obsidian_append_content 工具能将指定内容追加到已有文件或新文件中，非常适合在现有笔记基础上补充信息。
• 删除文件/目录：通过 obsidian_delete_file 工具，在确认后可以删除指定的文件或目录，帮助你清理知识库。

高级编辑工具

• 精准插入内容：obsidian_patch_content 工具支持在现有笔记中相对于标题、块引用或 frontmatter 字段插入内容，可执行追加、前置或替换操作，让笔记编辑更加灵活精准。

搜索工具

• 简单搜索：obsidian_simple_search 工具可以根据指定文本在整个 vault 中进行简单搜索，还能设置返回匹配字符串周围的上下文长度，帮助你快速找到包含特定信息的笔记。
• 复杂搜索：obsidian_complex_search 工具支持使用 JsonLogic 查询进行复杂搜索，可结合 glob 和 regexp 等模式匹配，例如查找特定文件夹中包含特定内容的 markdown 文件，满足你更精细的搜索需求。

周期性笔记工具

• 获取当前周期笔记：obsidian_get_periodic_note 工具能获取指定周期（每日、每周、每月、每季度、每年）的当前周期性笔记，可选择获取内容或元数据（包含路径、标签等信息）。
• 获取最近周期笔记：obsidian_get_recent_periodic_notes 工具可以获取指定周期类型的最近几条周期性笔记，并可选择是否包含内容，方便你回顾近期的周期性记录。

变更追踪工具

• 获取最近修改文件：obsidian_get_recent_changes 工具能够列出最近修改的文件，你可以指定返回的最大文件数量和时间范围（天数），轻松掌握知识库的更新动态。

快速上手指南 📚

准备工作

1. 安装 Obsidian REST API 插件：你需要在 Obsidian 中安装并启用 Local REST API 社区插件，具体可参考 Obsidian REST API 插件地址。安装完成后，在插件设置中获取 API 密钥。

2. 克隆项目仓库：使用以下命令克隆 mcp-obsidian 项目仓库：

   git clone https://gitcode.com/gh_mirrors/mc/mcp-obsidian
   

配置环境

mcp-obsidian 提供了两种配置 Obsidian REST API 密钥的方式：

方式一：添加到服务器配置（推荐）

在服务器配置文件中添加以下内容：

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

如果 Claude 无法检测到 uv/uvx 的位置，可以使用 which uvx 命令找到其完整路径并替换上述配置中的 "uvx"。

方式二：创建 .env 文件

在工作目录中创建一个 .env 文件，并添加以下必填变量：

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host
OBSIDIAN_PORT=your_obsidian_port

注意：API 密钥可在 Obsidian 插件配置中找到；默认端口为 27124，默认主机为 127.0.0.1，如未特殊设置可使用默认值。

Claude Desktop 配置

根据你的操作系统，找到 Claude Desktop 的配置文件：

• MacOS：~/Library/Application\ Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%/Claude/claude_desktop_config.json

然后根据服务器是否已发布，选择相应的配置方式添加到 mcpServers 中。

开发/未发布服务器配置

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "<your_api_key_here>",
        "OBSIDIAN_HOST": "<your_obsidian_host>",
        "OBSIDIAN_PORT": "<your_obsidian_port>"
      }
    }
  }
}

已发布服务器配置

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

实用示例提示词 💡

配置完成后，你可以像这样指导 Claude 使用 Obsidian 工具：

• “获取上次架构会议笔记的内容并进行总结”
• “搜索所有提到 Azure CosmosDb 的文件，并简要解释其提及的上下文”
• “总结上次会议笔记，并将其放入新笔记 'summary meeting.md' 中。添加一个引言，以便我可以通过电子邮件发送”

通过这些简单的提示，AI 助手就能利用 mcp-obsidian 的强大功能，帮你完成各种知识库管理任务。

开发与调试 🔧

构建

要准备用于分发的包，可执行以下命令同步依赖项并更新锁文件：

uv sync

调试

由于 MCP 服务器通过标准输入输出运行，调试可能具有一定挑战性。为获得最佳调试体验，强烈推荐使用 MCP Inspector。你可以通过 npm 使用以下命令启动 MCP Inspector：

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

启动后，Inspector 会显示一个 URL，你可以在浏览器中访问该 URL 开始调试。

你还可以使用以下命令查看服务器日志：

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

总结

mcp-obsidian 为 Obsidian 用户提供了强大的 AI 辅助功能，通过丰富的工具集和简单易用的配置，让你能够更高效地管理和利用自己的知识库。无论是日常的笔记整理、内容搜索，还是周期性笔记的管理，mcp-obsidian 都能成为你得力的助手，帮助你在知识的海洋中轻松航行。现在就尝试使用 mcp-obsidian，开启你的智能知识库管理之旅吧！

【免费下载链接】mcp-obsidian MCP server that interacts with Obsidian via the Obsidian rest API community plugin 项目地址: https://gitcode.com/gh_mirrors/mc/mcp-obsidian