SonarQube

SonarQube MCP 服务

这是一个 FastMCP 服务，可作为与 SonarQube API 交互的桥梁。该服务提供多种工具，用于借助 SonarQube 监控和分析代码质量。

功能

1. 健康检查

• 端点：sonar_health_check
• 检查 SonarQube 服务的状态
• 返回当前健康状态和连接信息

2. 令牌验证

• 端点：get_token_info
• 验证 SonarQube 身份验证令牌
• 返回身份验证状态和关联的用户信息

3. 项目问题

• 端点：get_project_issues
• 获取特定项目中尚未解决的问题
• 返回以下内容的详细信息：
  • Bug
  • 代码异味
  • 漏洞
  • 问题严重性和状态
  • 文件位置和行号

4. 项目列表

• 端点：list_projects
• 列出所有可访问的 SonarQube 项目
• 提供项目键、名称和可见性设置

5. 项目指标

• 端点：get_project_metrics
• 获取项目的关键质量指标，包括：
  • Bug 数量
  • 漏洞数量
  • 代码异味数量
  • 代码覆盖率
  • 重复代码行密度
  • 可靠性评级
  • 安全性评级
  • 可维护性评级（SQALE）

配置

该服务使用以下环境变量：

SONARQUBE_URL=http://localhost:9000  # Default SonarQube server URL
SONARQUBE_TOKEN=                     # Your SonarQube authentication token
PROJECT_KEY=default_project          # Default project key for operations

要求

查看 requirements.txt 文件以了解所有依赖项。主要依赖项包括：

• FastMCP
• Requests

使用方法

1. 设置环境变量
2. 安装依赖项
3. 使用 Python 运行服务

服务启动后，将提供符合 MCP 规范的端点，用于与 SonarQube 实例交互。

Docker 使用方法

安全提示

出于安全原因，不应将 SONARQUBE_TOKEN 和 PROJECT_KEY 等敏感环境变量存储在 Dockerfile 中。应在运行时通过环境变量或环境文件传入这些变量。

构建镜像

要构建 Docker 镜像：

docker build -t sonarqube-mcp .

💡 如何将此工具与 VS Code 集成并提升其智能程度

• 打开 VS Code 设置

• 在搜索栏中输入 mcp

• 点击“在 settings.json 中编辑”

• 在 mcp 部分下方添加以下配置：

将其添加到 MCP 服务配置中

      "sonarqubemcp": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "--init",
          "-e",
          "SONARQUBE_URL",
          "-e",
          "SONARQUBE_TOKEN",
          "-e",
          "PROJECT_KEY",
          "dhanushhypervisor/sonarqube_mcp_server"
        ],
        "env": {
          "SONARQUBE_URL": "<server_url>",
          "SONARQUBE_TOKEN" : "<server_token>",
          "PROJECT_KEY": "<project_name>",
        }
      }

环境变量

运行容器时，请配置以下必需的环境变量：

• SONARQUBE_URL：SonarQube 服务的 URL
• SONARQUBE_TOKEN：SonarQube 身份验证令牌
• PROJECT_KEY：要分析的默认项目键

该服务运行于 Python 3.10，并使用 uv 包管理器管理和执行依赖项。

错误处理

该服务包含全面的错误处理机制，可处理：

• 连接问题
• 身份验证失败
• 权限问题
• 无效的项目键
• 一般 API 错误

每个端点都会返回详细的错误消息，帮助诊断问题。