SonarQube MCP Server
Provides tools to query SonarQube for code quality metrics, issues, and duplication reports on pull requests and files.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@SonarQube MCP Server What are the Sonar metrics on PR 257?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
SonarQube MCP Server
A Model Context Protocol (MCP) server that gives Cursor AI (and any MCP-compatible AI) live access to SonarQube — so you can ask questions like:
"What SonarQube issues are in this file?" "What does Sonar say about my PR?" "Fix all issues in config.ts for PR 257"
…and Cursor fetches the data itself, no copy-pasting JSON.
Tools exposed
Tool | When AI uses it |
| "What's my coverage?" / "Does Sonar pass?" / "What are the Sonar metrics on PR 257?" |
| "What issues are on my PR?" / "What does Sonar say?" |
| "What issues are in this file?" / "Fix issues in config.ts" |
| "Which files have duplicated code?" / "What's the duplication?" |
Related MCP server: mcp-sonarcloud
Architecture
Cursor AI
│ (MCP protocol over stdio)
▼
SonarQube MCP Server (this repo)
│ (HTTPS with Teleport client certificates)
▼
Teleport (company SSO gateway)
│
▼
SonarQube APINote: SonarQube at OpenGov is behind Teleport, a secure access gateway. The server uses Teleport client certificates generated by
tsh apps login. If your SonarQube is directly accessible (no Teleport), the server works withouttsh.
Prerequisites
Node.js 18+ (Node 22 recommended)
tsh(Teleport CLI) — only needed if SonarQube is behind TeleportSonarQube user token — generate at SonarQube → My Account → Security → Generate Token
Cursor (or any MCP-compatible AI client)
Installation
Step 1 — Clone the repo
git clone https://github.com/rahulsingh-cloud/SonarQube-MCP-Server.git
cd SonarQube-MCP-ServerStep 2 — Install dependencies
npm installStep 3 — Build
npm run buildThis compiles index.ts → dist/index.js.
Configuration
Step 4 — Get your SonarQube token
Open SonarQube in your browser and log in
Go to My Account → Security → Generate Token
Name it
cursor-mcp, click Generate, copy the token
Step 5 — Register the MCP server with Cursor
Edit (or create) the Cursor MCP config file. The location depends on your OS:
OS | Path |
Windows |
|
macOS |
|
Linux |
|
Windows
{
"mcpServers": {
"sonarqube": {
"command": "node",
"args": ["C:\\Users\\YourName\\SonarQube-MCP-Server\\dist\\index.js"],
"env": {
"SONARQUBE_TOKEN": "squ_your_token_here",
"SONARQUBE_URL": "https://your-sonarqube-host",
"SONARQUBE_PROJECT": "your-project-key"
}
}
}
}Tip (Windows): Use double backslashes
\\in the path, or use forward slashes/— both work.
macOS / Linux
{
"mcpServers": {
"sonarqube": {
"command": "node",
"args": ["/Users/yourname/SonarQube-MCP-Server/dist/index.js"],
"env": {
"SONARQUBE_TOKEN": "squ_your_token_here",
"SONARQUBE_URL": "https://your-sonarqube-host",
"SONARQUBE_PROJECT": "your-project-key"
}
}
}
}Tip (macOS): Use
pwdinside the cloned repo folder to get the full path.
Replace in both:
your-project-key— found in SonarQube → Project → Project Informationsqu_your_token_here— your SonarQube token from Step 4https://your-sonarqube-host— your SonarQube base URL (e.g.https://sonarqube.yourcompany.com)
Step 6 — Restart Cursor
Close Cursor completely (Quit, not just close the window) and reopen it.
Windows: Right-click Cursor in the system tray → Quit
macOS:
Cmd+Qor Cursor menu → Quit Cursor
You'll see sonarqube listed with a green dot under Cursor Settings → MCP.
If SonarQube is behind Teleport (OpenGov setup)
Teleport is a secure access gateway. The server automatically detects and uses Teleport client certificates if tsh is installed and logged in.
Install tsh (Teleport CLI)
Windows:
Download from https://goteleport.com/download/ → Windows →
.exeinstallerRun the installer
Add the install folder to your
Pathenvironment variable (e.g.C:\Program Files\Teleport Connect\Programs)Restart your terminal
tsh version # verifymacOS (Homebrew):
brew install teleport
tsh version # verifymacOS (manual):
Download from https://goteleport.com/download/ → macOS →
.pkginstallerRun the installer —
tshis added to/usr/local/binautomatically
tsh version # verifyLog in to Teleport
Works the same on Windows, macOS, and Linux:
# Step 1 — Log in via browser SSO (Okta)
tsh login --proxy=opengov.teleport.sh --skip-version-check
# Step 2 — Get access to SonarQube specifically
tsh apps login sonarqube-engops-production --skip-version-check
# Step 3 — Verify access
tsh apps ls --skip-version-checkAfter tsh login, your browser opens for Okta SSO. After authenticating, return to the terminal and run steps 2 and 3.
The server automatically finds the certificates at:
macOS / Linux:
~/.tsh/keys/opengov.teleport.sh/<username>-app/opengov.teleport.sh/sonarqube-engops-production.crt
~/.tsh/keys/opengov.teleport.sh/<username>-app/opengov.teleport.sh/sonarqube-engops-production.keyWindows:
C:\Users\<YourName>\.tsh\keys\opengov.teleport.sh\<username>-app\opengov.teleport.sh\sonarqube-engops-production.crt
C:\Users\<YourName>\.tsh\keys\opengov.teleport.sh\<username>-app\opengov.teleport.sh\sonarqube-engops-production.keySupports both:
Teleport v18+ —
.crt/.keyfilesTeleport v17 and older —
-x509.pemfiles
Cert expiry: Teleport certificates expire (typically 12 hours). Run
tsh apps login sonarqube-engops-production --skip-version-checkagain and restart Cursor when they expire.
Usage
Once connected, just ask Cursor in plain English:
# Get PR metrics
"What does SonarQube say about PR 257?"
"Does my PR pass Sonar?"
"What's my coverage on PR 257?"
# Get file issues
"What SonarQube issues are in apps/web/src/og-assist/tools/config.ts?"
"Fix all issues in this file for PR 257"
# Get PR issues
"What issues were introduced in PR 257?"
"Show me all new code smells on my PR"
# Get duplication
"Which files have duplicated code in PR 257?"
"What's the duplication on my PR?"Cursor selects the right tool automatically based on your question.
Manual testing
You can test the server without Cursor by piping JSON-RPC directly.
macOS / Linux:
# List available tools
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}' | \
SONARQUBE_TOKEN=your_token \
SONARQUBE_URL=https://your-sonarqube \
SONARQUBE_PROJECT=your-project \
node dist/index.js
# Call a tool
echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"sonar_get_pr_metrics","arguments":{"pullRequest":"257"}}}' | \
SONARQUBE_TOKEN=your_token \
SONARQUBE_URL=https://your-sonarqube \
SONARQUBE_PROJECT=your-project \
node dist/index.jsWindows (PowerShell):
$env:SONARQUBE_TOKEN = "your_token"
$env:SONARQUBE_URL = "https://your-sonarqube"
$env:SONARQUBE_PROJECT = "your-project"
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}' | node dist/index.js
echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"sonar_get_pr_metrics","arguments":{"pullRequest":"257"}}}' | node dist/index.jsEnvironment variables
Variable | Required | Default | Description |
| ✅ Yes | — | SonarQube user token ( |
| No |
| SonarQube base URL |
| No |
| SonarQube project key |
Project structure
SonarQube-MCP-Server/
├── index.ts ← MCP server source (all logic)
├── dist/index.js ← compiled output (run this)
├── package.json
├── tsconfig.json
└── README.mdHow it works
Cursor reads
~/.cursor/mcp.jsonat startup and launches the server as a background processThe server registers 4 tools with names and descriptions
When you ask a question, Cursor's AI reads the tool descriptions and decides which tool to call
The server makes an HTTPS request to SonarQube (with Teleport certs if applicable) and returns the data
Cursor uses the data to answer your question or take action
Troubleshooting
Problem | Fix |
| Fully quit and reopen Cursor ( |
| Run |
| Token is wrong or expired — generate a new one from SonarQube → My Account → Security |
| Run |
Certs expired | Run |
| Run |
| Add |
License
MIT
Available Tools
4 toolssonar_get_duplication_reportA
Get the duplicated lines report for a pull request — which files have duplicated code and what percentage. Use this when the user mentions 'duplication' or 'duplicated lines'.
Inputs: pullRequest (required).
sonar_get_file_issuesA
Get open SonarQube issues for a specific source file. Use this when the user asks about issues in a particular file they are editing or viewing. Returns the list of issues with line number, rule, severity, and fix message.
Inputs: filePath (required), pullRequest.
sonar_get_pr_issuesA
Get all open SonarQube issues for a specific pull request, grouped by file. Use this when the user asks about issues on their PR, branch, or 'what does Sonar say'. Returns each file with its issues (rule, line, severity, message).
Inputs: pullRequest (required), severity.
sonar_get_pr_metricsA
Get quality metrics for a pull request: coverage on new code, duplication percentage, and issue counts (bugs, code smells, vulnerabilities). Use this when the user asks 'what is my coverage?', 'does Sonar pass?', or 'what are the Sonar metrics on my PR?'.
Inputs: pullRequest (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 4 tools
Each tool targets a distinct aspect of SonarQube data: duplication, file issues, PR issues, and PR metrics. No overlap in functionality.
All tools follow a consistent 'sonar_get_<descriptive_noun_phrase>' pattern, using snake_case throughout.
4 tools cover the essential read operations for SonarQube integration, neither too few nor too many for the domain.
Covers key retrieval needs (duplication, file-level issues, PR issues, metrics). Missing quality gate status check, but core workflows are addressed.
Maintenance
Related MCP Connectors
Direct access to Cypress tests results and accessibility reports in your AI workflow.
Run accessibility, contrast, and design token audits and file QA issues from your AI coding tool.
Deep security scans of repos you own from your editor: dependency CVEs, SAST, git-history secrets.
Read-only access to your CodeMouse accounts, repositories, and AI pull-request reviews.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceServer for SonarQube Give AI assistants direct access to your code quality, security & analysis data3MIT
- AlicenseAqualityCmaintenanceEnables interaction with SonarCloud projects, issues, quality gates, and security hotspots through natural language.15MIT
- AlicenseNot gradedqualityDmaintenanceEnables Cursor AI to interact with SQL Server databases, including querying, schema exploration, report generation, and chart creation.6 npmMIT
- AlicenseAqualityCmaintenanceConnects AI coding assistants to PyCharm's code quality inspections and optionally SonarQube for IDE, providing unified, de-duplicated code analysis results without uploading source code.82MIT