Obsidian MCP Server

Obsidian MCP Server

site icon
2025.02.17 0
TypeScript知识管理AI集成开发效率
Obsidian MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,专为大型语言模型 (LLMs) 与 Obsidian 知识库交互而设计。它使用 TypeScript 构建,提供安全的 API 通信、高效的文件操作和全面的搜索功能,使 AI 助手能够通过简洁灵活的工具界面无缝管理知识库。
View on GitHub

Overview

基本能力

产品定位

Obsidian MCP Server 是一个连接大型语言模型与 Obsidian 知识库的中间件服务,旨在通过标准化接口实现 AI 与知识管理系统的深度集成。

核心功能

  1. 文件操作
  2. 原子性文件/目录操作与验证
  3. 资源监控与清理

  4. 搜索系统

  5. 可配置上下文的全文搜索
  6. 支持 JsonLogic 高级查询(文件、标签和元数据)
  7. 支持 glob 模式和 frontmatter 字段

  8. 属性管理

  9. YAML frontmatter 解析与智能合并
  10. 自动时间戳管理
  11. 自定义字段支持

  12. 安全与性能

  13. API 密钥认证与速率限制
  14. SSL 选项支持
  15. 资源监控与健康检查

适用场景

  • AI 助手管理 Obsidian 知识库
  • 自动化知识整理与分类
  • 智能搜索与内容提取
  • 批量元数据管理

工具列表

  1. 文件管理工具
  2. 列出保险库内容
  3. 获取文件内容
  4. 目录内容浏览

  5. 搜索操作工具

  6. 带上下文的文本搜索
  7. 基于 JsonLogic 的高级搜索

  8. 内容修改工具

  9. 文件内容追加
  10. 文件内容替换

  11. 命令管理工具

  12. 列出可用命令
  13. 执行特定命令

  14. 文件导航工具

  15. 在 Obsidian 中打开文件
  16. 获取活动文件内容
  17. 获取周期性笔记

  18. 属性管理工具

  19. 获取所有标签
  20. 获取/更新笔记属性

常见问题解答

  • 需要先在 Obsidian 中启用 Local REST API 插件
  • Windows 用户需要特别注意 SSL 证书配置
  • 所有错误都包含 5 位错误代码便于诊断

使用教程

使用依赖

  1. 安装 Node.js (推荐 LTS 版本)
  2. 在 Obsidian 中启用 Local REST API 插件

安装教程

  1. 克隆并构建:
git clone [email protected]:cyanheads/obsidian-mcp-server.git
cd obsidian-mcp-server
npm install
npm run build

或通过 npm 安装:

npm install obsidian-mcp-server

调试方式

  1. 检查环境变量配置是否正确
  2. 验证 API 密钥是否有效
  3. 检查 Obsidian Local REST API 是否正常运行
  4. 使用以下命令测试连接:
curl -X GET "http://127.0.0.1:27124/vault" -H "Authorization: Bearer your_api_key"

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。