coddingtonbear/obsidian-local-rest-api

A secure REST API and Model Context Protocol (MCP) server for your vault.

解决的问题

此项目为 Obsidian 提供了一个安全、经过身份验证的 REST API 和 MCP (Model Context Protocol) 服务器,允许外部脚本、浏览器扩展和 AI 代理程序以编程方式与 Obsidian 知识库进行交互。

运作原理

它作为一个托管本地服务器的 Obsidian 插件运行。它为标准 HTTP 请求公开了一个 REST API,并为 AI 代理程序提供了一个内置的 MCP 服务器。这两个接口提供相同的核心功能,包括对知识库文件进行完整的 CRUD 操作、对特定笔记区段(标题、区块或 frontmatter)进行精确修补、以及触发 Obsidian 指令并使用全文或结构化 JsonLogic 查询来搜索知识库的能力。

适用对象

  • 开发人员:创建脚本或浏览器扩展以自动化管理 Obsidian 知识库。
  • AI 代理用户:希望将基于 LLM 的工具(如 Claude Code、Claude Desktop 或 Cursor)直接连接到其个人知识库的用户。

特色亮点

  • 精确修补 (Surgical Patching):编辑笔记的特定区段(附加、前置、替换或删除),无需重写整个文件。
  • MCP 集成:原生支持 Model Context Protocol,使 AI 代理程序能够读取和写入知识库。
  • 知识库事件:通过 Server-Sent Events 流订阅知识库变更(例如笔记创建、frontmatter 变更)。
  • 安全访问:所有请求均通过 HTTPS 服务,并使用本地生成的证书和 API 密钥进行身份验证。
  • 可扩展 API:其他插件可以通过扩展接口注册自己的自定义路由。

相关

  • 项目
  • 项目
  • 项目
  • 项目
  • 项目