关键词

Obsidian笔记管理本地知识库文档搜索LLM插件

使用说明

项目简介

Obsidian Reader MCP (Model Context Protocol) 服务器是一个连接器，它允许LLM客户端（如Claude Desktop）访问和搜索您本地的Obsidian笔记库。通过此服务器，LLM可以读取您的笔记内容，从而在对话中更好地理解上下文信息。

主要功能点

  • 读取笔记内容：允许LLM客户端读取指定路径的Markdown笔记文件内容。
  • 搜索笔记：支持关键词搜索笔记文件名，帮助LLM客户端快速定位相关笔记。
  • 安全访问控制：仅允许访问预先配置的Obsidian库目录下的文件，保障数据安全。

安装步骤

  1. 确保您已安装 Claude Desktop 和 npm (Node.js 包管理器)。
  2. 使用 npm 安装 Obsidian Reader MCP 服务器： 
    npx @smithery/cli install mcp-obsidian --client claude
  3. 重启 Claude Desktop 以加载 MCP 工具。

服务器配置

要将 Obsidian Reader MCP 服务器配置到 MCP 客户端，您需要提供以下 JSON 格式的配置信息。以 Claude Desktop 为例，您需要在客户端中配置以下信息：

{
  "serverName": "mcp-obsidian",
  "command": "mcp-obsidian",
  "args": ["<your_obsidian_vault_directory>"],
  "args_comment": ["将 '<your_obsidian_vault_directory>' 替换为您的Obsidian库的绝对路径。例如：'/Users/yourusername/ObsidianVault'"]
}

配置参数说明：

  • 'serverName': MCP 服务器的名称，这里设置为 "mcp-obsidian"。
  • 'command': 启动 MCP 服务器的命令，这里设置为 "mcp-obsidian"，前提是 'mcp-obsidian' 命令在您的系统路径中可用 (通过 npm 安装后通常会自动添加到路径)。
  • 'args': 传递给 'mcp-obsidian' 命令的参数，这里需要您提供 Obsidian 库的根目录的绝对路径。请将 '<your_obsidian_vault_directory>' 替换为实际的路径。
  • 'args_comment': 参数的注释，用于解释 'args' 的作用。

基本使用方法

安装并配置服务器后，在支持MCP协议的LLM客户端（如Claude Desktop）中，您可以使用 'read_notes' 工具读取指定路径的笔记，或使用 'search_notes' 工具搜索相关笔记。LLM会根据工具返回的内容进行后续操作，例如在对话中引用笔记内容。

工具列表：

  • 'read_notes': 读取指定路径的笔记文件内容。
  • 'search_notes': 根据关键词搜索笔记文件名。

使用示例 (假设在 Claude Desktop 中)： 在 Claude 的对话框中，您可以指示 Claude 使用这些工具。例如：

  • "请读取我的 'Project A/notes.md' 笔记内容。" (Claude 可能会调用 'read_notes' 工具)
  • "搜索关于 '会议记录' 的笔记。" (Claude 可能会调用 'search_notes' 工具)

客户端的具体使用方式取决于客户端的界面和指令，请参考您使用的 MCP 客户端的文档。

信息

分类

数据库与文件

访问项目