Windtools MCP

🚀 WindTools MCP サーバー

WindTools コードアシスタントの MCP サーバーです。ChromaDB とセンテンストランスフォーマーを使用して、ドキュメントの埋め込みと検索機能を提供します。

✨ 主な機能

• 意味論的コード検索：センテンストランスフォーマーを利用してコードスニペットを埋め込み、検索を実現します。
• コードライブラリインデックス：指定されたディレクトリから自動的にコードファイルをインデックスします。
• 永続的なストレージ：コードの埋め込みを ChromaDB に保存し、永続的な検索をサポートします。
• ディレクトリ探索：コードライブラリのナビゲーションと探索に使用するツールが組み込まれています。
• バックグラウンド初期化：非同期でリソースをロードし、起動時間を最小化します。
• 環境設定：環境変数を使用して設定を行うことができます。

💻 使用例

基本的な使用法

クライアント接続

curl -X POST http://localhost:5000/api/list_dir

コードライブラリのインデックス作成

python scripts/index_codebase.py --directory /path/to/your/code

📚 ドキュメント

ツールセット

1. list_dir

   • あるディレクトリの内容をリストします。
   • 入力：
     • directory_path (文字列)：内容をリストするディレクトリの絶対パス。
   • 出力：
     • 指定されたディレクトリ内のすべてのファイルとサブディレクトリを返します。

2. get_file_content

   • 指定されたファイルの内容を取得します。
   • 入力：
     • file_path (文字列)：対象ファイルの絶対パス。
   • 出力：
     • ファイルの内容、またはファイルが存在しない場合はエラーメッセージを返します。

3. search_code

   • キーワードに基づいてコードライブラリを検索します。
   • 入力：
     • keywords (リスト)：検索するキーワードのリスト。
   • 出力：
     • 一致するコードスニペットの位置と内容を返します。

技術アーキテクチャ

• ChromaDB：コードの埋め込みを保存および検索するために使用され、効率的なテキスト検索をサポートします。
• センテンストランスフォーマー：コードスニペットをベクトル表現に変換し、類似度計算を行うために使用されます。
• 非同期処理：非同期タスクを使用してリソースのロードとクエリ要求を管理し、システムの応答速度を向上させます。

初期化フロー

1. サーバーが起動すると、指定されたディレクトリからコードファイルを自動的に読み取り、ChromaDB に埋め込みます。
2. すべての環境変数が正しく設定されていることを確認してください。特に WINDTOOLS_HOME と CHROMA_DB_URL を設定してください。
3. 起動後、サーバーは特定のポートを監視し、クライアントの接続と要求を待機します。

設定説明

環境変数の設定

• WINDTOOLS_HOME：WindTools のインストールディレクトリを指定します。デフォルトは現在の作業ディレクトリです。
• CHROMA_DB_URL：ChromaDB サービスの URL アドレスを指定します。デフォルトはローカルで実行されているインスタンスです。
• SENTENCE_CONVERTER_PATH：センテンストランスフォーマーの実行可能ファイルのパスを指定します。実行可能である必要があります。

インストール方法

1. 依存関係のインストール：

   pip install chroma-db sentence-transformers
   

2. サーバーの起動：

   python -m windtools_mcp.server start
   

3. 設定例：

   export WINDTOOLS_HOME=/path/to/windtools
   export CHROMA_DB_URL=http://localhost:8000
   

開発要件

• コード構造：標準的な Python プロジェクト構造に従い、モジュール間の依存関係を明確にしてください。
• テストカバレッジ：pytest と pytest - asyncio を使用して全面的なテストを行い、各機能が正常に動作することを保証してください。

テストコマンド

pytest tests/

プロジェクト構造

src/
  windtools_mcp/
    __init__.py
    __main__.py
    server.py
tests/
  test_client.py
  test_unit.py
.github/
  workflows/
    publish.yml
    test.yml
.gitignore
.python-version
pyproject.toml
README.md
VERSION

リリースフロー

• バージョン管理：VERSION ファイルで統一的に管理されます。
• 自動化されたリリース：
  1. VERSION ファイルのバージョン番号を更新します。
  2. main ブランチにコミットします。
  3. GitHub Actions ワークフローが自動的に実行されます。
     • v{VERSION} という名前の Git タグを作成します。
     • GitHub と PyPI にリリースします。

📄 ライセンス

この MCP サーバーは MIT ライセンスに準拠しています。これは、あなたがソフトウェアを自由に使用、変更、配布できることを意味しますが、MIT ライセンスの条項と条件に従う必要があります。