项目简介

Obsidian MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用,旨在将您的 Obsidian 知识库与兼容 MCP 的 LLM 客户端(如 Claude Desktop)无缝集成。它允许外部 AI 应用安全地访问和操作您的笔记数据。

主要功能点

  • 读取笔记: 允许 AI 模型访问您的 Obsidian 笔记内容进行分析、总结等。
  • 创建和修改笔记: 使 AI 模型能够在您的 Obsidian 知识库中生成新笔记或更新现有笔记。
  • 搜索知识库: 支持 AI 模型对您的笔记进行搜索,查找相关信息。

安装步骤

  1. 安装 Node.js: 确保您的系统安装了 Node.js 版本 20 或更高。您可以从 nodejs.org 下载安装包。
  2. 安装 Obsidian Local REST API 插件:
    • 打开您的 Obsidian Vault。
    • 进入设置 -> 社群插件。
    • 关闭“受限模式”并启用社群插件。
    • 浏览并搜索安装 'Local REST API' 插件 (由 'pjeby' 开发)。
    • 安装后启用该插件。
    • 在插件设置中,生成并复制一个新的 API Key。请妥善保管此密钥,它非常重要且敏感。
  3. 确保安装兼容的 MCP 客户端: 本指南以 Claude Desktop 为例,请确保您已安装该客户端。其他兼容 MCP 协议的客户端理论上也可使用。

服务器配置 (供 MCP 客户端使用)

MCP 服务器本身通常通过客户端启动。您需要在您的 MCP 客户端(如 Claude Desktop)中进行配置,告诉客户端如何启动并连接到 Obsidian MCP Server。

对于 Claude Desktop,您需要编辑其配置文件 '%APPDATA%\Claude\claude_desktop_config.json'。在该文件的 'mcpServers' 部分添加如下配置,指向通过 'npx' 命令运行的服务器:

{
  "mcpServers": {
    "obsidian": { // 此处定义一个服务器名称,客户端会识别并显示
      "command": "npx", // 用于执行 Node.js 包的命令
      "args": [ // 传递给命令的参数列表
        "-y", // npx 参数,自动确认安装包
        "obsidian-mcp", // 要运行的 MCP 服务器 npm 包名
        "YOUR_OBSIDIAN_VAULT_PATH_HERE" // 第一个参数:您的 Obsidian Vault 文件夹的完整路径
        // 可选参数:如果需要指定端口,可添加 "--port", "新的端口号"
      ],
      "env": { // 通过环境变量传递配置信息
        "OBSIDIAN_API_KEY": "YOUR_ACTUAL_OBSIDIAN_API_KEY_HERE" // 环境变量:Obsidian API Key
      }
    }
    // 如果您有其他 MCP 服务器配置,请在此下方添加,并用逗号分隔
  }
}
  • 请将 'YOUR_OBSIDIAN_VAULT_PATH_HERE' 替换为您 Obsidian Vault 文件夹的实际绝对路径 (例如 Windows 系统可能是 '"C:/Users/YourUser/Documents/MyVault"' 或 '"C:\Users\YourUser\Documents\MyVault"')。
  • 请将 'YOUR_ACTUAL_OBSIDIAN_API_KEY_HERE' 替换为您在 Obsidian Local REST API 插件中生成的 API Key。
  • 如果 'claude_desktop_config.json' 文件已存在其他配置,请务必正确添加新的 'obsidian' 条目,并检查逗号和括号是否匹配。建议使用在线 JSON 验证工具(如 jsonlint.com)检查整个文件语法。

基本使用方法

  1. 完成上述客户端配置后,请完全关闭(确保在任务管理器中结束所有相关进程)并重新启动您的 MCP 客户端 (如 Claude Desktop)。
  2. 客户端启动时应会自动检测并启动配置的 Obsidian MCP Server。
  3. 在客户端界面中查找与 Obsidian 集成相关的选项或功能。现在,AI 模型应该能够通过服务器访问和操作您的 Obsidian 笔记了。
  4. 如遇连接问题,请检查客户端日志(如 'mcp-debug.log')或按照项目仓库 README 中的故障排除章节进行排查。

信息

分类

AI与计算