> 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.md).

# IDE/CLI quickstart guides

Quickstart guides for setting up the SonarQube MCP Server with your favorite IDE or CLI.

These guides set up a [self-hosted MCP server](/sonarqube-mcp-server/setup/self-hosted.md). You run and manage it yourself, locally or in your agent environment. To connect to a hosted server instead, with no infrastructure to manage, see the [SonarQube Cloud-hosted](/sonarqube-mcp-server/setup/sonarqube-cloud-hosted.md) or [SonarQube Server-hosted](/sonarqube-mcp-server/setup/sonarqube-server-hosted.md) pages.

Choose your IDE or CLI for step-by-step setup and workflow instructions:

* [Antigravity](/sonarqube-mcp-server/setup/quickstart-guides/antigravity.md) (Google's multi-surface AI coding platform)
* [Claude Code](/sonarqube-mcp-server/setup/quickstart-guides/claude-code.md)
* [Codex CLI](/sonarqube-mcp-server/setup/quickstart-guides/codex-cli.md)
* [Cursor](/sonarqube-mcp-server/setup/quickstart-guides/cursor.md)
* [VS Code](/sonarqube-mcp-server/setup/quickstart-guides/vs-code.md)
* [GitHub Copilot CLI](/sonarqube-mcp-server/setup/quickstart-guides/github-copilot-cli.md)
* [GitHub Copilot Cloud Agent](/sonarqube-mcp-server/setup/quickstart-guides/github-copilot-cloud-agent.md)
* [Kiro](/sonarqube-mcp-server/setup/quickstart-guides/kiro.md)
* [Devin Desktop](/sonarqube-mcp-server/setup/quickstart-guides/devin-desktop.md)
* [Zed](/sonarqube-mcp-server/setup/quickstart-guides/zed.md)

## Configuration guide

Before you start, review the [Prerequisites](/sonarqube-mcp-server/setup/prerequisites.md).

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.

For client-specific manual setup steps, open the guide for your IDE or CLI from the list above.


---

# 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.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.