SS

sonarsource/sonarqube-mcp-server

Developer tools
593 stars 0 forks 品質 92 トレンド 92

Official SonarQube MCP Server for code quality and security in AI agents

概要

The SonarQube MCP Server is a Model Context Protocol (MCP) server that enables seamless integration with SonarQube Server or Cloud for code quality and security. It also supports the analysis of code snippet directly within the agent context. 🔒 : Your SonarQube token is a sensitive credential. Follow these security practices: - in command-line arguments – they get saved in shell history - – set tokens in environment variables before running commands - to version control - in config files when possible The fastest way to get started is the – an interactive tool that produces a ready-to-use configuration for your preferred AI agent client. If you prefer to configure things yourself, the simplest method is to use our container image at sonarsource/sonarqube-mcp. Use sonarsource/sonarqube-mcp for automatic updates (with --pull=always), or pin to a version tag (e.g., sonarsource/sonarqube-mcp:1.19.0.2785) for reproducible deployments. Read below if you want to build it locally.

README

SonarQube MCP Server

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

Quick setup

🚀 Generate your configuration

The fastest way to get started is the SonarQube MCP Server Configuration Generator – an interactive tool that produces a ready-to-use configuration for your preferred AI agent client.

Manual setup

If you prefer to configure things yourself, the simplest method is to use our container image at sonarsource/sonarqube-mcp. Use sonarsource/sonarqube-mcp for automatic updates (with --pull=always), or pin to a version tag (e.g., sonarsource/sonarqube-mcp:1.19.0.2785) for reproducible deployments. Read below if you want to build it locally.

Note: While the examples below use docker, any OCI-compatible container runtime works (e.g., Podman, nerdctl). Simply replace docker with your preferred tool.

💡 Tip: We recommend pulling the latest image regularly or before reporting issues to ensure you have the most up-to-date features and fixes.

Manual installation

You can manually install the SonarQube MCP server by copying the following snippet in the MCP servers configuration file:

  • To connect with SonarQube Cloud:
{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "--init",
      "--pull=always",
      "-i",
      "--rm",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_ORG",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "SONARQUBE_TOKEN": "",
      "SONARQUBE_ORG": ""
    }
  }
}
  • To connect with SonarQube Server:
{
  "sonarqube": {
    "command": "docker",
    "args": [
      "run",
      "--init",
      "--pull=always",
      "-i",
      "--rm",
      "-e",
      "SONARQUBE_TOKEN",
      "-e",
      "SONARQUBE_URL",
      "sonarsource/sonarqube-mcp"
    ],
    "env": {
      "SONARQUBE_TOKEN": "",
      "SONARQUBE_URL": ""
    }
  }
}

Integration with SonarQube for IDE

The SonarQube MCP Server can integrate with SonarQube for IDE to further enhance your development workflow, providing better code analysis and insights directly within your IDE.

Configuration

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

Base

You should add the following variable when running the MCP Server:

Environment variable Description
STORAGE_PATH Mandatory absolute path to a writable directory where SonarQube MCP Server will store its files (e.g., for creation, updates, and persistence), it is automatically provided when using the container image
SONARQUBE_PROJECT_KEY Optional default project key. When set, all tools that require a project key will use this value automatically — the projectKey parameter is removed from their schema entirely. Useful when working on a single project.
SONARQUBE_IDE_PORT Optional port number between 64120 and 64130 used to connect SonarQube MCP Server with SonarQube for IDE.
SONARQUBE_DEBUG_ENABLED When set to true, enables debug logging. Debug logs are written to both the log file and STDERR. Useful for troubleshooting connectivity or configuration issues. Default: false.
SONARQUBE_LOG_TO_FILE_DISABLED When set to true, disables writing logs to disk entirely. No log files will be created under STORAGE_PATH/logs/. Useful in containerized or ephemeral environments where file logging is undesirable. Default: false.

Workspace Mount (Reducing Context Bloat)

By default, analysis tool analyze_code_snippet requires the agent to pass the full file content as a fileContent argument. For large files or when analyzing many files in a session, this significantly increases context window usage and cost.

Solution: mount your project directory into the container at /app/mcp-workspace. When this mount is detected, the server reads files directly from disk using the project-relative filePath argument — file content never passes through the agent context.

