MCPcopy Index your code
hub / github.com/RAIT-09/obsidian-agent-client

github.com/RAIT-09/obsidian-agent-client @0.11.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.11.0 ↗ · + Follow
664 symbols 1,495 edges 66 files 208 documented · 31%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Agent Client Plugin for Obsidian

GitHub Downloads License GitHub release GitHub last commit GitHub Discussions

Add to Obsidian

Buy Me A Coffee

AIエージェント(Claude Code、Codex、Gemini CLI)をObsidianに直接統合。Vault内からAIアシスタントとチャットできます。

このプラグインは、Zed の Agent Client Protocol (ACP) で構築されています。

https://github.com/user-attachments/assets/1c538349-b3fb-44dd-a163-7331cbca7824

機能

  • ノートメンション: @ノート名でノートを参照
  • 画像添付: チャットに画像をペーストまたはドラッグ&ドロップ
  • スラッシュコマンド: エージェントが提供する/コマンドを使用
  • マルチエージェント: Claude Code、Codex、Gemini CLI、カスタムエージェントを切り替え
  • マルチセッション: 複数のエージェントを別々のビューで同時実行
  • フローティングチャット: 素早くアクセスできる折りたたみ可能なチャットウィンドウ
  • モード・モデル切り替え: チャット画面からAIモデルやエージェントモードを変更
  • セッション履歴: 過去の会話を再開またはフォーク
  • チャットエクスポート: 会話をMarkdownノートとして保存
  • ターミナル統合: エージェントがコマンドを実行し結果を返す
  • MCPサポート: エージェントに設定済みのMCPサーバーがそのまま利用可能 — プラグイン側の追加設定は不要

インストール

コミュニティプラグインから(推奨)

  1. 設定 → コミュニティプラグイン → 閲覧 を開く
  2. 「Agent Client」 を検索
  3. インストール有効化 をクリック

BRAT経由(プレリリース版)

コミュニティプラグインに公開される前のプレリリース版を試すには:

  1. BRAT プラグインをインストール
  2. 設定 → BRAT → Add Beta Plugin に移動
  3. 貼り付け: https://github.com/RAIT-09/obsidian-agent-client
  4. プラグインリストから Agent Client を有効化

手動インストール

  1. リリースから main.jsmanifest.jsonstyles.css をダウンロード
  2. VaultFolder/.obsidian/plugins/agent-client/ に配置
  3. 設定 → コミュニティプラグイン でプラグインを有効化

クイックスタート

ターミナル(macOS/LinuxではTerminal、WindowsではPowerShell)を開き、以下のコマンドを実行します。

  1. エージェントとACPアダプタをインストール(例: Claude Code): bash curl -fsSL https://claude.ai/install.sh | bash # Claude Codeをインストール npm install -g @agentclientprotocol/claude-agent-acp # ACPアダプタをインストール

  2. ログイン(APIキーを使う場合はスキップ): bash claude プロンプトに従ってAnthropicアカウントで認証します。

  3. パスを確認: ```bash which node # macOS/Linux which claude-agent-acp

where.exe node # Windows where.exe claude-agent-acp ```

  1. 設定 → Agent Client で設定:
  2. Node.js path: 例: /usr/local/bin/node
  3. Built-in agents → Claude Code → Path: 例: /usr/local/bin/claude-agent-acpclaudeではない)
  4. API key: キーを追加、またはCLIでログイン済みの場合は空欄

  5. チャット開始: リボンのロボットアイコンをクリック

セットアップガイド

ドキュメント全文

開発

npm install
npm run dev

プロダクションビルド:

npm run build

ライセンス

Apache License 2.0 - 詳細は LICENSE を参照。

Star History

Star History Chart

Extension points exported contracts — how you extend this code

IChatViewContainer (Interface)
(no doc) [4 implementers]
src/services/view-registry.ts
SessionUpdateBase (Interface)
* Base interface for all session updates. * Contains the session ID that the update belongs to.
src/types/session.ts
SuggestionPopupProps (Interface)
* Props for the SuggestionPopup component. * * This component can display either note mentions or slash commands * ba
src/ui/SuggestionPopup.tsx
SessionCache (Interface)
* Cache entry for session list.
src/hooks/useSessionHistory.ts
CreateTerminalParams (Interface)
* Parameters for creating a terminal process. * * This is the TerminalManager's own parameter type, independent of the
src/acp/terminal-handler.ts
IMentionService (Interface)
(no doc) [1 implementers]
src/utils/mention-parser.ts
AgentClientPluginSettings (Interface)
(no doc)
src/plugin.ts
IVaultAccess (Interface)
(no doc) [2 implementers]
src/services/vault-service.ts

Core symbols most depended-on inside this repo

log
called by 86
src/utils/logger.ts
updateSettings
called by 47
src/services/settings-service.ts
getLogger
called by 32
src/utils/logger.ts
error
called by 29
src/utils/logger.ts
get
called by 24
src/services/view-registry.ts
str
called by 23
src/services/settings-normalizer.ts
bool
called by 17
src/services/settings-normalizer.ts
convertWindowsPathToWsl
called by 14
src/utils/platform.ts

Shape

Method 317
Function 177
Interface 128
Class 42

Languages

TypeScript100%

Modules by API surface

src/plugin.ts38 symbols
src/services/view-registry.ts37 symbols
src/ui/ChatView.tsx34 symbols
src/ui/FloatingChatView.tsx33 symbols
src/types/session.ts33 symbols
src/acp/acp-client.ts31 symbols
src/services/vault-service.ts29 symbols
src/ui/SettingsTab.ts27 symbols
src/services/settings-service.ts26 symbols
src/services/message-sender.ts21 symbols
src/utils/platform.ts19 symbols
src/services/chat-exporter.ts19 symbols

For agents

$ claude mcp add obsidian-agent-client \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page