Build your SonarQube MCP Server

The SonarQube MCP Server can be launched using our container image, installed using our JAR, and you can build your own server if needed. This page helps you get started with any of those options.

As described in the MCP Server setup in your IDE, launching the SonarQube MCP server is most easily done using the container image. However, you do have other options.

Build locally

We recommend setting up the SonarQube MCP Server with the container image as explained in the Launch the server from the container image article, but if you want to build it locally, check out the Prerequisites, then follow these steps:

1. Clone the SonarQube MCP Server project from the sonarqube-mcp-server repository.

2. 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/.

3. Perform the manual installation as explained below.

If you prefer, the JAR file is downloadable as an Asset on the MCP server Releases page.

Manual installation

After you’ve built the SonarQube MCP Server locally, you’ll need to manually install it in your MCP client. Add the following to your MCP configuration’s JSON file.

The main difference between the server setup of SonarQube Cloud and SonarQube server is:

• SonarQube Cloud requires a User token and an organization name.

  • If your SonarQube Cloud organization is in the US region, be sure to define SONARQUBE_URL as https://sonarqube.us when configuring your connection. See the list of Common variables for complete details.

• SonarQube Server and SonarQube Community Build require a User token and server URL.

SONARQUBE CLOUD

{
  "sonarqube": {
    "command": "java",
    "args": [
        "-jar",
        "<PathToYourSonarQubeMCPServerJAR>"
    ],
    "env": {
        "STORAGE_PATH": "<PathToYourMCPStorage>",
        "SONARQUBE_TOKEN": "<YourSonarQubeUserToken>",
        "SONARQUBE_ORG": "<YourOrganization>",
        //"SONARQUBE_URL": "https://sonarqube.us" //define this parameter to connect to an organization in the US region
    }
  }
}

User tokens are required when setting up connected mode or an MCP Server between SonarQube (Server, Cloud) and SonarQube for IDE. Note that the binding will not function properly if project tokens, global tokens, or scoped organization tokens are used during the setup process.

SONARQUBE_URL should be defined as https://sonarqube.us each time you use a SonarQube Cloud configuration (SONARQUBE_TOKEN + SONARQUBE_ORG) and want to connect to US instance. See the Common variables article which explains when to use these variables.

SONARQUBE SERVER

Deployment options

Depending on your user environment, you may want to deploy your MCP server in different ways. Check out the page about configuring your server and pick the right Transport mode for you.