{
  "args": [
    "run", "-i", "--rm", "--init", "--pull=always",
    "-e", "SONARQUBE_TOKEN",
    "-e", "SONARQUBE_ORG",
    "-v", "/path/to/your/project:/app/mcp-workspace",
    "sonarsource/sonarqube-mcp"
  ]
}

When the mount is active:

  • run_advanced_code_analysis becomes available if your organization is entitled to it
  • analyze_code_snippet: filePath is required and fileContent is not used — the server resolves the file the same way

Selective Tool Enablement

By default, only important toolsets are enabled to reduce context overhead. You can enable additional toolsets as needed.

Environment variable Description
SONARQUBE_TOOLSETS Comma-separated list of toolsets to enable. When set, only these toolsets will be available. If not set, default important toolsets are enabled (analysis, issues, projects, quality-gates, rules, duplications, measures, security-hotspots, dependency-risks, coverage, cag). Note: The projects toolset is always enabled as it’s required to find project keys for other operations. Context Augmentation tools are only available in stdio mode and require organization entitlement. In Streamable HTTP mode, clients can send a SONARQUBE_TOOLSETS HTTP header to narrow this further per-request, but cannot enable toolsets beyond what the server was launched with (see Streamable HTTP transport below).
SONARQUBE_READ_ONLY When set to true, enables read-only mode which disables all write operations (changing issue status for example). This filter is cumulative with SONARQUBE_TOOLSETS if both are set. Default: false. In Streamable HTTP mode, clients can send a SONARQUBE_READ_ONLY HTTP header to further restrict individual requests to read-only, but cannot lift a server-level read-only restriction (see Streamable HTTP transport below).

SonarQube Cloud

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

