Maven Indexer MCP

🚀 Maven Indexer MCPサーバー

このサーバーは、Model Context Protocol (MCP) サーバーで、ローカルのMavenリポジトリ (~/.m2/repository) とGradleキャッシュ (~/.gradle/caches/modules-2/files-2.1) をインデックス化し、AIエージェントがJavaクラス、メソッドシグネチャ、ソースコードを検索するためのツールを提供します。

主なユースケース: AIモデルは、人気のある公開ライブラリ (Spring、Apache Commons、Guavaなど) に精通していますが、以下の点で苦労することがあります。

1. 社内パッケージ: 公開されていないプライベートライブラリ。
2. 知名度の低い公開パッケージ: ニッチなまたは人気の低いオープンソースライブラリ。

このサーバーは、AIがローカルの依存関係を「読み取る」ことを可能にすることで、このギャップを埋め、プライベートおよび知名度の低いライブラリに関する知識をAIに与えます。

✨ 主な機能

• セマンティッククラス検索: クラス名または目的でクラスを検索します。
• 継承検索: インターフェースのすべての実装またはクラスのサブクラスを見つけます。
• オンデマンド分析: JARファイルから直接メソッドシグネチャとJavadocを抽出します。
• ソースコード取得: 利用可能な場合、完全なソースコードを提供します。
• リアルタイム監視: リポジトリが変更されたときにインデックスを自動的に更新します。

🚀 クイックスタート

MCPクライアントに以下の設定を追加してください。

{
  "mcpServers": {
    "maven-indexer": {
      "command": "npx",
      "args": [
        "-y",
        "maven-indexer-mcp@latest"
      ]
    }
  }
}

これにより、サーバーの最新バージョンが自動的にダウンロードされ、実行されます。サーバーは、Mavenリポジトリの場所 (通常は ~/.m2/repository) とGradleキャッシュを自動検出します。

MCPクライアントの設定

💻 使用例

基本的な使用法

MCPクライアントで以下のプロンプトを入力して、すべてが正常に動作しているか確認してください。

Find the class `StringUtils` in my local maven repository and show me its methods.

MCPクライアントは、ローカルのMavenリポジトリから StringUtils クラスを読み取り、そのメソッドを表示するはずです。

高度な使用法

自動検出が失敗した場合、またはインデックス化するパッケージをフィルタリングしたい場合は、設定に環境変数を追加できます。

• MAVEN_REPO: ローカルのMavenリポジトリの絶対パス (例: /Users/yourname/.m2/repository)。リポジトリが標準以外の場所にある場合に使用します。
• GRADLE_REPO_PATH: Gradleキャッシュの絶対パス (例: /Users/yourname/.gradle/caches/modules-2/files-2.1)。
• INCLUDED_PACKAGES: インデックス化するパッケージパターンのカンマ区切りリスト (例: com.mycompany.*,org.example.*)。デフォルトは * (すべてをインデックス化) です。
• MAVEN_INDEXER_CFR_PATH: (オプション) 特定のCFRデコンパイラJARの絶対パス。指定されていない場合、サーバーはバンドルされたCFRバージョンを使用しようとします。
• VERSION_RESOLUTION_STRATEGY: (オプション) アーティファクトの複数のバージョンが見つかり、特定のコーディネートが指定されていない場合にバージョンを選択する戦略。
  • semver: (デフォルト) 最も高いセマンティックバージョンを優先します (例: 1.2.0 > 1.1.9)。
  • latest-published: 最新の公開日時のバージョンを優先します (*.pom.lastUpdated を最初に確認し、次にファイルの変更日時を確認します)。
  • latest-used: ユーザーが最も最近インポート/使用したバージョンを優先します (ファイルの作成日時に基づきます)。

オプションの設定例:

{
  "mcpServers": {
    "maven-indexer": {
      "command": "npx",
      "args": [
        "-y",
        "maven-indexer-mcp@latest"
      ],
      "env": {
        "MAVEN_REPO": "/Users/yourname/.m2/repository",
        "GRADLE_REPO_PATH": "/Users/yourname/.gradle/caches/modules-2/files-2.1",
        "INCLUDED_PACKAGES": "com.mycompany.*",
        "MAVEN_INDEXER_CFR_PATH": "/path/to/cfr-0.152.jar",
        "VERSION_RESOLUTION_STRATEGY": "semver"
      }
    }
  }
}

ローカル開発

ソースから実行する場合は、以下の手順を実行します。

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

   git clone https://github.com/tangcent/maven-indexer-mcp.git
   cd maven-indexer-mcp
   

2. 依存関係をインストールし、ビルドします。

   npm install
   npm run build
   

3. 設定で絶対パスを使用します。

   {
     "mcpServers": {
       "maven-indexer": {
         "command": "node",
         "args": ["/absolute/path/to/maven-indexer-mcp/build/index.js"]
       }
     }
   }
   

📚 ドキュメント

利用可能なツール

• search_classes: ローカルのMavenリポジトリとGradleキャッシュ内でJavaクラスを検索します。
  • 使用時機: 1. 社内/プライベートコード: 社内ライブラリからクラスを見つける必要がある場合。 2. 知名度の低いライブラリ: AIがあまり知らないあまり一般的でない公開ライブラリを使用している場合。 3. バージョン検証: ローカルに存在するクラスの正確なバージョンを確認する必要がある場合。
    • 注意: 有名なライブラリ (標準Javaライブラリ、Springなど) の場合、AIはおそらくクラス構造をすでに知っているため、このツールはあまり重要ではありません。
  • 例: "Show me the source of StringUtils", "What methods are available on DateTimeUtils?", "Where is this class imported from?"
  • 入力: className (例: "StringUtils", "Json parser")
  • 出力: 一致するクラスとそのアーティファクトのリスト。
• get_class_details: 外部ライブラリ/依存関係のソースコードをデコンパイルして読み取ります。JARファイルに定義されているがインポートされているクラスには、'SearchCodebase' の代わりにこれを使用してください。
  • 主な価値: "内部ライブラリが何を行っているかを推測するのではなく、コードを読む。"
  • ヒント: ドキュメントが不足しているまたは存在しない内部/独自のコードに不可欠です。
  • 入力: className (必須), artifactId (オプション), type ("signatures", "docs", "source")
  • 出力: メソッドシグネチャ、Javadoc、または完全なソースコード。
  • 注意: artifactId が省略された場合、ツールは自動的に利用可能な最適なアーティファクトを選択します (ソースコードが添付されているものを優先します)。
• search_artifacts: 座標 (groupId、artifactId) でMaven/Gradleキャッシュ内のアーティファクトを検索します。
• search_implementations: 特定のインターフェースを実装するまたは特定のクラスを拡張するクラスを検索します。外部ライブラリ内のSPI実装を見つけるのに便利です。
  • 入力: className (例: "java.util.List")
  • 出力: 実装/サブクラス名とそのアーティファクトのリスト。
• refresh_index: Mavenリポジトリの再スキャンをトリガーします。

🔧 開発

• テストの実行: npm test
• ウォッチモード: npm run watch

📄 ライセンス

ISC