> 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/resources/help.md).

# Help

## The Sonar Community

For SonarQube for IDE support questions ("How do I?", "I got this error, why?", …), check the [Troubleshooting](/sonarqube-mcp-server/resources/troubleshooting.md) page first, then head to the [Sonar Community forum](https://community.sonarsource.com/). Before creating a new topic, check if your question has already been answered—someone may have had the same issue.

When creating a new topic, describe your issue in as much detail as possible. Use this template:

* **Your IDE flavor/version/OS** (when applicable). For *example:*
  * *Cursor: 1.7.17 (Universal)*

    *VSCode Version: 1.99.3*\
    \&#xNAN;*MacOSX*
* **Your SonarQube for IDE version** (when applicable):
  * **If you're using SonarQube for IDE and have an error, please include the full stacktrace of the error and logs with** ***Verbose output*** **enabled.** *See your IDE-specific **Troubleshooting page** for detailed instructions to get these logs.*
* **Are you connecting to SonarQube Cloud, SonarQube Server, or the SonarQube Community Build?**
* **If you are using SonarQube Server or the SonarQube Community Build:**
  * **Which version do you have?**
  * **What are the installed analyzers?** *Get the list by opening* `https://<SQ server>/api/plugins/installed` *in a web browser.*

Be aware that the Sonar Community Forum is a community, and the standard pleasantries are expected (*Hello*, *Thank you*, *I appreciate the reply*, *etc*). If you don’t get an answer to your thread, please wait for at least three days before bumping it. Operators are not standing by, but the teams and community managers know that your questions are important.

## How to contribute

To suggest a new feature, visit the [Suggest new features](https://community.sonarsource.com/tags/c/suggestions/12/sonarqube-ide) topic on the Community. There, you can discuss your needs and engage the product manager and development teams directly. Add to an ongoing discussion or create a new thread if you have something new to share.


---

# 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/sonarqube-mcp-server/resources/help.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.