Environment variable Description Required
SONARQUBE_TOKEN Your SonarQube Cloud token Yes
SONARQUBE_ORG Your SonarQube Cloud organization key Yes
SONARQUBE_URL Custom SonarQube Cloud URL (defaults to https://sonarcloud.io). Use this for SonarQube Cloud US: https://sonarqube.us No

Examples:

  • SonarQube Cloud: Only SONARQUBE_TOKEN and SONARQUBE_ORG are needed
  • SonarQube Cloud US: Set SONARQUBE_TOKEN, SONARQUBE_ORG, and SONARQUBE_URL=https://sonarqube.us

SonarQube Server

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

⚠️ Connection to SonarQube Server requires a token of type USER and will not function properly if project tokens or global tokens are used.

💡 Configuration Tip (stdio mode): The presence of SONARQUBE_ORG determines whether you’re connecting to SonarQube Cloud or Server. If SONARQUBE_ORG is set, SonarQube Cloud is used; otherwise, SonarQube Server is used.

Transport Modes

The MCP specification defines two transport mechanisms: Stdio and Streamable HTTP. The SonarQube MCP Server supports both:

MCP transport Server mode Typical use
Stdio Default (no SONARQUBE_TRANSPORT) Local MCP clients that launch the server as a subprocess (Cursor, Claude Code, VS Code, etc.)
Streamable HTTP SONARQUBE_TRANSPORT=http or https Remote or multi-user deployments; clients connect to /mcp over HTTP(S) (e.g. Windsurf with a self-hosted server URL)

Note: Streamable HTTP is the current MCP network transport. The older SSE-only HTTP transport from earlier MCP versions is deprecated and not supported.

1. Stdio (Default - Recommended for Local Development)

The recommended mode for local development and single-user setups, used by most MCP clients.

Example - Docker with SonarQube Cloud:

{
  "mcpServers": {
    "sonarqube": {
      "command": "docker",
      "args": ["run", "--init", "--pull=always", "-i", "--rm", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_ORG", "sonarsource/sonarqube-mcp"],
      "env": {
        "SONARQUBE_TOKEN": "",
        "SONARQUBE_ORG": ""
      }
    }
  }
}

2. HTTP (Streamable HTTP)

Unencrypted Streamable HTTP transport. Use HTTPS instead for multi-user deployments.

⚠️ Not Recommended: Use Stdio for local development or HTTPS (Streamable HTTP) for multi-user production deployments.

Environment variable Description Default
SONARQUBE_TRANSPORT Set to http to enable Streamable HTTP transport Not set (stdio)
SONARQUBE_HTTP_PORT Port number (1024-65535) 8080
SONARQUBE_HTTP_HOST Host to bind (defaults to localhost for security) 127.0.0.1
SONARQUBE_HTTP_ALLOWED_ORIGINS Comma-separated browser origins allowed for CORS (e.g. https://my-app.example.com) Not set
SONARQUBE_MCP_IN_CONTAINER Set to true when running inside a container. The official Docker image sets this automatically; set it yourself when using other OCI runtimes (Podman, Kubernetes, Nomad, etc.). false

Note: In Streamable HTTP mode (HTTP or HTTPS), the server is stateless — each client request must include an Authorization: Bearer header carrying the user’s own SonarQube token. For SonarQube Cloud, the organization is resolved as follows:

  • If SONARQUBE_ORG is set at server startup, all requests are routed to that organization. Clients must not send a SONARQUBE_ORG header — doing so will result in an error.
  • If SONARQUBE_ORG is not set at server startup, each client must supply a SONARQUBE_ORG header on every request. Clients can also narrow the visible tools per-request by supplying SONARQUBE_TOOLSETS and/or SONARQUBE_READ_ONLY headers; these apply additional filtering on top of the server-level configuration — they can only reduce the scope, never expand it. No session state is maintained between requests.

Deprecated: The SONARQUBE_TOKEN request header is still accepted for backward compatibility but will be removed in a future version. Migrate to Authorization: Bearer .

3. HTTPS (Streamable HTTP over TLS) (Recommended for Multi-User Production Deployments)

Secure Streamable HTTP transport with TLS encryption. Requires SSL certificates.

Recommended for Production: Use HTTPS when deploying the MCP server for multiple users over Streamable HTTP. The server binds to 127.0.0.1 (localhost) by default for security.

Environment variable Description Default
SONARQUBE_TRANSPORT Set to https to enable Streamable HTTP transport over TLS Not set (stdio)
SONARQUBE_HTTP_PORT Port number (typically 8443 for HTTPS) 8080
SONARQUBE_HTTP_HOST Host to bind (defaults to localhost for security) 127.0.0.1
SONARQUBE_HTTP_ALLOWED_ORIGINS Comma-separated browser origins allowed for CORS (e.g. https://my-app.example.com) Not set
SONARQUBE_MCP_IN_CONTAINER Set to true when running inside a container. The official Docker image sets this automatically; set it yourself when using other OCI runtimes (Podman, Kubernetes, Nomad, etc.). false

SSL Certificate Configuration (Optional):

Environment variable Description Default
SONARQUBE_HTTPS_KEYSTORE_PATH Path to keystore file (.p12 or .jks) /etc/ssl/mcp/keystore.p12
SONARQUBE_HTTPS_KEYSTORE_PASSWORD Keystore password sonarlint
SONARQUBE_HTTPS_KEYSTORE_TYPE Keystore type (PKCS12 or JKS) PKCS12

Example - Docker with SonarQube Cloud:

Note: When running in a container, set SONARQUBE_HTTP_HOST=0.0.0.0 so the container listens on all interfaces and the runtime’s port mapping works, and set SONARQUBE_MCP_IN_CONTAINER=true to tell the server it is inside a container. The official Docker image sets the latter automatically; set it yourself when using other OCI runtimes (Podman, Kubernetes, Nomad, etc.). The host-side port flag controls who can reach the server from outside the container. SONARQUBE_HTTP_HOST=0.0.0.0 only controls where the server listens inside the container — browser CORS still allows localhost origins by default.

For a server running locally on your machine (accessible only from localhost):

docker run --init --pull=always -p 127.0.0.1:8443:8443 \
  -v $(pwd)/keystore.p12:/etc/ssl/mcp/keystore.p12:ro \
  -e SONARQUBE_TRANSPORT=https \
  -e SONARQUBE_HTTP_HOST=0.0.0.0 \
  -e SONARQUBE_HTTP_PORT=8443 \
  -e SONARQUBE_TOKEN="" \
  -e SONARQUBE_ORG="" \
  sonarsource/sonarqube-mcp

For a server accessible from the network (remote deployments):

docker run --init --pull=always -p 8443:8443 \
  -v $(pwd)/keystore.p12:/etc/ssl/mcp/keystore.p12:ro \
  -e SONARQUBE_TRANSPORT=https \
  -e SONARQUBE_HTTP_HOST=0.0.0.0 \
  -e SONARQUBE_HTTP_PORT=8443 \
  -e SONARQUBE_TOKEN="" \
  -e SONARQUBE_ORG="" \
  sonarsource/sonarqube-mcp

Client Configuration (SonarQube Cloud):

{
  "mcpServers": {
    "sonarqube-https": {
      "url": "https://your-server:8443/mcp",
      "headers": {
        "Authorization": "Bearer ",
        "SONARQUBE_ORG": "",
        "SONARQUBE_TOOLSETS": "issues,quality-gates",
        "SONARQUBE_READ_ONLY": "true"
      }
    }
  }
}

Client Configuration (SonarQube Server):

{
  "mcpServers": {
    "sonarqube-https": {
      "url": "https://your-server:8443/mcp",
      "headers": {
        "Authorization": "Bearer ",
        "SONARQUBE_TOOLSETS": "issues,quality-gates",
        "SONARQUBE_READ_ONLY": "true"
      }
    }
  }
}

Note: SONARQUBE_TOOLSETS and SONARQUBE_READ_ONLY are optional per-request headers that narrow the server-level tool set for that specific request. They can only reduce scope — they cannot enable toolsets or lift restrictions beyond what the server was launched with.

Note: For local development, use Stdio transport instead (the default). HTTPS Streamable HTTP is intended for multi-user production deployments with proper SSL certificates.

Service Endpoints

When running in Streamable HTTP mode (http or https), the server exposes a few unauthenticated service endpoints in addition to the MCP endpoint at /mcp. These are intended for service-to-service use (monitoring, orchestration, client compatibility checks) and do not require an Authorization header.

Endpoint Method Description Example response
/health GET Liveness probe. Returns 200 OK with an empty body once the server is accepting requests. (empty body)
/info GET Returns the MCP server version as JSON. Useful for verifying the deployed server version. {"version":"1.16.0"}

These endpoints are not available when running with the Stdio transport.

Custom Certificates

If your SonarQube Server uses a self-signed certificate or a certificate from a private Certificate Authority (CA), you can add custom certificates to the container that will automatically be installed.

Proxy

The SonarQube MCP Server supports HTTP and SOCKS5 proxies through standard Java proxy system properties.

Tools

Analysis

  • analyze_code_snippet - Analyze file content with SonarQube analyzers to identify code quality and security issues. Always analyzes the complete file content for accuracy. Optionally filter results to a specific code snippet.

    Usage:

    • With workspace mounted (recommended): pass filePath (project-relative) — the server reads the file directly, keeping file content out of the agent context window
    • Without workspace mount: pass complete fileContent for full file analysis (reports all issues)
    • Add optional codeSnippet to filter results - only issues within the snippet will be reported (snippet location auto-detected)

    Parameters:

    • projectKey - The SonarQube project key - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • filePath - Project-relative path of the file to analyze (e.g., src/main/java/MyClass.java). Used when the workspace is mounted at /app/mcp-workspace - String
    • fileContent - Complete file content as a string. Required when workspace is not mounted - String
    • codeSnippet - Code snippet to filter issues (must match content in fileContent) - String
    • language - Language of the code (e.g., ‘java’, ‘python’, ‘js’, ‘ts’, ‘tsx’, ‘jsx’) - String
    • scope - Scope of the file: MAIN or TEST (default: MAIN) - String

    Supported Languages: Java, Kotlin, Python, Ruby, Go, JavaScript (js, jsx), TypeScript (ts, tsx), JSP, PHP, XML, HTML, CSS, CloudFormation, Kubernetes, Terraform, Azure Resource Manager, Ansible, Docker, Secrets detection

When integration with SonarQube for IDE is enabled:

  • analyze_file_list - Analyze files in the current working directory using SonarQube for IDE. This tool connects to a running SonarQube for IDE instance to perform code quality analysis on a list of files.

    • file_absolute_paths - List of absolute file paths to analyze - Required String[]
  • toggle_automatic_analysis - Enable or disable SonarQube for IDE automatic analysis. When enabled, SonarQube for IDE will automatically analyze files as they are modified in the working directory. When disabled, automatic analysis is turned off.

    • enabled - Enable or disable the automatic analysis - Required Boolean

When advanced analysis is enabled for your SonarQube Cloud organization:

Requires having the workspace mounted at /app/mcp-workspace

  • run_advanced_code_analysis - Run advanced code analysis on SonarQube Cloud for a single file. Organization is inferred from MCP configuration.
    • projectKey - The key of the project - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branch - Branch name used to retrieve the latest analysis context - Required String
    • filePath - Project-relative path of the file to analyze (e.g., src/main/java/MyClass.java). - Required String
    • fileScope - Defines in which scope the file originates from: ‘MAIN’ or ‘TEST’ (default: MAIN) - String

Coverage

  • search_files_by_coverage - Search for files in a project sorted by coverage (ascending - worst coverage first). This tool helps identify files that need test coverage improvements.

    • projectKey - The project key to search in - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
    • maxCoverage - Maximum coverage threshold (0-100). Only return files with coverage <= this value - Number
    • pageIndex - Page index (1-based, default: 1) - Number
    • pageSize - Page size (default: 100, max: 500) - Number
  • get_file_coverage_details - Get line-by-line coverage information for a specific file, including which exact lines are uncovered and which have partially covered branches. This tool helps identify precisely where to add test coverage. Use after identifying files with low coverage via search_files_by_coverage.

    • key - File key (e.g. my_project:src/foo/Bar.java) - Required String
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
    • from - First line to analyze (1-based, default: 1) - Number
    • to - Last line to analyze (inclusive). If not specified, all lines are returned - Number

Dependency Risks

Note: Dependency risks are only available when connecting to SonarQube Server 2025.4 Enterprise or higher with SonarQube Advanced Security enabled.

  • search_dependency_risks - Search for software composition analysis issues (dependency risks) of a SonarQube project, paired with releases that appear in the analyzed project, application, or portfolio.
    • projectKey - Project key - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
    • pageIndex - Optional page index (1-based, default: 1) - Integer
    • pageSize - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 100) - Integer

Enterprises

Note: Enterprises are only available when connecting to SonarQube Cloud.

  • list_enterprises - List the enterprises available in SonarQube Cloud that you have access to. Use this tool to discover enterprise IDs that can be used with other tools.
    • enterpriseKey - Optional enterprise key to filter results - 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.

    • projectKeys - Optional list of SonarQube project keys - String[]
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
    • severities - Optional list of severities to filter by. Possible values: INFO, LOW, MEDIUM, HIGH, BLOCKER - String[]
    • impactSoftwareQualities - Optional list of software qualities to filter by. Possible values: MAINTAINABILITY, RELIABILITY, SECURITY - String[]
    • issueStatuses - Optional list of issue statuses to filter by. Possible values: OPEN, CONFIRMED, FALSE_POSITIVE, ACCEPTED, FIXED, IN_SANDBOX - String[]
    • issueKey - Optional issue key to fetch a specific issue - String
    • pageIndex - Optional 1-based page index (default: 1) - Integer
    • pageSize - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 100) - Integer

Security Hotspots

  • search_security_hotspots - Search for Security Hotspots in a SonarQube project.

    • projectKey - Project or application key - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • hotspotKeys - Comma-separated list of specific Security Hotspot keys to retrieve - String[]
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
    • files - Optional list of file paths to filter - String[]
    • status - Optional status filter: TO_REVIEW, REVIEWED - String
    • resolution - Optional resolution filter: FIXED, SAFE, ACKNOWLEDGED - String
    • sinceLeakPeriod - Filter hotspots created since the leak period (new code) - Boolean
    • onlyMine - Show only hotspots assigned to me - Boolean
    • pageIndex - Optional 1-based page index (default: 1) - Integer
    • pageSize - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 100) - Integer
  • show_security_hotspot - Get detailed information about a specific Security Hotspot, including rule details, code context, flows, and comments.

    • hotspotKey - Security Hotspot key - Required String
  • change_security_hotspot_status - Review a Security Hotspot by changing its status. When marking as REVIEWED, you must specify a resolution (FIXED, SAFE, or ACKNOWLEDGED).

    • hotspotKey - Security Hotspot key - Required String
    • status - New status - Required Enum {“TO_REVIEW”, “REVIEWED”}
    • resolution - Resolution when status is REVIEWED - Enum {“FIXED”, “SAFE”, “ACKNOWLEDGED”}
    • comment - Optional review comment - String

Languages

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

Measures

  • get_component_measures - Get SonarQube measures for a component (project, directory, file).
    • projectKey - The project key - Required String when SONARQUBE_PROJECT_KEY is not configured
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • metricKeys - Optional metric keys to retrieve (e.g. ncloc, complexity, violations, coverage) - String[]
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String

Metrics

  • search_metrics - Search for SonarQube metrics.
    • pageIndex - Optional 1-based page index (default: 1) - Integer
    • pageSize - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 100) - Integer

