Jinni

Jinniは、大規模言語モデルにプロジェクトのコンテキストを効率的に提供するツールで、関連するファイルとそのメタデータを統合することで、1つずつファイルを読み取る制限を克服します。

開発者ツール人工知能チャットボット #プロジェクトコンテキスト #LLMツール #インテリジェントなフィルタリング .Python

スコア : 3.5ポイント

ダウンロード数 : 245

更新時間 : 2025-04-28

Jinniとは？

Jinniは、AIプログラミングアシスタント向けに特別に設計されたインテリジェントなプロジェクトコンテキスト抽出ツールです。これは、あなたのコードプロジェクトを自動的にスキャンし、すべての関連ファイルの内容を抽出し、構造化された形式で大規模言語モデル(LLM)に提供し、AIがあなたのプロジェクト全体をより深く理解できるようにします。

Jinniの使い方は？

あなたのAI開発環境(例: Cursor/Roo/Claudeなど)を簡単に設定するだけで、Jinniはバックグラウンドで動作します。AIがプロジェクトを理解する必要があるとき、自動的に完全なコードコンテキストを取得します。

適用シーン

複雑なコードライブラリの保守、新しいメンバーがプロジェクトをすばやく理解する、複数のファイルにまたがるコードのリファクタリングなどのシーンに特に適しています。AIアシスタントに、経験豊富な開発者のようにあなたのプロジェクトを理解させます。

主な機能

インテリジェントなコンテキスト抽出プロジェクト内のソースコードファイルを自動的に識別して抽出し、バイナリ/ログなどの関係のない内容を除外します

シームレスなMCP統合Model Context Protocolを通じて主流のAI開発ツールと深く統合します

カスタムフィルタリングルール.gitignoreスタイルのルールをサポートし、どのファイルを含めるか、除外するかを正確に制御します

完全なメタデータファイルのパス、サイズ、変更時間などのメタデータを提供し、ファイル間の関係を理解しやすくします

WSLのシームレスなサポートWindows/WSLのパス変換を自動的に処理し、クロスプラットフォーム開発を心配する必要がありません

利点と制限

利点

1クリックで完全なプロジェクトビューを取得でき、手動で1つずつファイルを確認する必要がありません

インテリジェントなフィルタリングメカニズムにより、関連するコードファイルのみが含まれます

主流のAIプログラミングツールとすぐに使用できます

大規模なプロジェクトをサポートし、パスとエンコーディングの問題を自動的に処理します

制限

超大規模のプロジェクトでは、コンテキストが長くなりすぎないように、含めるルールを調整する必要がある場合があります

初回の設定には、簡単な開発環境の設定が必要です

バイナリ/非テキストファイルはデフォルトでは含まれません(設定で変更可能)

使い方

Jinniのインストール

pipまたはuvを通じてJinniパッケージをインストールします

MCPクライアントの設定

あなたのAI開発ツールの設定ファイルにJinniサーバーの設定を追加します

プロジェクトのルートディレクトリを指定する(オプション)

セキュリティ上の理由から、Jinniがアクセスできるディレクトリを特定のディレクトリに制限することができます

使用を開始する

開発環境を再起動すると、AIがプロジェクトコンテキストを読み取る要求を行うことができます

使用例

新しいメンバーがプロジェクトを理解する新しく加入した開発者がAIを使用して、プロジェクトの構造と主要なモジュールをすばやく理解します

複数ファイルにまたがるリファクタリング複数のファイルに影響を与えるコードをリファクタリングする際に、一貫性を確保します

依存関係の分析複雑なプロジェクト内のモジュールの依存関係を整理します

よくある質問

なぜAIが時々私の一部のファイルを見ることができないのですか？

Jinniがアクセスできるディレクトリの範囲をどのように制限しますか？

Windows/WSLのパスはどのように処理されますか？

プロジェクトが大きすぎてコンテキストが制限を超えてしまった場合はどうすればいいですか？

