> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/sonarqube-mcp-server/setup/quickstart-guides/zed.md).

# Zed

Set up the SonarQube MCP Server in Zed and start using Sonar tools with your agent.

[Zed](https://zed.dev/) is a next-generation code editor built for performance and collaboration. Use this MCP server setup when you want Sonar tools available within a Zed AI workflow.

The SonarQube MCP Server is available as a [Zed extension](https://zed.dev/extensions/mcp-server-sonarqube). For a custom configuration, use the [Zed custom configuration repository](https://github.com/SonarSource/sonarqube-mcp-server-zed).

## Choose your setup

The SonarQube MCP Server lets an AI agent query your SonarQube projects. With it, Zed can look up issues, quality gates, and coverage while it works. You can use a server that SonarQube hosts, run your own. Choose how to connect:

| Option                                                               | Is best for                                                                         | What you get                                                                                                       | Who sets it up                                     |
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
| [SonarQube Cloud-hosted](#connect-to-a-sonarqube-hosted-mcp-server)  | SonarQube Cloud users                                                               | Nothing to install and a smaller, fixed subset of tools. No Sonar Vortex.                                          | You connect                                        |
| [SonarQube Server-hosted](#connect-to-a-sonarqube-hosted-mcp-server) | SonarQube Server 2026.3 and later (Developer, Enterprise, and Data Center editions) | Nothing to install on your machine. No Sonar Vortex.                                                               | An administrator installs it, and then you connect |
| [Self-hosted MCP server](#set-up-a-self-hosted-mcp-server)           | Full control                                                                        | The MCP server that you run yourself, with the Sonar Vortex analysis and context tools through the Stdio transport | You                                                |

The [configuration generator](https://mcp.sonarqube.com/config-generator.html) gives you a snippet to paste into your Zed `settings.json` file.

## Connect to a SonarQube-hosted MCP server

To avoid running and maintaining your own MCP infrastructure while always using the current server version, connect to a SonarQube-hosted MCP server:

* SonarQube Cloud-hosted: for SonarQube Cloud users. The MCP server is embedded in SonarQube Cloud, so there's nothing to install, and it exposes a smaller, fixed subset of tools. To connect, see the [SonarQube Cloud-hosted](/sonarqube-mcp-server/setup/sonarqube-cloud-hosted.md) page.
* SonarQube Server-hosted: for SonarQube Server users on Developer, Enterprise, and Data Center editions, version 2026.3 and newer. An administrator installs the MCP server extension on your instance, and then you [connect your AI agent](/sonarqube-mcp-server/setup/sonarqube-server-hosted.md#connect-your-ai-agent). To install the extension, see the [SonarQube Server-hosted](/sonarqube-mcp-server/setup/sonarqube-server-hosted.md#install-the-mcp-server) page.

Neither the SonarQube Cloud-hosted nor the SonarQube Server-hosted option supports Sonar Vortex, which requires local filesystem access. Sonar Vortex is not installed by a plugin or the SonarQube CLI for Zed. To use it, set up a self-hosted MCP server. See [Vortex with the MCP server](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-with-mcp.md).

To get the connection snippet for either option, use the [configuration generator](https://mcp.sonarqube.com/config-generator.html) and select the matching hosting method.

## Set up a self-hosted MCP server

A self-hosted MCP server runs on your machine or in your own environment, and you manage it yourself.

### Before you start

The following [common variables](/sonarqube-mcp-server/reference/environment-variables.md#common-variables) are required. `SONARQUBE_TOKEN` applies to stdio transport only. For HTTP, HTTPS, or the SonarQube Cloud-hosted MCP server, use the `Authorization: Bearer <YourSonarQubeUserToken>` 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.

> **Warning:** *User tokens* are required when setting up connected mode or your SonarQube MCP server with SonarQube (Server, Cloud). Your binding will not function properly if you use *project tokens*, *global tokens*, or *scoped organization tokens* during setup.

When using these features, your `SONARQUBE_TOKEN` lets your local MCP server configured for [Stdio](/sonarqube-mcp-server/setup/self-hosted.md#local-server-stdio) mode authenticate to the SonarQube Cloud API. See [Sonar Vortex analysis](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/sonar-vortex-analysis.md) and [Sonar Vortex context](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/sonar-vortex-context.md) for more information.

### Install the Zed extension

The Zed extension for the SonarQube MCP Server uses [Stdio](/sonarqube-mcp-server/setup/self-hosted.md#local-server-stdio) transport. It's also the transport mode used in your [Sonar Vortex analysis](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/sonar-vortex-analysis.md) and [Sonar Vortex context](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/sonar-vortex-context.md) workflows.

> **Note:** The Zed extension supports Stdio transport only. For HTTPS or HTTP transport, use the [custom configuration repository](https://github.com/SonarSource/sonarqube-mcp-server-zed).

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](/sonarqube-mcp-server/reference/environment-variables.md#common-variables).
3. Choose a [hosting method](/sonarqube-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.

Navigate to the **Extensions** view in Zed and search for `SonarQube MCP Server`. When installing the extension, you'll be prompted to enter the necessary environment variables:

> **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](/sonarqube-mcp-server/setup/environment-considerations.md#connecting-to-sonarqube-cloud-in-the-us-region) section for details.

**Zed with SonarQube Cloud**

```jsonc
{
  "sonarqube_token": "<YourSonarQubeUserToken>",
  "sonarqube_org": "<YourSonarQubeOrganizationKey>",
  //"sonarqube_url": "https://sonarqube.us",
  "docker_path": "<YourDockerPath>"
}
```

**Zed with SonarQube Server**

```json
{
  "sonarqube_token": "<YourSonarQubeUserToken>",
  "sonarqube_url": "<YourSonarQubeServerURL>",
  "docker_path": "<YourDockerPath>"
}
```

The `docker_path` is the path to a container runtime executable. Examples:

* Linux/macOS: `/usr/bin/docker` or `/usr/local/bin/docker`
* Windows: `C:\Program Files\Docker\Docker\resources\bin\docker.exe`

> **Tip:** To verify the connection, ask your AI agent to call the SonarQube MCP `ping_system` tool. For example: *"Ping the SonarQube MCP server."*

> **Tip:** Restart your AI agent for good measure, although it might not be required.

## Use Sonar tools from Zed

Once connected, Zed can call SonarQube MCP tools on your behalf. See the SonarQube MCP [Tools](/sonarqube-mcp-server/reference/tools.md) page for the full list of available tools.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sonarsource.com/sonarqube-mcp-server/setup/quickstart-guides/zed.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.