Maven Indexer MCP

🚀 Maven Indexer MCP Server

Maven Indexer MCP Server 是一個模型上下文協議（MCP）服務器，它對本地 Maven 倉庫（~/.m2/repository）和 Gradle 緩存（~/.gradle/caches/modules-2/files-2.1）進行索引，為 AI 代理提供搜索 Java 類、方法簽名和源代碼的工具。該服務器能讓 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