基本能力
产品定位
Obsidian MCP 是一个桥梁工具,连接AI助手与Obsidian知识库,实现自动化管理和操作笔记。
核心功能
- 读取笔记内容:支持读取特定笔记或当前活动笔记的内容。
- 笔记列表管理:递归列出整个知识库或指定文件夹下的文件和文件夹。
- 笔记编辑:支持在现有笔记中插入内容,可相对于标题、块引用或frontmatter字段进行操作。
- 高级搜索:使用JsonLogic格式查询搜索Obsidian笔记。
适用场景
- AI助手集成:允许AI助手直接与Obsidian知识库交互,实现自动化笔记管理。
- 批量笔记处理:可以批量读取、编辑或搜索笔记内容。
- 自动化工作流:与其他工具集成,创建自动化知识管理流程。
工具列表
- readNote - 读取特定笔记的内容
- readActiveNote - 读取当前活动笔记的内容
- listNotes - 递归列出知识库中的文件和文件夹
- patchNote - 在现有笔记中插入内容
- searchWithJsonLogic - 使用JsonLogic格式查询搜索笔记
常见问题解答
- 需要先安装并配置Obsidian的Local REST API插件
- 需要生成API密钥用于认证
- 开发时需要配置.env文件中的apiKey、port和host参数
使用教程
使用依赖
- Node.js 18或更高版本
- 已安装并配置Local REST API插件
- 从Local REST API插件生成的API密钥
安装教程
- 克隆仓库
- 安装依赖:
npm install
- 构建项目:
npm run build
- 配置Claude Desktop App使用此MCP服务器(示例配置见原始README)
调试方式
- 创建并配置.env文件,设置apiKey、port和host参数
- 运行构建后的index.js文件进行测试