What is Sonarqube Mcp Server

The SonarQube MCP Server is a Model Context Protocol (MCP) server designed for seamless integration with SonarQube Cloud, enabling enhanced code quality management.

Use cases

Use cases for SonarQube MCP Server include integrating code quality checks into CI/CD pipelines, managing code quality metrics for multiple projects, and facilitating collaboration among development teams.

How to use

To use SonarQube MCP Server, you can launch it either as a Docker container or directly from a JAR file. Ensure you have the necessary prerequisites, such as Docker or JDK 21+. Set required environment variables before starting the server.

Key features

Key features of SonarQube MCP Server include seamless integration with SonarQube Cloud, support for Docker deployment, and the ability to configure storage paths for data persistence.

Where to use

SonarQube MCP Server is primarily used in software development environments where code quality and continuous integration are critical, particularly in organizations utilizing SonarQube for code analysis.

SonarQube MCP Server

The SonarQube MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with SonarQube Server or Cloud.
It also enables the analysis of code snippet directly within the agent context.

Prerequisites

SonarQube MCP Server can be launched in two ways:

• With a Docker Container
  • Requires: Docker installed.
• Directly from the JAR
  • Requires: Java Development Kit (JDK) version 21 or later.

Installation

Building

Run the following Gradle command to clean the project and build the application:

./gradlew clean build -x test

The JAR file will be created in build/libs/.

To create the Docker image, run the buildDocker task:

./gradlew clean buildDocker -x test

Usage

VS Code

Once the application is built locally (either as a JAR or a Docker image), you can use the following buttons to simplify the installation process within VS Code.

General cases

Alternatively, you can manually copy and paste the MCP configurations. Below are example snippets.

• Docker

{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "-i",
      "--rm",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_ORG",
      "sonarqube-mcp-server:<version>"
    ],
    "env": {
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_ORG": "<org>"
    }
  }
}

• JAR

{
  "sonarqube": {
    "command": "java",
    "args": [
      "-jar",
      "<path_to_sonarqube_mcp_server_jar>"
    ],
    "env": {
      "STORAGE_PATH": "<path_to_your_mcp_storage>",
      "SONARQUBE_TOKEN": "<token>",
      "SONARQUBE_ORG": "<org>"
    }
  }
}

Configuration

Depending on your environment, you should provide specific environment variables.

SonarQube Cloud

To enable full functionality, the following environment variables must be set before starting the server:

Environment variable	Description
SONARQUBE_TOKEN	Your SonarQube Cloud token
SONARQUBE_ORG	Your SonarQube Cloud organization key

SonarQube Server

Environment variable	Description
SONARQUBE_TOKEN	Your SonarQube Server USER token
SONARQUBE_URL	Your SonarQube Server URL

JAR

On top of the previous SonarQube environments, you should add the following variable when running the MCP Server via a JAR:

Environment variable	Description
STORAGE_PATH	An absolute path to a writable directory where SonarQube MCP Server will store its files (e.g., for creation, updates, and persistence)

Tools

Analysis

• analyze_code_snippet - Analyze a code snippet with SonarQube analyzers to find SonarQube issues in it.
  • codeSnippet - Code snippet or full file content - Required String
  • language - Optional language of the code snippet - String

Languages

• list_languages - List all programming languages supported in this instance
  • q - Optional pattern to match language keys/names against - String

Issues

• change_sonar_issue_status - Change the status of a SonarQube issue to “accept”, “falsepositive” or to “reopen” an issue

  • key - Issue key - Required String
  • status - New issue’s status - Required Enum {“accept”, “falsepositive”, “reopen”}

• search_sonar_issues_in_projects - Search for SonarQube issues in my organization’s projects

  • projects - Optional list of Sonar projects - String[]
  • pullRequestId - Optional Pull Request’s identifier - String
  • p - Optional page number (default: 1) - Integer
  • ps - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 100) - Integer

Measures

• get_component_measures - Get measures for a component (project, directory, file)
  • component - Optional component key to get measures for - String
  • branch - Optional branch to analyze for measures - String
  • metricKeys - Optional metric keys to retrieve (e.g. nloc, complexity, violations, coverage) - String[]
  • pullRequest - Optional pull request identifier to analyze for measures - String

Metrics

• search_metrics - Search for metrics
  • p - Optional page number (default: 1) - Integer
  • ps - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 100) - Integer

Projects

• search_my_sonarqube_projects - Find Sonar projects in my organization
  • page - Optional page number - String

Quality Gates

• get_project_quality_gate_status - Get the Quality Gate Status for the project

  • analysisId - Optional analysis ID - String
  • branch - Optional branch key - String
  • projectId - Optional project ID - String
  • projectKey - Optional project key - String
  • pullRequest - Optional pull request ID - String

• list_quality_gates - List all quality gates in the organization

Rules

• list_rule_repositories - List rule repositories available in SonarQube

  • language - Optional language key - String
  • q - Optional search query - String

• show_rule - Shows detailed information about a SonarQube rule

  • key - Rule key - Required String

Sources

• get_raw_source - Get source code as raw text. Require ‘See Source Code’ permission on file

  • key - File key - Required String
  • branch - Optional branch key - String
  • pullRequest - Optional pull request id - String

• get_scm_info - Get SCM information of source files. Require See Source Code permission on file’s project

  • key - File key - Required String
  • commits_by_line - Group lines by SCM commit if value is false, else display commits for each line - String
  • from - First line to return. Starts at 1 - Number
  • to - Last line to return (inclusive) - Number

System

Note: System tools are only available when connecting to SonarQube Server.

• get_system_health - Get the health status of SonarQube Server instance

• get_system_info - Get detailed information about SonarQube Server system configuration including JVM state, database, search indexes, and settings. Requires ‘Administer’ permissions

• get_system_logs - Get SonarQube Server system logs in plain-text format. Requires system administration permission

  • name - Optional name of the logs to get. Possible values: access, app, ce, deprecation, es, web. Default: app - String

• ping_system - Ping the SonarQube Server system to check if it’s alive

• get_system_status - Get state information about SonarQube Server

Troubleshooting

Applications logs will be written to the STORAGE_PATH/logs/mcp.log file.

Data and telemetry

This server collects anonymous usage data and sends it to SonarSource to help improve the product. No source code or IP address is collected, and SonarSource does not share the data with anyone else. Collection of telemetry can be disabled with the following system property or environment variable: TELEMETRY_DISABLED=true. Click here to see a sample of the data that are collected.

License

Copyright 2025 SonarSource.

Licensed under the SONAR Source-Available License v1.0