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 代理將你的知識庫當作遠端檔案系統使用,支援細粒度補丁、搜尋、命令執行和可擴展性。

相關

  • 專案
  • 專案
  • 專案
  • 專案
  • 專案