
coddingtonbear/obsidian-local-rest-api
API developmentこのページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る
Vault のための安全なREST APIとModel Context Protocol(MCP)サーバー。
概要
スクリプト、ブラウザ拡張機能、AIエージェントが安全で認証済みのREST APIを通じてObsidianのVaultに直接アクセスできるようにします。 https://coddingtonbear.github.io/obsidian-local-rest-api/ または — 両方のインターフェースは同じコア機能を公開しているため、スクリプト、ブラウザ拡張機能、AIエージェントはすべて同じ言語を話します。 - — Vault 内の任意のファイル(バイナリファイルを含む)にフル CRUD - — 見出し、ブロック参照、フロントマターキーをターゲットにし、そのセクションだけを付け加えたり、前置いだり、置換したり、ファイルの他の部分には手を加えない - — 簡単な全文検索やノートメタデータ(フロントマター、タグ、パス、コンテンツ)に対する構造化JsonLogicクエリ - — Obsidianで現在開いているノートを読み書きする - デイリー、ウィークリー、マンスリー、四半期、年次ノートの取得または作成 - — コマンドパレットを使ったかのようにObsidianのコマンドを発動する - Vault 内のすべてのタグに使用回数をリストアップする - ObsidianにUIで特定のノートを開くよう指示する —...
概要(AI 翻訳)
スクリプト、ブラウザ拡張機能、AIエージェントが安全で認証済みのREST APIを通じてObsidianのVaultに直接アクセスできるようにします。
-
インタラクティブAPIドキュメント: https://coddingtonbear.github.io/obsidian-local-rest-api/
-
Obsidianコミュニティページ: https://community.obsidian.md/plugins/obsidian-local-rest-api/
-
できること
-
クイックスタート
- REST API
- MCPクライアント
- クロード・コード
- Claude Desktop
- カーソル
- その他のクライアント
- API概要
- 設定ディレクトリは立ち入り禁止
- 認証に失敗すると制限されます
- 条件付き書き込み
- ブラウザクライアントとレスポンスヘッダー
- パッチノート
- 生コンテンツモード
- 特定のセクションをターゲットにする
- 探索
- イベントストリーム
- サーバー状態
- MCP(モデルコンテキストプロトコル)
- プロトコル改訂
- クライアントとの接続
- 利用可能なツール
- バイナリファイルおよび添付ファイル
- 署名済みURL
- 利用可能なリソース
- API拡張
- 型付き拡張API
- ホストが再ロードした後に再度登録
- MCPツール、リソース、プロンプト
- ルートの記録
- 注釈の下にサブリソース
- エクステンションイベント
- 拡張状態
- 既知の拡張
- 貢献
- クレジット
あなたにできること
このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。
README
以下は原文 README の抜粋です。原文を見る。
Local REST API with MCP
Give your scripts, browser extensions, and AI agents a direct line into your Obsidian vault via a secure, authenticated REST API.
-
Interactive API docs: https://coddingtonbear.github.io/obsidian-local-rest-api/
-
Obsidian Community page: https://community.obsidian.md/plugins/obsidian-local-rest-api/
What you can do
Access your vault through the REST API or the built-in MCP server — both interfaces expose the same core capabilities, so scripts, browser extensions, and AI agents all speak the same language.
- Read, create, update, or delete notes — full CRUD on any file in your vault, including binary files
- Surgically patch specific sections — target a heading, block reference, or frontmatter key and append, prepend, replace, delete, or move just that section without touching the rest of the file
- Search your vault — simple full-text search or structured JsonLogic queries against note metadata (frontmatter, tags, path, content)
- Follow vault events — subscribe to Obsidian events (a note created, its frontmatter changed, a file opened) as a filtered Server-Sent Events stream
インストール
npx mcp-remote@latest https://127.0.0.1:27124/mcp/ --header Authorization: Bearer <your-api-key>設定
{
"mcpServers": {
"obsidian": {
"type": "http",
"url": "https://127.0.0.1:27124/mcp/",
"headers": {
"Authorization": "Bearer <your-api-key>"
}
}
}
}