使用说明

项目简介

MCP Obsidian 是一个 Model Context Protocol (MCP) 服务器，旨在将您的 Obsidian 知识库集成到支持 MCP 协议的 LLM 客户端（如 Claude Desktop）中。通过 MCP Obsidian，LLM 可以访问和利用您在 Obsidian 中积累的笔记内容，从而实现更智能、更个性化的交互体验。

主要功能点

笔记内容读取: 允许 LLM 读取指定路径下的 Obsidian 笔记内容，为 LLM 提供上下文信息。
笔记名称搜索: 支持通过关键词搜索 Obsidian 笔记，帮助 LLM 快速定位相关信息。
目录结构读取: 允许 LLM 获取 Obsidian 知识库的目录结构，方便 LLM 理解知识库的组织方式。
新建笔记: 支持 LLM 在指定路径下创建新的 Obsidian 笔记，扩展 LLM 的知识管理能力。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js (版本 18 或更高)。您可以通过 Node.js 官网下载安装。

安装 MCP Obsidian: 使用 git 克隆仓库到本地：

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

服务器配置

要将 MCP Obsidian 服务器与 MCP 客户端（例如 Claude Desktop）连接，您需要配置客户端的配置文件。以 Claude Desktop 为例，配置文件通常位于 '~/Library/Application Support/Claude/claude_desktop_config.json'。

请将以下 JSON 配置添加到 Claude Desktop 的 'claude_desktop_config.json' 文件中的 'tools' 字段下：

{
  "tools": {
    "obsidian": {
      "command": "npx",  // 启动命令，使用 npx 运行 npm 包
      "args": ["-y", "@kazuph/mcp-obsidian"], // 命令参数，-y 表示自动确认安装，@kazuph/mcp-obsidian 是 npm 包名
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault" // 环境变量，指定 Obsidian 知识库的路径，**请替换为您的 Obsidian 知识库的实际路径**
      }
    }
  }
}

请务必将 '/path/to/your/obsidian/vault' 替换为您本地 Obsidian 知识库的实际路径。 您可以通过 Obsidian 软件的“设置” -> “关于” 页面找到您的知识库路径。

基本使用方法

配置完成后，启动 Claude Desktop 或其他 MCP 客户端。客户端将自动连接到 MCP Obsidian 服务器。

您可以通过自然语言指令指示 LLM 使用 Obsidian 的工具。例如，在 Claude Desktop 中，您可以这样提问：

"搜索关于 [[主题]] 的笔记" (LLM 可能会调用 'obsidian_search_notes' 工具，搜索包含 "主题" 的笔记)
"读取笔记 [[笔记路径]] 的内容" (LLM 可能会调用 'obsidian_read_notes' 工具，读取指定路径的笔记内容)
"列出 [[目录路径]] 下的目录结构" (LLM 可能会调用 'obsidian_read_notes_dir' 工具，获取指定目录下的目录列表)
"创建一个名为 [[新笔记路径]] 的笔记，内容是 [[笔记内容]]" (LLM 可能会调用 'obsidian_write_note' 工具，创建新的笔记)

具体的工具调用方式取决于 LLM 客户端的实现和 Prompt 设计。您可以参考 LLM 客户端的文档，了解如何更有效地利用 MCP Obsidian 提供的工具。

注意： MCP Obsidian 服务器通过标准输入/输出 (stdio) 与 MCP 客户端通信。启动服务器后，您可能看不到明显的界面，服务器在后台运行并等待客户端的请求。

关键词