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

# Installing Vortex

## Prerequisites

Check the [prerequisites for Vortex](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/vortex-prerequisites.md).

## Installing Vortex in an agent

Find your agent in the following list and follow the instructions:

* [Install Vortex for Claude Code](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-claude-code.md)
* [Install Vortex for Codex](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-codex.md)
* [Install Vortex for GitHub Copilot CLI](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-copilot.md)
* [Install Vortex for Cursor](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-cursor.md)
* [Install Vortex for Antigravity](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-antigravity.md)
* [Install Vortex for Kiro](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-kiro.md)

If your agent is not in the list, install Vortex by [configuring the SonarQube MCP server](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-with-mcp.md).

## Checking your installation

After installing, confirm that your agent can reach Vortex. See [Checking your setup](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/check-vortex-setup.md).

## Using Vortex inside your agent

Your agent uses Vortex automatically, based on the skills and hooks installed for your agent type. You do not need to do anything beyond approving the tools as your agent starts using them.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sonarsource.com/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.