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」モード)で、1つの見出し、ブロック参照、またはフロントマターのキーを編集できます。ファイル全体を再書き込みせずに、追加、先頭追加、置換、削除、移動が可能です。 |
| アクティブファイル | /active/ は、Obsidian UI で現在開いているノートをミラーするため、エージェントが作業中のファイルを読み書きできます。 |
| 検索 | /search/simple/ は Obsidian のファズィ検索を実行します。/search/ は JsonLogic 式を受け取り、メタデータ(タグ、フロントマター、パス、コンテンツ)でフィルタリングできます。 |
| コマンドとUI | /commands/ はすべての Obsidian コマンドを一覧表示します。/commands/{id}/ に POST すると、1つのコマンドを実行できます。/open/{path} は UI にノートを開かせるように指示します。 |
| タグ概要 | /tags/ はバウル内のすべてのタグと使用回数を返します。 |
| MCPサーバー | 同じ機能は Model Context Protocol(/mcp/)経由でも利用可能で、Claude Code、Claude Desktop(mcp-remote を通じて)、Cursor などの AI ツールで使用されます。 |
| 拡張性 | 他のプラグインは、提供された拡張 API を使って、追加のルートや MCP ツールを登録できます。 |
どうやって接続するか
- サーバーは
https://127.0.0.1:27124/(自己署名証明書付き HTTPS)で動作し、オプションでhttp://127.0.0.1:27123/(HTTP)も有効にできます。 - 認証は 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 を理解しているツールとの統合をスムーズにします。
はじめ方
- Obsidian コミュニティプラグインストアからプラグインをインストールします。
- 有効化し、生成された API キーをメモし、自己署名証明書をダウンロードします。
- https://coddingtonbear.github.io/obsidian-local-rest-api/ にあるインタラクティブな Swagger 似のドキュメントでリクエストの例を確認します。
- README に従って、AI クライアント(Claude Code、Claude Desktop(
mcp-remote経由)、Cursor など)をエンドポイントとトークンで設定します。
どんな人が使うか
- 自分のノートを読み書きできる個人用 AI アシスタントを開発する開発者。
- 外部データソースとバウルを同期したい自動化スクリプト。
- LLM で駆動されるノート作成や知識グラフ構築を実験する研究者。
TL;DR: 安全で認証済みの HTTP インターフェース(REST + MCP)を提供する Obsidian プラグイン。スクリプトや AI エージェントがバウルをリモートファイルシステムのように扱い、細かいパッチ、検索、コマンド実行、拡張性を備えています。
関連
- プロジェクト
- プロジェクト
- プロジェクト
- プロジェクト
- プロジェクト