Skip to main content

sonar_get_project_metrics

Get comprehensive project metrics including coverage, duplication, and quality ratings.

Description

Retrieves all quality metrics for a project in a single call. Provides a complete snapshot of project health including bugs, vulnerabilities, code smells, coverage, and duplication.

Parameters

ParameterTypeRequiredDefaultDescription
metricsarrayNoAllSpecific metrics to retrieve

Available Metrics

Quality Metrics

MetricDescriptionType
bugsTotal bug countnumber
vulnerabilitiesSecurity vulnerability countnumber
code_smellsCode smell countnumber
blocker_violationsBlocker severity issuesnumber
critical_violationsCritical severity issuesnumber

Coverage Metrics

MetricDescriptionType
coverageOverall test coverage %percentage
line_coverageLine coverage %percentage
branch_coverageBranch coverage %percentage
uncovered_linesLines without testsnumber

Duplication Metrics

MetricDescriptionType
duplicated_lines_densityDuplication %percentage
duplicated_linesTotal duplicated linesnumber
duplicated_blocksNumber of duplicate blocksnumber
duplicated_filesFiles with duplicationnumber

Size Metrics

MetricDescriptionType
nclocLines of code (no comments)number
linesTotal linesnumber
filesTotal filesnumber
functionsTotal functionsnumber
classesTotal classesnumber

Rating Metrics

MetricDescriptionValues
reliability_ratingBug ratingA-E (1-5)
security_ratingVulnerability ratingA-E (1-5)
sqale_ratingMaintainability ratingA-E (1-5)

Debt Metrics

MetricDescriptionType
sqale_indexTechnical debt (minutes)number
sqale_debt_ratioDebt ratio %percentage

Usage

Get All Metrics

Show me all project metrics

Tool call:

{}

Specific Metrics

Show me coverage and duplication stats

Tool call:

{
"metrics": ["coverage", "duplicated_lines_density", "uncovered_lines"]
}

Response Format

PROJECT METRICS
━━━━━━━━━━━━━━━

Project: my-awesome-app
Key: my-awesome-app-a1b2c3d4

📊 QUALITY OVERVIEW:
Bugs: 12 (Rating: B)
Vulnerabilities: 2 (Rating: C)
Code Smells: 156 (Rating: A)

📈 COVERAGE:
Overall: 67.3%
Line: 72.1%
Branch: 58.4%
Uncovered: 1,234 lines

📋 DUPLICATION:
Density: 4.2%
Lines: 890
Blocks: 45
Files: 12

📏 SIZE:
Lines of Code: 15,432
Files: 89
Functions: 456
Classes: 34

⏱️ TECHNICAL DEBT:
Total: 3d 4h (2,440 min)
Ratio: 2.3%

⭐ RATINGS:
Reliability: B
Security: C
Maintainability: A

Rating Scale

RatingMeaningThreshold
AExcellentNo issues
BGoodMinor issues
CAcceptableSome issues
DPoorMany issues
ECriticalSevere issues

Examples

Example 1: Health Check

Prompt:

Give me a quick health check of the project

Tool Call:

{
"metrics": ["bugs", "vulnerabilities", "coverage", "reliability_rating", "security_rating"]
}

Example 2: Coverage Report

Prompt:

What's the test coverage situation?

Tool Call:

{
"metrics": ["coverage", "line_coverage", "branch_coverage", "uncovered_lines"]
}

Example 3: Code Size

Prompt:

How big is this codebase?

Tool Call:

{
"metrics": ["ncloc", "files", "functions", "classes"]
}

Best Practices

  1. Regular monitoring - Track metrics over time
  2. Focus on trends - Improvement matters more than absolute values
  3. Set thresholds - Define acceptable limits for your team
  4. Balance metrics - Don't optimize one at expense of others