MCP Obsidian Index

🚀 Obsidian索引MCPサーバー

Obsidianボールトをベースにした、セマンティック検索機能を備えたMCPサーバーです。最近のノートリソースを公開します。

🚀 クイックスタート

✨ 主な機能

• サーバーは、ボールト内で最近変更されたノートをMCPクライアントにリソースとして提供します。
• search-notesツールを使って、インデックスされたノートに対してセマンティック検索を実行できます。

📦 インストール

Claude Desktop

• MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json%

💻 使用例

基本的な使用法

サーバーを起動するには、以下のコマンドを実行します。

uv run obsidian-index mcp --vault <VAULT_PATH> --database <DATABASE_PATH> --reindex --watch

• --vault: ボールトのパス（複数指定可能）
• --database: ローカルデータベースファイルのパス（存在しない場合は作成されます）
• --reindex: すべてのボールト内のノートを再インデックスします（現時点では、このコマンドを毎回実行する必要がある場合があります）
• --watch: ボールト内の変更を監視し、インデックスを適宜更新します

📚 ドキュメント

コンポーネント

リソース

このサーバーは、あなたのボールト内で最近変更されたノートをMCPクライアントにリソースとして提供します。

• ノートは、obsidian://<VAULT_NAME>/<NOTE_PATH>というカスタムURLスキームで識別されます。
• ノートはtext/markdownメディアタイプを持ちます。

ツール

サーバーは以下のツールを実装しています。

• search-notes: インデックスされたノートに対してセマンティック検索を実行します。

🔧 技術詳細

ビルドと公開

配布パッケージを準備するには、以下の手順を行います。

1. 依存関係を同期し、ロックファイルを更新します。

uv sync

2. リリースバージョンをビルドします。

uv build

これにより、dist/ディレクトリにソースコードとwheel配布バージョンが作成されます。 3. PyPIに公開します。

uv publish

注意: PyPIの認証情報を環境変数またはコマンドライン引数で設定する必要があります。

• トークン: --tokenまたはUV_PUBLISH_TOKEN
• またはユーザー名/パスワード: --username/UV_PUBLISH_USERNAMEと--password/UV_PUBLISH_PASSWORD

デバッグ

MCPサーバーは標準入出力で動作するため、デバッグは難しい場合があります。最適なデバッグ体験を得るために、MCP Inspectorの使用を強くおすすめします。

以下のコマンドでMCP Inspectorを起動できます。

npx @modelcontextprotocol/inspector uv --directory <PATH_TO_PROJECT> run obsidian-index

起動後、InspectorはURLを表示し、そのURLをブラウザで開くことでデバッグを開始できます。