sonar-mcp
Allows interaction with a SonarQube instance for managing projects, issues, metrics, quality gates, and performing code reviews and security audits.
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., "@sonar-mcp list all projects in my SonarQube instance"
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 for interacting with SonarQube code quality platform.
Features
21 SonarQube tools organized into 7 categories, accessible via dispatch pattern
6 MCP Prompts for code review, security audits, and quality reports
7 MCP Resources for browseable URI-based access to SonarQube data
Multi-instance support for managing multiple SonarQube servers
HTTP transport modes - stdio, SSE, and streamable-http
Related MCP server: sonarqube-api-mcp
Installation
# Using pip
pip install sonar-mcp
# Using uv (recommended)
uv pip install sonar-mcpQuick Start
1. Configure for Claude Code
Add to your Claude Code MCP settings:
{
"mcpServers": {
"sonar-mcp": {
"command": "sonar-mcp",
"env": {
"SONAR_TOKEN": "your-sonarqube-token",
"SONAR_URL": "https://sonarqube.example.com"
}
}
}
}2. Use the Tools
The server uses a dispatch pattern (similar to GitLab MCP) with just 3 meta-tools:
# Discover available tools by category
sonar_list_categories()
sonar_list_categories(category="issue") # Filter to specific category
# Get parameter schema for a tool
sonar_get_tool_schema(tool_name="sonar_list_issues")
# Execute any tool by name
sonar_execute_tool(tool_name="sonar_list_projects")
sonar_execute_tool(tool_name="sonar_list_issues", arguments={"project": "my-project"})Running the Server
Stdio Mode (Default)
For Claude Code and other MCP clients that use stdio transport:
sonar-mcp
# or
python -m sonar_mcpStreamable HTTP Mode
For web-based clients or remote access:
# Start server on default port 8000
sonar-mcp --transport streamable-http
# Custom host and port
sonar-mcp --transport streamable-http --host 0.0.0.0 --port 3000
# Using environment variables
SONAR_MCP_TRANSPORT=streamable-http SONAR_MCP_PORT=3000 sonar-mcpSSE Mode (Server-Sent Events)
For clients that support SSE transport:
sonar-mcp --transport sse --port 8000Command Line Options
Option | Description | Default |
| Transport protocol: |
|
| Host address for HTTP transports |
|
| Port for HTTP transports |
|
| Show version and exit | - |
Environment Variables
Variable | Description | Required |
| SonarQube API token | Yes |
| SonarQube server URL | Yes |
| Default transport mode | No |
| Default host for HTTP | No |
| Default port for HTTP | No |
Available Tools
Dispatch Meta-Tools (3 tools, always available)
These 3 tools provide access to all SonarQube functionality:
Tool | Description |
| Discover available tools by category |
| Get parameter schema for a specific tool |
| Execute any tool by name with arguments |
Category: instance (4 tools)
Instance management for SonarQube server connections:
sonar_list_instances- List all configured instancessonar_manage_instance- Create, update, delete instancessonar_select_instance- Set the active instancesonar_test_connection- Test instance connectivity
Category: project (3 tools)
Project operations:
sonar_list_projects- List all accessible projectssonar_get_project- Get project details and metricssonar_detect_project- Auto-detect project from current directory
Category: issue (5 tools)
Issue management:
sonar_list_issues- List issues with filtering (severity, type, status)sonar_get_issue- Get detailed issue informationsonar_transition_issue- Change issue status (resolve, falsepositive, etc.)sonar_add_comment- Add a comment to an issuesonar_bulk_transition- Bulk transition multiple issues
Category: quality (2 tools)
Quality gate operations:
sonar_get_quality_gate- Get quality gate status (OK/ERROR)sonar_check_goals- Validate against quality goals
Category: metrics (3 tools)
Metrics retrieval:
sonar_get_metrics- Get project metricssonar_get_coverage- Get coverage percentagesonar_get_file_coverage- Get file-level coverage details
Category: rules (1 tool)
Rule information:
sonar_get_rule- Get rule details and remediation guidance
Category: task (3 tools)
Async task management:
sonar_get_task- Get task statussonar_list_tasks- List background taskssonar_cancel_task- Cancel a running task
MCP Resources
Browseable URI-based access to SonarQube data:
URI Pattern | Description |
| List all projects |
| Get project details |
| Get project issues |
| Get issues by severity |
| Get project metrics |
| Get quality gate status |
MCP Prompts
Reusable prompt templates for code quality workflows:
Prompt | Description |
| Review code issues and suggest fixes |
| Generate fix recommendations for issues |
| Generate quality report for a project |
| Check project against quality goals |
| Perform security vulnerability audit |
| Generate fixes for security vulnerabilities |
Development
Setup
# Clone the repository
git clone https://github.com/wadew/sonar-mcp.git
cd sonar-mcp
# Create virtual environment
uv venv
source .venv/bin/activate
# Install dependencies
uv pip install -e ".[dev]"Testing
# Run all tests with coverage
pytest tests/ -v --cov=src/sonar_mcp --cov-report=term-missing
# Run with coverage enforcement (80% minimum)
pytest tests/ -v --cov=src/sonar_mcp --cov-fail-under=80Linting
# Check linting
ruff check src/ tests/
# Format code
ruff format src/ tests/
# Type checking
mypy src/License
MIT License - see LICENSE for details.
Contributing
Follow TDD (Test-Driven Development) - write tests first
Maintain 80% coverage on ALL modules
Ensure all linting and type checks pass
Use conventional commits
See CONTRIBUTING.md for detailed guidelines.
Available Tools
3 toolssonar_execute_toolA
Execute any SonarQube tool by name with the provided arguments.
Use after getting the schema to understand required parameters.
Args: tool_name: Name of the tool to execute (e.g., 'sonar_list_issues') arguments: Tool-specific arguments (optional). See sonar_get_tool_schema for details.
Returns: The tool's return value, or error dict if tool not found or execution fails.
Inputs: tool_name (required), arguments. Returns: object
sonar_get_tool_schemaARead-onlyIdempotent
Get the full JSON schema for a specific SonarQube tool.
Use after list_categories to get parameter details before calling execute_tool.
Args: tool_name: Name of the tool (e.g., 'sonar_list_issues', 'sonar_get_project')
Returns: Dictionary with: - success: bool - Operation success status - tool_name: str - The tool name - schema: dict - JSON schema for tool parameters - description: str - Tool description from docstring - error: str - Error message (if success is False)
Inputs: tool_name (required). Returns: object
sonar_list_categoriesARead-onlyIdempotent
Discover available SonarQube tools by category.
Returns tool names and descriptions. Categories: instance, project, issue, quality, metrics, rules, task
Args: category: Optional category name to filter (e.g., "project", "issue"). If provided, returns only that category's tools.
Returns: Dictionary with: - success: bool - Operation success status - categories: list - Available categories (when no filter) - category: dict - Single category details (when filtered) - total_tools: int - Total number of tools - error: str - Error message (if success is False)
Inputs: category. Returns: object
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool serves a unique purpose: list_categories allows discovery, get_tool_schema provides parameter details, and execute_tool runs the actual tool. No overlap in functionality.
All tools follow a consistent 'sonar_verb_noun' pattern (list_categories, get_tool_schema, execute_tool), using snake_case and clear action-resource naming.
Three tools is an ideal size for a meta-MCP server that dynamically exposes many underlying tools. Each tool earns its place with a critical role in the workflow.
The set covers the full discovery-execution lifecycle: discover tools, inspect schema, then execute. No gaps for the intended meta-functionality.
Maintenance
Related MCP Connectors
MCP server for the Seline Analytics API
MCP Spec Compliance MCP — audits any MCP server.json against the official Model Context Protocol
Repository knowledge graph MCP server for codebase understanding and debugging.
Model Context Protocol server for Studex tools, notifications, and profile integrations
Related MCP Servers
- AlicenseAqualityCmaintenanceAn MCP server for SonarQube that enables LLM agents to discover projects, analyze code quality metrics, check Quality Gate status, search issues with filters, and rank projects by worst-performing metrics. It provides read-only, safe access to SonarQube instances with structured outputs and error handling.586 PyPI1MIT
- AlicenseBqualityDmaintenanceRead-only MCP server that exposes SonarQube Web API tools for issue retrieval, quality gate status, and source context, enabling coding agents to fix code issues.8234 npm1MIT
- AlicenseAqualityDmaintenanceA Model Context Protocol (MCP) server that provides AI assistants with access to SonarQube code quality, security, and project analytics data.758 npmMIT
- AlicenseCqualityDmaintenanceA Python MCP server for SonarQube, enabling AI agents to query projects, issues, quality gates, coverage, and security hotspots.13MIT