Gradle MCP Server

Gradle MCP Server

site icon
2025.04.14 10
KotlinGradle 项目管理自动化构建开发效率
Gradle MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,旨在通过编程方式与 Gradle 项目进行交互。它利用 Gradle Tooling API 查询项目信息并执行任务,为开发者提供高效的项目管理和构建工具。
View on GitHub

Overview

基本能力

产品定位

Gradle MCP Server 是一个用于与 Gradle 项目交互的编程接口服务,主要服务于开发者和自动化工具,提供项目信息查询和任务执行功能。

核心功能

  1. 项目检查
  2. 获取 Gradle 项目的详细结构信息,包括构建结构、可用任务、构建环境细节和根项目详情。
  3. 支持选择性查询信息类别。
  4. 任务执行
  5. 运行特定的 Gradle 任务(如 cleanbuild),支持自定义参数、JVM 参数和环境变量。
  6. 返回格式化的文本输出,包括 stdout/stderr 和状态。
  7. 分层测试运行
  8. 执行 Gradle 测试任务,返回结构化的分层测试结果(Suite -> Class -> Method)。
  9. 支持测试过滤、输出控制(如包含通过测试的输出)和日志行限制。

适用场景

  • 自动化构建和测试流程。
  • 项目信息查询和分析工具。
  • 开发环境集成和调试工具。

工具列表

  1. Get Gradle Project Info
  2. 功能:获取 Gradle 项目的结构化信息。
  3. 输入:项目路径和可选的信息类别。
  4. 输出:JSON 格式的项目信息。
  5. Execute Gradle Task
  6. 功能:执行 Gradle 任务并返回执行结果。
  7. 输入:项目路径、任务列表、参数等。
  8. 输出:格式化的文本输出。
  9. Run Gradle Tests
  10. 功能:执行测试任务并返回分层测试结果。
  11. 输入:项目路径、测试任务、过滤模式等。
  12. 输出:JSON 格式的测试结果。

常见问题解答

  • 依赖要求:需要 JDK 21 或更高版本。
  • 运行模式:支持标准 I/O 模式和 SSE 模式。
  • 调试:可通过 --debug 参数启用详细日志。

使用教程

使用依赖

  • 确保已安装 JDK 21 或更高版本。

安装教程

  1. 构建项目bash ./gradlew build
  2. 打包bash ./gradlew shadowJar
  3. 运行
  4. 标准 I/O 模式: bash ./gradlew run
  5. SSE 模式: bash ./gradlew run --args="--sse"

调试方式

  • 启用调试日志: bash ./gradlew run --args="--debug"

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。