使用说明

项目简介

Gradle MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，旨在为 AI 工具提供与 Gradle 项目交互的能力。它通过 Gradle Tooling API 实现了对 Gradle 项目的程序化访问，使得 AI 可以理解项目结构、执行构建任务和分析测试结果。

主要功能点

项目信息查询: 允许 AI 获取 Gradle 项目的详细结构信息，包括子项目、任务列表、构建环境和项目属性，帮助 AI 理解项目的构成和上下文。
Gradle 任务执行: 支持 AI 执行 Gradle 项目中的各种任务，例如编译、构建、清理等，并返回任务执行的详细输出，使 AI 能够自动化构建和部署流程。
分层测试运行与结果分析: 专门为运行 Gradle 测试任务设计，以结构化的 JSON 格式返回测试结果，包括测试套件、类和方法的层级结构，以及每个测试的执行状态和详细日志，方便 AI 进行测试结果分析和问题诊断。

安装步骤

安装 JDK 21 或更高版本: 确保你的开发环境已安装 JDK 21 或更高版本，因为该服务器需要此版本的 JDK 才能运行。
构建项目: 在仓库根目录下，打开终端并执行以下 Gradle 命令来构建项目：
```
./gradlew build
```
打包 JAR 文件: 构建成功后，执行以下命令将项目打包成一个自包含的可执行 JAR 文件：
```
./gradlew shadowJar
```
打包后的 JAR 文件位于 'build/libs/' 目录下，文件名为 'gradle-mcp-server-*-all.jar'。

服务器配置

MCP 客户端需要配置以下信息才能连接到 Gradle MCP Server。以下是不同运行模式的配置示例，请根据你的实际需求选择配置：

1. 标准 I/O 模式 (stdio)

描述: 服务器通过标准输入和输出流 (stdin/stdout) 与 MCP 客户端通信。这是最简单的运行模式，适用于本地开发和调试。
配置信息:

{
  "serverName": "gradle-mcp-server-stdio",
  "command": "java",
  "args": [
    "-jar",
    "build/libs/gradle-mcp-server-*-all.jar"
  ]
}

2. Server-Sent Events (SSE) 模式

描述: 服务器通过 HTTP SSE 协议与 MCP 客户端通信。此模式适用于需要通过网络连接的场景，例如远程服务器或云端环境。默认端口为 3001，可以自定义端口。
配置信息 (默认端口 3001):

{
  "serverName": "gradle-mcp-server-sse",
  "command": "java",
  "args": [
    "-jar",
    "build/libs/gradle-mcp-server-*-all.jar",
    "--sse"
  ]
}

配置信息 (自定义端口 8080):

{
  "serverName": "gradle-mcp-server-sse-8080",
  "command": "java",
  "args": [
    "-jar",
    "build/libs/gradle-mcp-server-*-all.jar",
    "--sse",
    "8080"
  ]
}

3. 调试模式 (可选)

描述: 开启调试模式会在服务器端输出详细的日志信息，方便开发者调试和排查问题。可以与 stdio 或 SSE 模式结合使用。
配置信息 (stdio 模式 + 调试模式):

{
  "serverName": "gradle-mcp-server-stdio-debug",
  "command": "java",
  "args": [
    "-jar",
    "build/libs/gradle-mcp-server-*-all.jar",
    "--debug"
  ]
}

配置信息 (SSE 模式 + 调试模式):

{
  "serverName": "gradle-mcp-server-sse-debug",
  "command": "java",
  "args": [
    "-jar",
    "build/libs/gradle-mcp-server-*-all.jar",
    "--sse",
    "--debug"
  ]
}

注意:

请将 'build/libs/gradle-mcp-server-*-all.jar' 替换为实际的 JAR 文件路径。
在实际使用中，你需要根据 MCP 客户端的要求配置 'serverName' 和其他连接参数。
如果使用 SSE 模式，MCP 客户端需要连接到 'http://localhost:<port>/sse' (例如 'http://localhost:3001/sse')。

基本使用方法

启动服务器: 根据选择的模式，使用上述配置信息启动 Gradle MCP Server。
配置 MCP 客户端: 在 MCP 客户端中，配置 Gradle MCP Server 的连接信息（包括服务器启动命令和参数）。
使用 AI 工具: 通过 MCP 客户端，AI 工具可以调用 Gradle MCP Server 提供的工具，例如：
- 使用 'Get Gradle Project Info' 工具查询项目信息。
- 使用 'Execute Gradle Task' 工具执行 Gradle 任务。
- 使用 'Run Gradle Tests' 工具运行测试并分析结果。
查看结果: AI 工具将接收到 Gradle MCP Server 返回的 JSON-RPC 响应，其中包含请求工具的执行结果。

通过 Gradle MCP Server，AI 工具可以无缝集成到 Gradle 构建流程中，实现更智能化的软件开发辅助功能。

关键词