Portfolios

  • list_portfolios - List enterprise portfolios available in SonarQube with filtering and pagination options.

    For SonarQube Server:

    • q - Optional search query to filter portfolios by name or key - String
    • favorite - If true, only returns favorite portfolios - Boolean
    • pageIndex - Optional 1-based page number (default: 1) - Integer
    • pageSize - Optional page size, max 500 (default: 100) - Integer

    For SonarQube Cloud:

    • enterpriseId - Enterprise uuid. Can be omitted only if ‘favorite’ parameter is supplied with value true - String
    • q - Optional search query to filter portfolios by name - String
    • favorite - Required to be true if ‘enterpriseId’ parameter is omitted. If true, only returns portfolios favorited by the logged-in user. Cannot be true when ‘draft’ is true - Boolean
    • draft - If true, only returns drafts created by the logged-in user. Cannot be true when ‘favorite’ is true - Boolean
    • pageIndex - Optional index of the page to fetch (default: 1) - Integer
    • pageSize - Optional size of the page to fetch (default: 50) - Integer

Projects

  • search_my_sonarqube_projects - Find SonarQube projects. The response is paginated.

    • pageIndex - Optional 1-based page index (default: 1) - Integer
    • pageSize - Optional page size. Must be greater than 0 and less than or equal to 500 (default: 500) - Integer
    • q - Optional search query to filter projects by name (partial match) or key (exact match) - String
  • list_branches - List analyzed branches for a project.

    • SonarQube Cloud: returns long-lived (LONG) and short-lived (SHORT) branches with type and mergeBranch fields. Optional branchTypes filter: ALL (default), LONG, or SHORT.
    • SonarQube Server: returns all analyzed branches (name, quality gate, analysis date). No type, mergeBranch, or branchTypes filter.
    • Use returned branch names as the branch parameter on other tools. For pull request analysis, use list_pull_requests instead.
    • projectKey - Project key (e.g. my_project) - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branchTypes - (SonarQube Cloud only) Optional filter: ALL (default), LONG, or SHORT - Enum {“ALL”, “LONG”, “SHORT”}
  • list_pull_requests - List all pull requests for a project. Use this tool to discover pull requests for PR-decorated analysis (coverage, issues, quality gate). Returns the pull request key/ID which can be used with other tools. For branch-based analysis without pull requests, use list_branches instead.

    • projectKey - Project key (e.g. my_project) - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)