🚀 Jinni プロジェクトガイド

Jinni プロジェクトは、特定のルールに基づいてファイルやディレクトリを処理し、LLM のコンテキストに適切な内容を提供するツールです。このガイドでは、Jinni の基本的な使い方やルールの適用ロジック、トラブルシューティング方法などを説明します。

📁 プロジェクトルートディレクトリ

--root または root: プロジェクトのルートディレクトリを指定します。指定しない場合、MCP クライアントで設定されたパスがデフォルトで使用されます。
役割: どのファイルがコンテキストに含まれるかを決定し、すべての相対パス計算の基礎として使用されます。

📋 ルール適用ロジック

対象の決定: Jinni は処理対象のディレクトリ（ユーザーが指定したものまたはプロジェクトルートディレクトリ）を特定します。
上書きチェック: --overrides (コマンドラインインターフェース) または rules (MCP) を使用した場合、これらのルールが排他的に使用され、すべての .contextfiles とデフォルトルールは無視されます。パスの一致は対象ディレクトリに基づいて行われます。
動的コンテキストルール（上書きなし）: 各ファイルまたはサブディレクトリを処理する際に、以下の手順が実行されます。
- Jinni は対象ディレクトリから現在の項目のディレクトリまで、すべての .contextfiles を下向きに検索します。
- これらの .contextfiles ルールをデフォルトルールと結合します。
- これらの結合ルールを規範（PathSpec）にコンパイルします。
- 現在のファイル/サブディレクトリのパス（対象ディレクトリを基準とした相対パス）を一致させます。
一致判定: 現在の項目の相対パスに一致する最後のパターンがその運命を決定します。! は否定的な一致を表します。ユーザー定義のパターンが一致しない場合、その項目は含まれますが、デフォルトの除外（例: !.*）に一致する場合は除外されます。
対象処理: 明示的に指定されたファイルはルールチェックをバイパスします。明示的に指定されたディレクトリは、その内容のルール発見と一致の根となります。出力パスは常に元の project_root に基づいています。

⚠️ コンテキストサイズエラー (`DetailedContextSizeError`)

問題: 含まれるコンテキストのサイズが制限を超えると、Jinni は試みられた 10 個の最大ファイルのリストを提供します。
解決策:
1. 最大ファイルの確認: エラーメッセージのファイルリストを確認します。データファイル、ログ、ビルド生成物、メディアなどの大きなファイルが LLM のコンテキストに含まれるべきではないでしょうか？
2. 除外の設定: .contextfiles または --overrides / rules を使用して、不要なファイルやディレクトリを除外します。
  - 例 (.contextfiles): すべての .log ファイルと特定の大きなデータディレクトリを除外する場合：
```
# すべてのログファイルを除外
!*.log

# 大きなデータファイルディレクトリを除外
!large_data_files/
```
3. 制限の増加（注意して使用）: すべての含まれるファイルが必要な場合、--size-limit-mb (コマンドラインインターフェース) または size_limit_mb (MCP) を使用してサイズ制限を増やすことができます。ただし、LLM のコンテキストウィンドウ制限と処理コストに注意してください。
4. jinni usage / usage の使用: これらの説明や設定の詳細を再度参照する必要がある場合は、jinni usage コマンドを使用するか、usage ドキュメントを参照してください。

⚙️ 設定ファイル

上書きルール: --overrides パラメータを使用して、カスタムの .contextfiles ファイルのパスを指定し、デフォルトの動作を上書きします。
MCP 設定: MCP クライアントで rules 属性を配列として設定し、除外または含める具体的なパスを指定します。

💻 開発情報

ローカルでの実行: 開発環境でサーバーモジュールを実行するには、以下のコマンドを使用します。
```
python -m jinni.serve serve --root /path/to/your/project_root
```
- 注意事項: Python パスを調整する必要がある場合は、実際のニーズに応じて環境変数を変更してください。