关键词

Obsidian笔记知识管理个人知识库自动化

使用说明

项目简介

MCP Obsidian Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它将您的 Obsidian 知识库连接到 LLM 客户端。通过此服务器，LLM 能够以标准化的方式访问和操作您的 Obsidian 笔记，实现更智能化的知识管理和自动化流程。

主要功能点

  • Obsidian 功能集成: 将 Obsidian 的核心功能（如笔记读写、文件管理、搜索、命令执行等）以 MCP 工具的形式暴露给 LLM 客户端。
  • 丰富的工具集: 提供全面的工具，支持获取笔记内容、更新笔记、追加内容、块级/标题级修改、删除笔记、文件目录管理、全文检索、执行 Obsidian 命令以及处理周期性笔记等操作。
  • 多种传输协议支持: 支持 Stdio 和 SSE 传输模式，满足不同 LLM 客户端的连接需求。
  • 易于部署: 提供 Docker 支持，方便用户快速部署和运行 MCP Obsidian Server。

安装步骤

  1. 安装 Bun 运行时: 确保您的系统已安装 Bun 运行时环境。
  2. 安装并配置 Obsidian Local REST API 插件: 在 Obsidian 中安装并启用 Local REST API 插件，并配置 API 密钥。
  3. 克隆仓库: 使用 Git 克隆 MCP Obsidian Server 仓库到本地： 
    git clone https://github.com/beshkenadze/mcp-obsidian.git
  4. 进入仓库目录: 导航到克隆的仓库目录： 
    cd mcp-obsidian
  5. 安装依赖: 使用 Bun 安装项目依赖： 
    bun install

服务器配置

为了让 MCP 客户端（例如 Claude Desktop）连接到 MCP Obsidian Server，您需要在客户端中配置服务器启动命令和参数。以下是推荐的 JSON 格式配置信息，请根据您的实际情况进行调整：

{
  "serverName": "obsidian",  //  服务器名称，可以自定义
  "command": "npx",        //  启动命令，使用 npx 运行 npm 包
  "args": ["-y", "@beshkenadze/mcp-obsidian"], //  命令参数，运行 @beshkenadze/mcp-obsidian npm 包
  "env": {
    "OBSIDIAN_API_KEY": "YOUR_OBSIDIAN_API_KEY"  //  环境变量，替换为您的 Obsidian Local REST API 密钥
  }
}

请注意: 您需要将 'YOUR_OBSIDIAN_API_KEY' 替换为您在 Obsidian Local REST API 插件中设置的 API 密钥。

基本使用方法

  1. 配置 MCP 客户端: 在您的 MCP 客户端（如 Claude Desktop, Continue, Cursor, LibreChat 等）中，根据上述“服务器配置”部分的信息，添加并配置 MCP Obsidian Server。
  2. 启动 MCP 服务器: 在 MCP Obsidian Server 仓库目录下，运行以下命令启动服务器： 
    bun run start
    或者使用 'make start' 命令。
  3. LLM 客户端调用工具: 一旦服务器启动并成功连接到您的 MCP 客户端，您就可以在 LLM 客户端中使用预定义的工具（例如 'obsidian_get_active_file', 'obsidian_update_file' 等）来与您的 Obsidian 知识库进行交互。

信息

分类

数据库与文件

访问项目