The SonarQube MCP Server is a bridge that connects AI assistants to SonarQube's code quality analysis capabilities through the Model Context Protocol. It enables you to access metrics, issues, security hotspots, and more directly from your AI assistant.
The simplest way to use the SonarQube MCP Server is through npx by adding it to your Claude Desktop configuration:
{
"mcpServers": {
"sonarqube": {
"command": "npx",
"args": ["-y", "sonarqube-mcp-server@latest"],
"env": {
"SONARQUBE_URL": "https://sonarcloud.io",
"SONARQUBE_TOKEN": "your-sonarqube-token",
"SONARQUBE_ORGANIZATION": "your-organization-key"
}
}
}
}
For production deployments, Docker provides a more reliable method:
{
"mcpServers": {
"sonarqube": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"SONARQUBE_URL",
"-e",
"SONARQUBE_TOKEN",
"-e",
"SONARQUBE_ORGANIZATION",
"sapientpants/sonarqube-mcp-server:latest"
],
"env": {
"SONARQUBE_URL": "https://sonarcloud.io",
"SONARQUBE_TOKEN": "your-sonarqube-token",
"SONARQUBE_ORGANIZATION": "your-organization-key"
}
}
}
}
| Variable | Description | Required |
|---|---|---|
SONARQUBE_TOKEN |
Authentication token for API access | Yes* |
SONARQUBE_USERNAME |
Username for Basic authentication | Yes* |
SONARQUBE_PASSWORD |
Password for Basic authentication | Yes* |
SONARQUBE_PASSCODE |
System passcode for authentication | Yes* |
*One authentication method is required. Token authentication is recommended.
| Variable | Description | Required | Default |
|---|---|---|---|
SONARQUBE_URL |
URL of your SonarQube instance | No | https://sonarcloud.io |
SONARQUBE_ORGANIZATION |
Organization key (required for SonarCloud) | No** | - |
LOG_FILE |
Path to write log files | No | - |
LOG_LEVEL |
Minimum log level (DEBUG, INFO, WARN, ERROR) | No | DEBUG |
**Required when using SonarCloud
{
"env": {
"SONARQUBE_TOKEN": "your-token-here"
}
}
{
"env": {
"SONARQUBE_USERNAME": "your-username",
"SONARQUBE_PASSWORD": "your-password"
}
}
{
"env": {
"SONARQUBE_PASSCODE": "your-system-passcode"
}
}
"List all my SonarQube projects"
"Show me the code coverage for project xyz"
"What metrics are available for analysis?"
"Show me all critical bugs in project abc"
"Find security vulnerabilities in the main branch"
"List all code smells created in the last week"
"Show unresolved issues assigned to john.doe"
"Find all files containing 'UserService' in their name"
"List all test files in my project"
"Show me the directory structure of src/main"
"Assign issue PROJECT-123 to john.doe"
"Mark issue ABC-789 as false positive with comment: 'Test code only'"
"Add comment to issue XYZ-111: 'Fixed in commit abc123'"
"Check the quality gate status for my main project"
"Show me the code coverage history for the last month"
"Find all security hotspots that need review in project xyz"
"Show me hotspots in the authentication module"
"Mark hotspot HSP-12345 as safe with explanation"
Enable debug logging:
export LOG_FILE="/tmp/sonarqube-mcp.log"
export LOG_LEVEL=DEBUG
Test connection with the ping tool:
# Ask your AI assistant
sonarqube.ping
To add this MCP server to Claude Code, run this command in your terminal:
claude mcp add-json "sonarqube" '{"command":"npx","args":["-y","sonarqube-mcp-server@latest"],"env":{"SONARQUBE_URL":"https://sonarcloud.io","SONARQUBE_TOKEN":"your-token-here","SONARQUBE_ORGANIZATION":"your-org (for SonarCloud)"}}'
See the official Claude Code MCP documentation for more details.
There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.
If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.
To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".
When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:
{
"mcpServers": {
"sonarqube": {
"command": "npx",
"args": [
"-y",
"sonarqube-mcp-server@latest"
],
"env": {
"SONARQUBE_URL": "https://sonarcloud.io",
"SONARQUBE_TOKEN": "your-token-here",
"SONARQUBE_ORGANIZATION": "your-org (for SonarCloud)"
}
}
}
}
To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.
Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.
The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.
You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.
To add this MCP server to Claude Desktop:
1. Find your configuration file:
~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json~/.config/Claude/claude_desktop_config.json2. Add this to your configuration file:
{
"mcpServers": {
"sonarqube": {
"command": "npx",
"args": [
"-y",
"sonarqube-mcp-server@latest"
],
"env": {
"SONARQUBE_URL": "https://sonarcloud.io",
"SONARQUBE_TOKEN": "your-token-here",
"SONARQUBE_ORGANIZATION": "your-org (for SonarCloud)"
}
}
}
}
3. Restart Claude Desktop for the changes to take effect