Obsidian MCP Server

👁 npm version

obsidian-mcp-serverは、AIエージェントがObsidian VaultのMarkdownドキュメントを照会、検索、要約できるようにするMCPサーバーです。

このプロジェクトは単にドキュメントを読み取るだけでなく、transformers.jsを活用したローカルハイブリッド検索機能を提供し、ターミナルから即座にVaultと対話できる対話型CLI AI Agent UIを内蔵しています。

主な特徴

• 🔍 ハイブリッド検索: キーワード検索とセマンティック（ベクトル）検索を組み合わせ、RRF（Reciprocal Rank Fusion）とリランキングを通じて最適な結果を提供。

• 🚀 Zero-Dependency ローカルAI: @huggingface/transformersを使用して、埋め込みおよびリランキングモデルをNode.jsプロセス内で直接実行（外部APIサーバー不要）。

• 💬 内蔵CLIエージェント: MCPツールを活用してVaultの内容について質問し、回答を得られるターミナルベースのUIを提供。詳細を見る

• 📦 トークン最適化: AIエージェントのトークン使用量を制御するための多様な圧縮モードと出力制限機能を提供。

できること (MCP Tools)

• 統合検索 (vault, action="search"): キーワードと意味ベースの検索を同時に行い、関連性の高いドキュメントを探索。

• ドキュメント閲覧 (vault, action="read"): 特定のノートの本文およびメタデータを照会。

• 全体リストおよび状態 (vault, action="list_all"|"stats"): Vaultの全体的な状態とファイルリストを確認。

• コンテキスト収集 (vault, action="collect_context"): 特定のトピックに関連する高密度な知識パケットを生成。

• 知識ロード (vault, action="load_memory"): 保存されたメモリのスナップショットを呼び出し。

• Frontmatter管理 (generate_property|write_property): AIベースのメタデータ生成および反映。

• 添付ファイル整理 (organize_attachments): ドキュメント内の画像を専用フォルダへ自動移動し、リンクを更新。

インストールと設定

1. 前提条件

• Node.js: v22.0.0以上

• Obsidian Vault: 絶対パスを知っている必要があります。

2. ローカルAIモデルのインストール (必須)

セマンティック検索およびリランキング機能を有効にするには、以下のコマンドで必要なローカルモデルをダウンロードする必要があります。

# 로컬 임베딩 및 리랭킹 모델 설치
npx @sunub/obsidian-mcp-server setup

または、すでにパッケージをインストールしている場合:

obsidian-mcp-server setup

このコマンドは Xenova/paraphrase-multilingual-MiniLM-L12-v2（埋め込み）と Xenova/bge-reranker-base（リランキング）モデルをダウンロードし、ローカルキャッシュに保存します。

3. 環境変数の設定

MCPクライアント設定例

各クライアント設定で env.VAULT_DIR_PATH を自身のVaultパスに修正して使用してください。

Claude Desktop / Cursor / Copilot

{
 "mcpServers": {
 "obsidian": {
 "command": "npx",
 "args": ["-y", "@sunub/obsidian-mcp-server@latest"],
 "env": {
 "VAULT_DIR_PATH": "/Users/username/Documents/MyVault"
 }
 }
 }
}

ハイブリッド検索の動作方式

従来のキーワード検索だけでは見つけにくい意味的な関連性を捉えるため、以下のパイプラインを経由します:

1. Keyword Search: 内部 Indexer を通じて正確な単語マッチング結果を抽出。

2. Vector Search: LanceDBと transformers.js の埋め込みを使用して、意味的に類似したチャンクを探索。

3. RRF Fusion: 2つの検索結果の順位をReciprocal Rank Fusionアルゴリズムで統合。

4. Local Reranking: 統合された上位結果を BGE Reranker モデルで再評価し、最終順位を決定。

モデルがインストールされていない場合は自動的にキーワード専用モードで動作し、ターミナルに npx @sunub/obsidian-mcp-server setup の実行を推奨するメッセージを表示します。

対話型CLI AI Agent UI

このプロジェクトには、Obsidian Vaultに最適化されたターミナルベースのAIチャットインターフェースが内蔵されています。

特徴

• RAG統合: 質問時に自動的にVaultから関連コンテキストを収集し、LLMに伝達します。

• リアルタイムストリーミング: LLMの回答と「思考プロセス()」をリアルタイムでレンダリングします。

• スラッシュコマンド: /search, /read, /index などのMCPツールをCLIから直接コマンドとして呼び出し可能。

• マルチMCP管理: 接続されたすべてのMCPサーバーの状態とツールリストを監視します。

実行方法

1. チャットモデルサーバーの起動: llama.cpp や Ollama などのサーバーをOpenAI互換モードで起動します。

   • 例: llama-server -m models/gemma-2-9b-it.Q4_K_M.gguf --port 8080

2. CLI実行:

   # 환경변수와 함께 실행
   VAULT_DIR_PATH="/your/vault" LLM_API_URL="http://localhost:8080" npx @sunub/obsidian-mcp-server

スラッシュコマンドヘルプ

• /search <keyword>: ハイブリッド検索を実行

• /read "filename": 特定のドキュメントを読み込む

• /stats: Vaultの状態を確認

• /index: ベクトルDBの再インデックスを強制実行

• /tools: 使用可能なすべてのMCPツールリストを確認

• /help: ヘルプを表示

ライセンス

Apache-2.0

Maintenance

Resources

• Remote Server
• NPM Package
• GitHub Repository
Need Help?Related Servers

Tools

• create_document_with_propertiesA
• generate_propertyA
• organize_attachmentsA
• vaultA
• write_propertyA