> 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/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/vortex-prerequisites.md).

# Prerequisites

The SonarQube Cloud and SonarQube Server prerequisites to meet before you install and use Sonar Vortex.

Before you start, make sure you meet the following prerequisites. Vortex works with SonarQube Cloud and with SonarQube Server, and some prerequisites depend on which one you connect to.

## Subscription

Vortex requires a subscription on the connection you use.

* **SonarQube Cloud**: Vortex requires a separate subscription to your Enterprise plan or annual Team plan. To trial or purchase Sonar Vortex, contact [our Sales team](https://www.sonarsource.com/products/sonarqube/contact-sales/). Your organization administrator sets this up. See [Sonar Vortex](/sonarqube-cloud/administering-sonarcloud/ai-features/sonar-vortex.md) in the SonarQube Cloud documentation.
* **SonarQube Server**: Vortex requires a separate subscription alongside SonarQube Server 2026.5 or newer, Enterprise or Data Center edition. To trial or purchase Sonar Vortex, contact [our Sales team](https://www.sonarsource.com/products/sonarqube/contact-sales/). Your instance administrator licenses it, deploys the Vortex analysis component, and enables Vortex, see [Sonar Vortex](https://docs.sonarsource.com/sonarqube-server/instance-administration/ai-features/sonar-vortex) in the SonarQube Server documentation.

> **Note:** If Vortex is not available on your connection, the SonarQube CLI tells you so when you run `sonar integrate` and skips the Vortex install. Ask your administrator to set it up, then run `sonar integrate` again.

## Project settings

Make sure your project:

* is analyzed in your CI pipeline on a long-lived branch. Vortex analysis restores the analyzer context collected during that analysis, and the context is stored per project and branch, so a project or branch that has never been analyzed has no context to restore.
* uses Architecture, for the best guidance of your agent: [Architecture](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/architecture) on SonarQube Cloud, or [Architecture](https://docs.sonarsource.com/sonarqube-server/architecture) on SonarQube Server

If you install Vortex through the [SonarQube MCP server](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-with-mcp.md), you also need your project key. You can find it in your project's settings.

## Connection details

Which values you need depends on the product you connect to:

|              | SonarQube Cloud                                                                        | SonarQube Server                                                           |
| ------------ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| URL          | `https://sonarcloud.io` for the EU region, or `https://sonarqube.us` for the US region | The base URL of your instance, for example `https://sonarqube.example.com` |
| Organization | Your organization key                                                                  | Does not apply. SonarQube Server has no organizations                      |
| Token        | A user token you generate yourself                                                     | A user token you generate yourself, under **My Account** > **Security**    |

> **Note:** Use a *user token*. Project tokens, global tokens, and scoped organization tokens do not work with Vortex.


---

# 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/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/vortex-prerequisites.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.