MCP Obsidian

MCP Obsidian

site icon
2025.03.10 1
TypeScript笔记管理AI 助手集成开发效率
MCP Obsidian 是一个基于 Model Context Protocol (MCP) 的服务实现,用于与 Obsidian 笔记应用集成。它允许 AI 助手读取、创建和操作 Obsidian 中的笔记,提供了一系列功能来增强笔记管理和搜索能力。
View on GitHub

Overview

基本能力

产品定位

MCP Obsidian 是一个用于增强 Obsidian 笔记应用功能的服务器实现,通过 MCP 协议与 AI 助手集成,提供笔记管理和搜索功能。

核心功能

  • 读取当前活动文件
  • 删除当前活动文件
  • 在特定位置插入内容(标题、块引用、frontmatter)
  • 追加内容到文件
  • 打开特定文件
  • 列出保险库中的文件
  • 搜索笔记

适用场景

  • AI 助手辅助笔记管理
  • 自动化笔记操作
  • 笔记内容搜索和检索

工具列表

  • get_active_file: 返回当前活动文件的内容
  • delete_active_file: 删除当前活动文件
  • insert_active_file: 在特定位置修改内容
  • append_active_file: 在文件末尾追加内容
  • open_file: 打开特定文件
  • search_simple: 搜索匹配文本查询的文档
  • list_files: 列出保险库根目录中的文件
  • list_directory_files: 列出特定目录中的文件

常见问题解答

  • 如何配置环境变量? 编辑 .env 文件,设置 OBSIDIAN_BASE_URLOBSIDIAN_TOKEN
  • 如何添加新工具? 在 src/tools/ 目录下创建新文件,实现工具并使用 MCP SDK 注册。

使用教程

使用依赖

  • Bun 运行时
  • Obsidian 桌面应用
  • 兼容 MCP 的 AI 助手

安装教程

  1. 克隆仓库: bash git clone https://github.com/gregkonush/mcp-obsidian.git cd mcp-obsidian
  2. 安装依赖: bash bun install
  3. 配置环境变量: bash cp .env.example .env

调试方式

启动 MCP 服务器:

bun run src/index.ts

服务器将通过标准 I/O 与 MCP 兼容的 AI 助手通信。

许可证

该项目遵循 MIT 开源许可条款。