Skip to main content
Glama
sonar-mcp
by wadew

SonarQube MCP Server

PyPI version Python 3.11+ License: MIT Coverage

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-mcp

Quick 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_mcp

Streamable 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-mcp

SSE Mode (Server-Sent Events)

For clients that support SSE transport:

sonar-mcp --transport sse --port 8000

Command Line Options

Option

Description

Default

--transport

Transport protocol: stdio, sse, streamable-http

stdio

--host

Host address for HTTP transports

127.0.0.1

--port

Port for HTTP transports

8000

--version

Show version and exit

-

Environment Variables

Variable

Description

Required

SONAR_TOKEN

SonarQube API token

Yes

SONAR_URL

SonarQube server URL

Yes

SONAR_MCP_TRANSPORT

Default transport mode

No

SONAR_MCP_HOST

Default host for HTTP

No

SONAR_MCP_PORT

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

sonar_list_categories

Discover available tools by category

sonar_get_tool_schema

Get parameter schema for a specific tool

sonar_execute_tool

Execute any tool by name with arguments

Category: instance (4 tools)

Instance management for SonarQube server connections:

  • sonar_list_instances - List all configured instances

  • sonar_manage_instance - Create, update, delete instances

  • sonar_select_instance - Set the active instance

  • sonar_test_connection - Test instance connectivity

Category: project (3 tools)

Project operations:

  • sonar_list_projects - List all accessible projects

  • sonar_get_project - Get project details and metrics

  • sonar_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 information

  • sonar_transition_issue - Change issue status (resolve, falsepositive, etc.)

  • sonar_add_comment - Add a comment to an issue

  • sonar_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 metrics

  • sonar_get_coverage - Get coverage percentage

  • sonar_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 status

  • sonar_list_tasks - List background tasks

  • sonar_cancel_task - Cancel a running task

MCP Resources

Browseable URI-based access to SonarQube data:

URI Pattern

Description

sonarqube://projects

List all projects

sonarqube://projects/{key}

Get project details

sonarqube://projects/{key}/issues

Get project issues

sonarqube://projects/{key}/issues/{severity}

Get issues by severity

sonarqube://projects/{key}/metrics

Get project metrics

sonarqube://projects/{key}/quality-gate

Get quality gate status

MCP Prompts

Reusable prompt templates for code quality workflows:

Prompt

Description

code_review

Review code issues and suggest fixes

fix_issues

Generate fix recommendations for issues

quality_report

Generate quality report for a project

quality_goals

Check project against quality goals

security_audit

Perform security vulnerability audit

vulnerability_fix

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=80

Linting

# Check linting
ruff check src/ tests/

# Format code
ruff format src/ tests/

# Type checking
mypy src/

License

MIT License - see LICENSE for details.

Contributing

  1. Follow TDD (Test-Driven Development) - write tests first

  2. Maintain 80% coverage on ALL modules

  3. Ensure all linting and type checks pass

  4. Use conventional commits

See CONTRIBUTING.md for detailed guidelines.

Available Tools

3 tools
sonar_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_schemaA
Read-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_categoriesA
Read-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

    A4.6/5.0

    Scored across 3 tools

    Disambiguation5/5

    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.

    Naming Consistency5/5

    All tools follow a consistent 'sonar_verb_noun' pattern (list_categories, get_tool_schema, execute_tool), using snake_case and clear action-resource naming.

    Tool Count5/5

    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.

    Completeness5/5

    The set covers the full discovery-execution lifecycle: discover tools, inspect schema, then execute. No gaps for the intended meta-functionality.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      C
      maintenance
      An 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.
      5
      86 PyPI
      1
      MIT
    • A
      license
      C
      quality
      D
      maintenance
      A Python MCP server for SonarQube, enabling AI agents to query projects, issues, quality gates, coverage, and security hotspots.
      13
      MIT