# VS Code with GitHub Copilot [VS Code with GitHub Copilot](https://code.visualstudio.com/docs/copilot/overview) is Microsoft's AI-assisted coding experience in Visual Studio Code. Use this MCP server setup when you want Sonar tools available in the Copilot Chat agent mode while you code. To use the SonarQube MCP server in VS Code, you must first install [Copilot Chat](https://code.visualstudio.com/docs/copilot/copilot-chat). If you prefer using a centrally managed MCP server, see [MCP server in SonarQube Cloud](#mcp-server-in-sonarqube-cloud). ## Use the configuration generator Use the official [SonarQube MCP Server configuration generator](https://mcp.sonarqube.com/config-generator.html) to get a configuration code snippet for your setup: 1. Identify the target MCP Client. 2. Find your [#common-variables](/agent-centric-development-cycle/developer-tools/mcp-server/reference/environment-variables.md#common-variables). 3. Choose a [hosting method](/agent-centric-development-cycle/developer-tools/mcp-server/setup/environment-considerations.md#hosting-method). 4. Enter the information into the configuration generator. 5. Paste the generated configuration into your configuration file. ## Manual setup ### Environment variables The following [common variables](/agent-centric-development-cycle/developer-tools/mcp-server/reference/environment-variables.md#common-variables) are required. Note that `SONARQUBE_TOKEN` applies to stdio transport only. For HTTP, HTTPS, or the embedded SonarQube Cloud MCP server, use the `Authorization: Bearer ` header instead. * `SONARQUBE_TOKEN`: Your SonarQube user token (stdio transport). * `SONARQUBE_ORG`: Your SonarQube Cloud organization key. Required for SonarQube Cloud only. * `SONARQUBE_URL`: Your SonarQube Server or Community Build URL. Also required for SonarQube Cloud in the US region (`https://sonarqube.us`). Not needed for SonarQube Cloud in the EU region. > **Important:** Your SonarQube token is a sensitive credential. Use environment variables to pass tokens rather than hardcoding them in configuration files. Never commit tokens to version control. ### Transport options The SonarQube MCP Server supports three transport modes. Use [Stdio](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#local-server-stdio) for local development and most use cases, [HTTPS](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#https) for production and team deployments, and [HTTP](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#http) only on trusted internal networks. #### Stdio (recommended) Use [Stdio](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#local-server-stdio) for local development or when you are the only user. It's also the transport mode used in your [Agentic Analysis](/agent-centric-development-cycle/features/agentic-analysis.md) and [Context Augmentation](/agent-centric-development-cycle/features/context-augmentation.md) workflows. **Automatic configuration** When you're using an AI-enabled IDE such as Cursor, Windsurf, or VS Code with Copilot enabled, and have already completed your [Connected mode setup](/sonarqube-for-vs-code/connect-your-ide/setup.md) in SonarQube for IDE with SonarQube Server or SonarQube Cloud, a quick select button is available. * Select the icon, **Configure MCP Server** from the **CONNECTED MODE** view window to use your connected mode credentials to start using the SonarQube MCP Server. The same workflow is available in the **AI AGENTS CONFIGURATION** view. If you've connected to a SonarQube Cloud organization in the US region, the configuration details will be shared. **Quick configuration** Use the following link to quickly set up the SonarQube MCP Server in VS Code. This generates a configuration file and automatically fills it with your environment variables. Make sure your environment variables are configured first. * [Connect to SonarQube Cloud](https://insiders.vscode.dev/redirect/mcp/install?name=sonarqube\&inputs=%5B%7B%22id%22%3A%22SONARQUBE_TOKEN%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22SonarQube%20Cloud%20Token%22%2C%22password%22%3Atrue%7D%2C%7B%22id%22%3A%22SONARQUBE_ORG%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22SonarQube%20Cloud%20Organization%20Key%22%2C%22password%22%3Afalse%7D%5D\&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22SONARQUBE_TOKEN%22%2C%22-e%22%2C%22SONARQUBE_ORG%22%2C%22mcp%2Fsonarqube%22%5D%2C%22env%22%3A%7B%22SONARQUBE_TOKEN%22%3A%22%24%7Binput%3ASONARQUBE_TOKEN%7D%22%2C%22SONARQUBE_ORG%22%3A%22%24%7Binput%3ASONARQUBE_ORG%7D%22%7D%7D) Find the [SonarQube MCP Server](https://github.com/mcp/SonarSource/sonarqube-mcp-server) in the GitHub MCP Registry, or search for it in VS Code Extensions using the term `@mcp sonar` to find an **Install** button. **Manual configuration** Follow the [VS Code instructions](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) and add the SonarQube MCP Server to your `.vscode/mcp.json` file. For environment variable details and token retrieval, see the [environment variables](/agent-centric-development-cycle/developer-tools/mcp-server/reference/environment-variables.md) page. > **Note:** This code sample configures the MCP server using [Stdio](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#local-server-stdio) transport, where `SONARQUBE_TOKEN` is passed as an environment variable. > > For [HTTPS](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#https), [HTTP](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#http), or the [MCP server in SonarQube Cloud](#mcp-server-in-sonarqube-cloud), the `SONARQUBE_TOKEN` header is deprecated. Pass the token using the `"Authorization": "Bearer "` header instead. > **Warning:** *User tokens* are required when setting up connected mode or an MCP Server between SonarQube Server and SonarQube for IDE. Note that binding won't function properly if *project tokens*, *global tokens*, or *scoped organization tokens* are used during the setup process. **VS Code with SonarQube Cloud** ```json { "servers": { "sonarqube": { "command": "docker", "args": [ "run", "-i", "--rm", "--init", "--pull=always", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_ORG", //"-e", //"SONARQUBE_URL", "mcp/sonarqube" ], "env": { "SONARQUBE_TOKEN": "", "SONARQUBE_ORG": "", //"SONARQUBE_URL": "https://sonarqube.us" } } } } ``` > **Note:** 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 a US-region instance. See the [Connecting to SonarQube Cloud in the US region](/agent-centric-development-cycle/developer-tools/mcp-server/setup/environment-considerations.md#connecting-to-sonarqube-cloud-in-the-us-region) section for details. **VS Code with SonarQube Server** ```json { "servers": { "sonarqube": { "command": "docker", "args": [ "run", "-i", "--rm", "--init", "--pull=always", "-e", "SONARQUBE_TOKEN", "-e", "SONARQUBE_URL", "mcp/sonarqube" ], "env": { "SONARQUBE_TOKEN": "", "SONARQUBE_URL": "" } } } } ``` #### HTTPS Use HTTPS when connecting VS Code to a shared MCP server deployed for a team. This requires an [HTTPS transport server](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#https) to be running and accessible. Add the following to your `.vscode/mcp.json` file: ```json { "servers": { "sonarqube": { "type": "https", "url": "https://:8443/mcp", "headers": { "Authorization": "Bearer " } } } } ``` #### HTTP > **Important:** The [HTTP](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#http) transport mode is not recommended. Use [Stdio](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#stdio) for local development or [HTTPS](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#https) for multi-user production deployments. Use HTTP only on a trusted internal network or for local testing. This requires an [HTTP transport server](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#http) to be running. Add the following to your `.vscode/mcp.json` file: ```json { "servers": { "sonarqube": { "type": "http", "url": "http://:8080/mcp", "headers": { "Authorization": "Bearer " } } } } ``` ## Agentic analysis and context augmentation When using Agentic Analysis and Context Augmentation services, your `SONARQUBE_TOKEN` will allow your local MCP server configured for [Stdio](/agent-centric-development-cycle/developer-tools/mcp-server/setup/self-hosted.md#local-server-stdio) mode to authenticate to the SonarQube Cloud API. See [Agentic Analysis](/agent-centric-development-cycle/features/agentic-analysis.md) and [Context Augmentation](/agent-centric-development-cycle/features/context-augmentation.md) for more information. ## MCP Server in SonarQube Cloud Use the SonarQube Cloud-hosted MCP server to avoid running and maintaining your own MCP infrastructure while always using the current server version. The embedded server exposes a smaller, fixed subset of tools; for the available toolsets and configuration details, check SonarQube Cloud's [MCP Server in SonarQube Cloud](https://docs.sonarsource.com/sonarqube-cloud/ai-capabilities/sonarqube-mcp-server#mcp-server-in-sonarqube-cloud) page. *** ## Use Sonar tools from VS Code Once connected, use the tools provided by the SonarQube MCP Server in agent mode. See the [tools](/agent-centric-development-cycle/developer-tools/mcp-server/reference/tools.md) page for the full list of available tools. See also the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_use-mcp-tools-in-agent-mode) for more information about using MCP servers in VS Code. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sonarsource.com/agent-centric-development-cycle/developer-tools/mcp-server/setup/quickstart-guides/vs-code.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.