MCP Obsidian

这是一个 模型上下文协议 (MCP) 的服务器实现，用于与 Obsidian 集成。它允许 AI 助手读取、创建和操作您的 Obsidian vault 中的笔记。

功能

• 读取 Obsidian 中当前活动的文件
• 删除当前活动的文件
• 在特定位置（标题、块引用、frontmatter）插入内容
• 将内容追加到文件
• 打开特定文件
• 列出您的 vault 中的文件
• 搜索您的笔记

前提条件

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

添加到 Cursor

将您的密钥放入 .env 文件中

选择命令 MCP 然后输入此命令

bun __REPO_PATH__/src/index.ts

安装

1. 克隆此仓库：

   git clone https://github.com/gregkonush/mcp-obsidian.git
   cd mcp-obsidian
   

2. 安装依赖项：

   bun install
   

3. 复制示例环境变量文件并进行配置：

   cp .env.example .env
   

配置

编辑 .env 文件，使用您的特定配置：

OBSIDIAN_BASE_URL=http://localhost:27123
OBSIDIAN_TOKEN=your_token_here
DEBUG=false

使用

启动 MCP 服务器：

bun run src/index.ts

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

可用工具

此实现向 AI 助手提供以下工具：

• get_active_file - 返回当前活动文件的内容
• delete_active_file - 删除当前活动文件
• insert_active_file - 修改相对于标题、块引用或 frontmatter 字段的内容
• append_active_file - 将内容追加到活动文件的末尾
• open_file - 在 Obsidian 中打开特定文件
• search_simple - 搜索与文本查询匹配的文档
• list_files - 列出您的 vault 根目录中的文件
• list_directory_files - 列出您的 vault 特定目录中的文件

开发

项目结构

mcp-obsidian/
├── src/
│   ├── index.ts            # 主要服务器实现
│   └── tools/              # 单独的工具实现
│       ├── get-active-file.ts
│       ├── delete-active-file.ts
│       └── ...
├── .env                    # 环境变量配置
├── package.json            # 项目依赖
└── tsconfig.json           # TypeScript 配置

添加新工具

要添加新工具：

1. 在 src/tools/ 目录中创建一个新文件
2. 使用 MCP SDK 实现该工具
3. 在 src/index.ts 中导入并注册该工具

许可证

此项目根据 MIT 许可证授权 - 有关详细信息，请参阅 LICENSE.md 文件。

贡献

欢迎贡献！请随时提交 Pull Request。