coddingtonbear/obsidian-local-rest-api

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

是什么

obsidian-local-rest-api 是一个在桌面应用内运行小型 HTTPS 服务器的 Obsidian 插件。该服务器公开了一个 REST API(以及内置的 Model Context Protocol – MCP 服务器),允许外部程序(脚本、浏览器扩展或 AI 代理)读取、写入、搜索和操作你的知识库中的笔记。

核心功能

功能 工作方式
文件 CRUD /vault/{path} 执行 GET/PUT/POST/PATCH/DELETE 可获取、创建、替换、部分更新或删除任意 Markdown 或二进制文件。
精准编辑 使用 PATCH(JSON 身体或头部驱动的“raw-content”模式)可修改单个标题、块引用或 front-matter 键——追加、前置、替换、删除或移动,而无需重写整个文件。
当前文件 /active/ 会镜像 Obsidian UI 中当前打开的笔记,因此代理可以读取或更新你正在处理的文件。
搜索 /search/simple/ 执行 Obsidian 的模糊搜索;/search/ 接受 JsonLogic 表达式,用于按元数据(标签、front-matter、路径、内容)过滤。
命令与 UI /commands/ 列出所有 Obsidian 命令;向 /commands/{id}/ 发送 POST 请求可执行某一条命令。/open/{path} 会通知 UI 打开一个笔记。
标签概览 /tags/ 返回知识库中所有标签及其使用次数。
MCP 服务器 相同功能也可通过 Model Context Protocol(/mcp/)访问,这是一种由 Claude Code、Claude Desktop(通过 mcp-remote)、Cursor 等 AI 工具使用的流式 HTTP 协议。
可扩展性 其他插件可通过提供的扩展 API 注册额外路由或 MCP 工具。

如何与之通信

  • 服务器运行在 https://127.0.0.1:27124/(使用自签名证书的 HTTPS)上,可选地在启用后也通过普通 HTTP http://127.0.0.1:27123/ 运行。
  • 认证使用 Bearer token,在 Obsidian 的 设置 → 本地 REST API 中显示。
  • 示例 curl 命令列出知识库根目录:
curl -k -H "Authorization: Bearer <key>" https://127.0.0.1:27124/vault/
  • 对于支持 MCP 的客户端,将其指向 https://127.0.0.1:27124/mcp/ 并提供相同的 bearer token 即可。

为何对 AI 至关重要

AI 代理通常需要对知识库进行实时访问。通过将知识库通过标准 HTTP API 暴露,该插件使 LLM 驱动的助手(Claude、Cursor、自定义机器人等)能够 读取上下文、更新笔记、执行搜索、触发 Obsidian 命令,而无需手动复制粘贴。MCP 层增加了流式、会话感知的协议,符合新兴的 Model Context Protocol 规范,使已理解 MCP 的工具集成更加顺畅。

快速上手

  1. 从 Obsidian 社区插件商店安装该插件。
  2. 启用插件;记下生成的 API 密钥并下载自签名证书。
  3. 使用位于 https://coddingtonbear.github.io/obsidian-local-rest-api/ 的交互式 Swagger 风格文档查看请求示例。
  4. 根据 README 中的说明,将你的 AI 客户端(Claude Code、Claude Desktop(通过 mcp-remote)、Cursor 等)配置为使用该端点和令牌。

谁可能使用它

  • 需要读写自己笔记的个人 AI 助手开发者。
  • 希望将知识库与外部数据源同步的自动化脚本。
  • 正在实验 LLM 驱动的笔记记录或知识图谱构建的研究人员。

TL;DR: 一个安全、经过认证的 HTTP 接口(REST + MCP),让脚本和 AI 代理将你的知识库当作远程文件系统使用,支持细粒度补丁、搜索、命令执行和可扩展性。

相关

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