Quality Gates

  • get_project_quality_gate_status - Get the Quality Gate Status for the SonarQube project.

    • analysisId - Optional analysis ID - String
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • projectId - Optional project ID - String
    • projectKey - Optional project key - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
  • list_quality_gates - List all quality gates in my SonarQube.

Rules

  • show_rule - Shows detailed information about a SonarQube rule.
    • key - Rule key - Required String

Duplications

  • search_duplicated_files - Search for files with code duplications in a SonarQube project. By default, automatically fetches all duplicated files across all pages (up to 10,000 files max). Returns only files with duplications.

    • projectKey - Project key - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
    • pageSize - Optional number of results per page for manual pagination (max: 500). If not specified, auto-fetches all duplicated files - Integer
    • pageIndex - Optional page number for manual pagination (starts at 1). If not specified, auto-fetches all duplicated files - Integer
  • get_duplications - Get duplications for a file. Require Browse permission on file’s project.

    • key - File key - Required String
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String

Sources

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

    • key - File key - Required String
    • branch - Optional branch name for branch-based analysis. Use list_branches to discover valid names - String
    • pullRequest - Optional pull request key/ID. Use list_pull_requests to discover valid keys - String
  • get_scm_info - Get SCM information of SonarQube 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. Returns GREEN (fully operational), YELLOW (usable but needs attention), or RED (not operational).

  • 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. Returns ‘pong’ as plain text.

  • get_system_status - Get state information about SonarQube Server. Returns status (STARTING, UP, DOWN, RESTARTING, DB_MIGRATION_NEEDED, DB_MIGRATION_RUNNING), version, and id.

