Obsidian Index Service

🚀 Obsidian索引服务

このサービスは、Obsidianのボールトディレクトリを監視し、Markdownファイルのメタデータと全文内容をSQLiteデータベースにインデックス化します。当初はmcp-serverプロジェクト用に構築しましたが、後にObsidianプラグインAPIを使用した実装に切り替えました。ただし、汎用的な無主見なインデックスツールや同期ツールとして（「未来のステップ」を参照）依然として有用だと考え、ここに公開しています。

✨ 主な機能

このサービスは、Obsidianボールト内のファイルの変更（作成、修正、削除）を追跡し、すべての内容をSQLiteに保存します。保存された内容はDockerボリュームを通じてアクセスできます。以下の情報を取得します：

• パス：ファイルパス（一意の識別子）
• タイトル：ファイル名から取得
• 親フォルダ：ボールトのルートディレクトリに対する相対パス
• タグ：YAMLフロントメタデータから取得
• 作成日：ファイルシステムのタイムスタンプ
• 更新日：ファイルシステムのタイムスタンプ
• 内容：ノートの全文
• ステータス：処理結果（成功/エラー）
• エラーメッセージ：処理失敗時の詳細情報

📦 インストール

前提条件

• Python 3.12以上
• DockerとDocker Compose（コンテナ化での使用時）
• uv（オプションだが推奨）

インストール手順

1. リポジトリをクローンします：

    git clone https://github.com/pmmvr/obsidian-index-service.git
    cd obsidian-index-service
   

2. 仮想環境を設定します：

   • uvを使用する場合（推奨）：

     uv venv
     source .venv/bin/activate # Linux/macOS
     .venv\Scripts\activate # Windows
     

   • pythonを使用する場合（標準的な方法）：

     python -m venv .venv
     source .venv/bin/activate  # Linux/macOS
     .venv\Scripts\activate     # Windows
     

3. 依存関係をインストールします：

   • uvを使用する場合（推奨）：

     uv sync  # uv.lockからインストール
     uv pip install pytest pytest-bdd pytest-mock  # テスト用
     

   • pipを使用する場合：

     pip install -e .
     pip install pytest pytest-bdd pytest-mock  # テスト用
     

💻 使用例

基本的な使用法

pytest

📚 ドキュメント

プロジェクトの状態

• 完了：コアインデックス（メタデータ+内容）、Docker設定、ファイル監視、データベースのCRUD操作。
• 次のステップ：APIの作成を計画していましたが、プラグイン方式に切り替えました。

未来のステップ（同期ツールとしての可能性）

一部の再構築を行えば、このサービスを同期ツールとして利用できます。

• リモートバックエンド：クラウドストレージ（例：Dropbox）やサーバーへのサポートを追加する。
• 同期ロジック：ローカルの変更（内容+メタデータ）をリモートにプッシュし、リモートの更新をプルし、競合（例：最後に書き込んだ人が勝つ）を処理する。
• データベースの調整：sync_statusとremote_id列を追加する。
• ファイルモニターの更新：インデックス化だけでなく、同期用の変更をキューに入れる。
• CLIオプション：--syncを追加して、手動でトリガーまたは継続的に実行する。
• エラー処理：ネットワークエラー時にリトライし、問題を記録する。