MCP Obsidian

一个用于与 Obsidian 集成的 Model Context Protocol (MCP) 服务器实现。这允许 AI 助手读取、创建和操作您 Obsidian 库中的笔记。

功能

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

先决条件

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

添加到光标

将您的密钥放在 .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 - 根据标题、块引用或前言字段修改内容
• append_active_file - 将内容追加到活动文件的末尾
• open_file - 在 Obsidian 中打开特定文件
• search_simple - 搜索匹配文本查询的文档
• list_files - 列出库根目录中的文件
• list_directory_files - 列出库中特定目录下的文件

开发

项目结构

mcp-obsidian/
├── src/
│   ├── index.ts            # Main server implementation
│   └── tools/              # Individual tool implementations
│       ├── get-active-file.ts
│       ├── delete-active-file.ts
│       └── ...
├── .env                    # Environment configuration
├── package.json            # Project dependencies
└── tsconfig.json           # TypeScript configuration

添加新工具

要添加新工具：

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

许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE.md 文件。

贡献

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