SonarQube MCP Server

SonarQube MCP Server

site icon
2025.04.14 19
TypeScript代码质量分析开发工具集成开发效率
SonarQube MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于集成 SonarQube 的代码质量分析能力,为 AI 助手提供访问代码质量指标、问题和分析结果的能力。
View on GitHub

Overview

基本能力

产品定位

SonarQube MCP Server 是一个中间件服务,旨在通过 MCP 协议为 AI 助手提供与 SonarQube 代码质量分析平台的交互能力。

核心功能

  • 列出所有 SonarQube 项目(支持分页)
  • 从 SonarQube 项目中获取详细的问题信息(支持多种过滤选项)
  • 同时支持 SonarQube 和 SonarCloud
  • 使用 Zod 模式进行全面的参数验证
  • 完整的 TypeScript 支持

适用场景

  • AI 助手需要访问代码质量指标时
  • 开发团队希望通过 AI 助手获取代码问题分析
  • 需要自动化监控项目代码质量变化

工具列表

  1. projects工具:列出所有 SonarQube 项目
  2. 支持组织、分页等参数
  3. issues工具:获取 SonarQube 项目中的问题
  4. 支持按严重程度、状态、类型等20+种过滤条件

常见问题解答

  • 需要配置环境变量:SONARQUBE_URL、SONARQUBE_TOKEN
  • 支持通过 Docker 或 NPX 快速部署

使用教程

使用依赖

  • Node.js 20 或更高版本
  • pnpm 10.7.0 或更高版本
  • Docker(可选,用于容器化部署)

安装教程

  1. 通过 npm 安装:
npm install sonarqube-mcp-server
  1. 或使用 Docker 运行:
docker run -i --rm -e SONARQUBE_URL -e SONARQUBE_TOKEN -e SONARQUBE_ORGANIZATION sapientpants/sonarqube-mcp-server
  1. 或使用 npx 直接运行:
npx -y [email protected]

调试方式

  1. 克隆仓库:
git clone https://github.com/sapientpants/sonarqube-mcp-server.git
cd sonarqube-mcp-server
  1. 安装依赖:
pnpm install
  1. 构建项目:
pnpm run build
  1. 启动开发服务器:
pnpm run dev
  1. 运行测试:
pnpm run test

许可证

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