docs: Add one-click "Add to Kiro" install badge#353
Conversation
SummaryThis PR adds a clickable "Add to Kiro" badge to the Kiro section of the README. When clicked, the badge redirects to Kiro's launch UI with pre-encoded configuration for this MCP server, allowing users to set it up with one click instead of manually editing JSON. The change is minimal and non-breaking — the existing manual configuration instructions remain as a fallback. What reviewers should knowWhere to look: Just the Kiro About the badge link: The URL contains base64-encoded JSON configuration with the Docker command, args, and required environment variables (SONARQUBE_TOKEN, SONARQUBE_ORG). This is decoded by Kiro's UI when the badge is clicked. No breaking changes: The original manual JSON setup instructions are preserved below the badge, so this only adds a convenience option for users who want quick setup via Kiro.
|
![sonar-review-alpha[bot]](https://avatars.githubusercontent.com/in/3025063?s=60&v=4){kind=small}
| <details> | ||
| <summary>Kiro</summary> | ||
|
|
||
| [](https://kiro.dev/launch/mcp/add?name=sonarqube&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--init%22%2C%22--pull%3Dalways%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22SONARQUBE_TOKEN%22%2C%22-e%22%2C%22SONARQUBE_ORG%22%2C%22mcp%2Fsonarqube%22%5D%2C%22env%22%3A%7B%22SONARQUBE_TOKEN%22%3A%22YOUR_TOKEN%22%2C%22SONARQUBE_ORG%22%3A%22YOUR_ORG%22%7D%7D) |
There was a problem hiding this comment.
The badge encodes a SonarQube Cloud configuration (it passes SONARQUBE_ORG but not SONARQUBE_URL), yet it is labelled generically as "Add to Kiro" and placed before the Cloud/Server split at lines 302 and 334. A SonarQube Server user who clicks this badge will have a Cloud config silently installed — wrong env vars, missing SONARQUBE_URL.
Both Cursor (lines 145–153) and VS Code (lines 369–375) handle this by:
- Labelling each badge explicitly ("Install for SonarQube Cloud" / "Install for SonarQube Server")
- Placing each badge directly under its matching
* To connect with SonarQube …heading
Either follow the same pattern here (separate, labelled badges), or at minimum rename the badge to make it clear it is Cloud-only and move it under the * To connect with SonarQube Cloud: heading at line 302.
| [](https://kiro.dev/launch/mcp/add?name=sonarqube&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--init%22%2C%22--pull%3Dalways%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22SONARQUBE_TOKEN%22%2C%22-e%22%2C%22SONARQUBE_ORG%22%2C%22mcp%2Fsonarqube%22%5D%2C%22env%22%3A%7B%22SONARQUBE_TOKEN%22%3A%22YOUR_TOKEN%22%2C%22SONARQUBE_ORG%22%3A%22YOUR_ORG%22%7D%7D) | |
| [](https://kiro.dev/launch/mcp/add?name=sonarqube&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--init%22%2C%22--pull%3Dalways%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22SONARQUBE_TOKEN%22%2C%22-e%22%2C%22SONARQUBE_ORG%22%2C%22mcp%2Fsonarqube%22%5D%2C%22env%22%3A%7B%22SONARQUBE_TOKEN%22%3A%22YOUR_TOKEN%22%2C%22SONARQUBE_ORG%22%3A%22YOUR_ORG%22%7D%7D) |
- Mark as noise
|
Hello @AnilMaktala, many thanks for your contribution. This is a valuable idea, and I tracked this effort in our backlog. That said, we’re currently revisiting our contribution guidelines, and contributions from external users are becoming more restricted for the time being. Because of this, we’d prefer to implement the changes ourselves internally. Would that be okay with you? |
2 participants
Adds one-click "Add to Kiro" install badge to the existing Kiro section.
When clicked, Kiro auto-configures this MCP server — no manual JSON editing needed.
<details>section (SonarQube Cloud config)Only the README is modified — no other content changed.