Webhooks

  • create_webhook - Create a new webhook for the SonarQube organization or project. Requires ‘Administer’ permission on the specified project, or global ‘Administer’ permission.

    • name - Webhook name - Required String
    • url - Webhook URL - Required String
    • projectKey - Optional project key for project-specific webhook - String
    • secret - Optional webhook secret for securing the webhook payload - String
  • list_webhooks - List all webhooks for the SonarQube organization or project. Requires ‘Administer’ permission on the specified project, or global ‘Administer’ permission.

    • projectKey - Optional project key to list project-specific webhooks - String

Context Augmentation

Agentic Readiness

Note: Agentic Readiness tools are only available on SonarQube Cloud and require the feature to be enabled for your organization.

  • start_agentic_readiness_assessment - Start an agentic readiness assessment for a project. Returns immediately with status PENDING and an assessmentId. Use get_agentic_readiness_assessment to poll for results.

    • projectKey - The project key - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branch - Branch to assess. Omit to use the project’s default branch - String
  • get_agentic_readiness_assessment - Retrieve the result of an assessment. Re-call with the same assessmentId until status is COMPLETED, FAILED, or INTERRUPTED. When completed, returns the overall level and a per-pillar breakdown with recommended actions and evidence.

    • assessmentId - The assessment ID returned by start_agentic_readiness_assessment - Required String
  • list_agentic_readiness_assessments - List all assessments for a project, newest first. Use get_agentic_readiness_assessment for full pillar-level results.

    • projectKey - The project key to list assessments for - Required String (Ignored when SONARQUBE_PROJECT_KEY is defined)
    • branch - Filter assessments by branch name. Omit to list assessments for all branches - String
    • pageIndex - 1-based page index (default: 1) - Number
    • pageSize - Number of items per page, max 100 (default: 50) - Number

Example Prompts

Once you’ve set up the SonarQube MCP Server, here are some example prompts for common real-world scenarios:

Build

Prefer the sonarsource/sonarqube-mcp container image.

To run the server as a standalone JAR without Docker, download a pre-built release from the SonarSource binaries repository. Every released version is published there as sonarqube-mcp-server-.jar (for example, sonarqube-mcp-server-1.19.0.2785.jar).

Troubleshooting

Application logs are written to the STORAGE_PATH/logs/mcp.log file by default. To disable file logging entirely, set SONARQUBE_LOG_TO_FILE_DISABLED=true.

Common Issues

“Feature is not working” or “Missing tools/functionality”

You may be running an outdated Docker image. Docker caches images locally, so you won’t automatically receive updates.

Solution: Update to the latest version:

docker pull sonarsource/sonarqube-mcp

After pulling the latest image, restart your MCP client to use the updated version.

Optionally, add the --pull=always flag to your docker run command to always check for and pull the latest version:

docker run --init --pull=always -i --rm -e SONARQUBE_TOKEN -e SONARQUBE_ORG sonarsource/sonarqube-mcp

“I want to pin to a specific version”

Browse available tags at sonarsource/sonarqube-mcp and reference the version you want:

docker pull sonarsource/sonarqube-mcp:1.19.0.2785

docker run --init -i --rm \
  -e SONARQUBE_TOKEN -e SONARQUBE_ORG \
  sonarsource/sonarqube-mcp:1.19.0.2785

In your MCP client config, use sonarsource/sonarqube-mcp: instead of sonarsource/sonarqube-mcp and remove --pull=always so Docker does not silently upgrade the image.

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. Using the SonarQube MCP Server in compliance with this documentation is a Non-Competitive Purpose and so is allowed under the SSAL.

Your use of SonarQube via MCP is governed by the SonarQube Cloud Terms of Service or SonarQube Server Terms and Conditions, including use of the Results Data solely for your internal software development purposes.

View this README on GitHub

インストール

docker run --init --pull=always -i --rm -e SONARQUBE_TOKEN -e SONARQUBE_ORG sonarsource/sonarqube-mcp

設定

{ "mcpServers": { "sonarqube": { "command": "docker", "args": ["run", "--init", "--pull=always", "-i", "--rm", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_ORG", "sonarsource/sonarqube-mcp"], "env": { "SONARQUBE_TOKEN": "<YOUR_TOKEN>", "SONARQUBE_ORG": "<YOUR_ORG>" } } } }