MCP-276 Provide line-by-line coverage via a tool #193

nquinquenel · 2026-02-05T21:14:21Z

No description provided.

hashicorp-vault-sonar-prod · 2026-02-05T21:14:36Z

nquinquenel · 2026-02-06T08:48:31Z

@copilot Can you mark as accepted the issues about "Refactor your code to get this URI from a customizable parameter." and provide a fix for the other issues

Copilot · 2026-02-06T08:48:43Z

@nquinquenel I've opened a new pull request, #195, to work on those changes. Once the pull request is ready, I'll request review from you.

sonarqubecloud · 2026-02-06T11:10:09Z

SonarQube reviewer guide

Summary: Add test coverage analysis toolset with two new tools for searching files by coverage and viewing detailed line-by-line coverage information.

Review Focus:

The coverage filtering logic in SearchFilesByCoverageTool needs careful review—verify the min/max coverage threshold application is correct
The HTML tag stripping in GetFileCoverageDetailsTool.stripHtmlTags() is a regex operation that should handle edge cases properly
API response parsing in the new ComponentTreeResponse and SourceLinesResponse classes—ensure null-safety and metric value parsing handle SonarQube's response variations
Tool registration in SonarQubeMcpServer.loadBackendIndependentTools() and the new COVERAGE tool category enum

Start review at: src/main/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageTool.java. This is the main tool implementation that orchestrates multiple API calls and applies filtering logic—it's critical for correct functionality and has the most complex business logic of the changeset.

💬 Please send your feedback

Quality Gate passed

Issues
0 New issues
2 Accepted issues
0 Dependency risks

Measures
0 Security Hotspots
87.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

eray-felek-sonarsource

We seem to be doing a lot of complex computation here and relying on the Internal API. Did we contact any team regarding this feature, I think it would be best if they had an actual API that is not Internal and is simple for us to use for this use case. Also not sure about the benefit of searching a range for coverage, I think we can just return ordered from least to most covered files.

eray-felek-sonarsource · 2026-02-12T10:24:06Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageTool.java

+    }
+
+    // Set default page values
+    var actualPageIndex = (pageIndex != null && pageIndex > 0) ? pageIndex : 1;


Since page index is optional there is a good chance the LLM will not provide it most of the time and we might actually have a coverage in other pages that we don't see that fits our range

Copilot

Pull request overview

Adds a new “Coverage” toolset to the SonarQube MCP Server, exposing project/file coverage search and line-by-line file coverage details via new tools and supporting server API endpoints.

Changes:

Introduces ToolCategory.COVERAGE and documents it in the README.
Adds two new MCP tools: search_files_by_coverage and get_file_coverage_details, including schema/response models.
Extends server API clients with /api/measures/component_tree and /api/sources/lines response models and request methods, plus tests.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
src/test/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsToolTests.java	Adds tests validating coverage-details tool schema and behavior.
src/test/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageToolTests.java	Adds tests validating coverage-search tool schema and behavior.
src/test/java/org/sonarsource/sonarqube/mcp/tools/ToolCategoryTest.java	Updates category assertions to include the new `coverage` toolset.
src/main/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsToolResponse.java	Defines the structured response for file coverage details.
src/main/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsTool.java	Implements the line-by-line coverage details tool over `/api/sources/lines`.
src/main/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageToolResponse.java	Defines the structured response for searching files by coverage.
src/main/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageTool.java	Implements coverage-based file search using `/api/measures/component_tree`.
src/main/java/org/sonarsource/sonarqube/mcp/tools/ToolCategory.java	Adds `COVERAGE("coverage")` to the tool category enum.
src/main/java/org/sonarsource/sonarqube/mcp/serverapi/sources/response/SourceLinesResponse.java	Adds model for `/api/sources/lines` response payload.
src/main/java/org/sonarsource/sonarqube/mcp/serverapi/sources/SourcesApi.java	Adds `/api/sources/lines` request method.
src/main/java/org/sonarsource/sonarqube/mcp/serverapi/measures/response/ComponentTreeResponse.java	Adds model for measures component tree response.
src/main/java/org/sonarsource/sonarqube/mcp/serverapi/measures/MeasuresApi.java	Adds `/api/measures/component_tree` request method.
src/main/java/org/sonarsource/sonarqube/mcp/serverapi/measures/ComponentTreeParams.java	Adds request parameter record for component tree query.
src/main/java/org/sonarsource/sonarqube/mcp/SonarQubeMcpServer.java	Registers the new coverage tools with the server.
README.md	Documents the new “Coverage” toolset and its tools/parameters.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T12:01:15Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsTool.java

+  public static final String FROM_PROPERTY = "from";
+  public static final String TO_PROPERTY = "to";
+
+  private static final Pattern HTML_TAG_PATTERN = Pattern.compile("<[^>]*>");


The current HTML stripping regex will remove any angle-bracket content, which can corrupt legitimate Java code like generics (List<String>) or comparisons containing <...>. Consider stripping only the known syntax-highlighting tags (e.g., matching only <span ...> and </span>) rather than any <...> sequence.

Suggested change

private static final Pattern HTML_TAG_PATTERN = Pattern.compile("<[^>]*>");

private static final Pattern HTML_TAG_PATTERN = Pattern.compile("</?span\\b[^>]*>");

Copilot · 2026-02-12T12:01:15Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsTool.java

+  static String stripHtmlTags(String html) {
+    return HTML_TAG_PATTERN.matcher(html).replaceAll("");
+  }


The current HTML stripping regex will remove any angle-bracket content, which can corrupt legitimate Java code like generics (List<String>) or comparisons containing <...>. Consider stripping only the known syntax-highlighting tags (e.g., matching only <span ...> and </span>) rather than any <...> sequence.

Copilot · 2026-02-12T12:01:16Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsTool.java

+        .addNumberProperty(FROM_PROPERTY, "First line to analyze (1-based, default: 1)")
+        .addNumberProperty(TO_PROPERTY, "Last line to analyze (inclusive). If not specified, all lines are returned")


The schema declares from/to as “Number”, but the implementation reads them as integers. This can create client/server mismatches (e.g., a client sending 10.0 or any non-integer JSON number). Prefer using an integer-typed schema property (if available in SchemaToolBuilder) or parse as a numeric type and validate/coerce to int before calling the API.

Suggested change

.addNumberProperty(FROM_PROPERTY, "First line to analyze (1-based, default: 1)")

.addNumberProperty(TO_PROPERTY, "Last line to analyze (inclusive). If not specified, all lines are returned")

.addIntegerProperty(FROM_PROPERTY, "First line to analyze (1-based, default: 1)")

.addIntegerProperty(TO_PROPERTY, "Last line to analyze (inclusive). If not specified, all lines are returned")

Copilot · 2026-02-12T12:01:16Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsTool.java

+    var from = arguments.getOptionalInteger(FROM_PROPERTY);
+    var to = arguments.getOptionalInteger(TO_PROPERTY);


The schema declares from/to as “Number”, but the implementation reads them as integers. This can create client/server mismatches (e.g., a client sending 10.0 or any non-integer JSON number). Prefer using an integer-typed schema property (if available in SchemaToolBuilder) or parse as a numeric type and validate/coerce to int before calling the API.

Copilot · 2026-02-12T12:01:16Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageTool.java

+        .addNumberProperty(PAGE_INDEX_PROPERTY, "Page index (1-based, default: 1)")
+        .addNumberProperty(PAGE_SIZE_PROPERTY, "Page size (default: 100, max: 500)")


These parameters are exposed as “Number” in the tool schema but are parsed as integers in the implementation. To avoid client interoperability issues, align the schema and parsing: declare these as integer properties (preferred) or parse numeric values as Double/Number then validate and convert to int.

Suggested change

.addNumberProperty(PAGE_INDEX_PROPERTY, "Page index (1-based, default: 1)")

.addNumberProperty(PAGE_SIZE_PROPERTY, "Page size (default: 100, max: 500)")

.addIntegerProperty(PAGE_INDEX_PROPERTY, "Page index (1-based, default: 1)")

.addIntegerProperty(PAGE_SIZE_PROPERTY, "Page size (default: 100, max: 500)")

Copilot · 2026-02-12T12:01:16Z

src/main/java/org/sonarsource/sonarqube/mcp/tools/measures/SearchFilesByCoverageTool.java

+    var minCoverage = arguments.getOptionalInteger(MIN_COVERAGE_PROPERTY);
+    var maxCoverage = arguments.getOptionalInteger(MAX_COVERAGE_PROPERTY);
+    var pageIndex = arguments.getOptionalInteger(PAGE_INDEX_PROPERTY);
+    var pageSize = arguments.getOptionalInteger(PAGE_SIZE_PROPERTY);
+


These parameters are exposed as “Number” in the tool schema but are parsed as integers in the implementation. To avoid client interoperability issues, align the schema and parsing: declare these as integer properties (preferred) or parse numeric values as Double/Number then validate and convert to int.

Suggested change

var minCoverage = arguments.getOptionalInteger(MIN_COVERAGE_PROPERTY);

var maxCoverage = arguments.getOptionalInteger(MAX_COVERAGE_PROPERTY);

var pageIndex = arguments.getOptionalInteger(PAGE_INDEX_PROPERTY);

var pageSize = arguments.getOptionalInteger(PAGE_SIZE_PROPERTY);

Number minCoverageNumber = arguments.getOptionalNumber(MIN_COVERAGE_PROPERTY);

Integer minCoverage = null;

if (minCoverageNumber != null) {

if (minCoverageNumber.doubleValue() % 1 != 0) {

return Tool.Result.failure("minCoverage must be an integer value");

}

minCoverage = minCoverageNumber.intValue();

}

Number maxCoverageNumber = arguments.getOptionalNumber(MAX_COVERAGE_PROPERTY);

Integer maxCoverage = null;

if (maxCoverageNumber != null) {

if (maxCoverageNumber.doubleValue() % 1 != 0) {

return Tool.Result.failure("maxCoverage must be an integer value");

}

maxCoverage = maxCoverageNumber.intValue();

}

Number pageIndexNumber = arguments.getOptionalNumber(PAGE_INDEX_PROPERTY);

Integer pageIndex = null;

if (pageIndexNumber != null) {

if (pageIndexNumber.doubleValue() % 1 != 0) {

return Tool.Result.failure("pageIndex must be an integer value");

}

pageIndex = pageIndexNumber.intValue();

}

Number pageSizeNumber = arguments.getOptionalNumber(PAGE_SIZE_PROPERTY);

Integer pageSize = null;

if (pageSizeNumber != null) {

if (pageSizeNumber.doubleValue() % 1 != 0) {

return Tool.Result.failure("pageSize must be an integer value");

}

pageSize = pageSizeNumber.intValue();

}

Copilot · 2026-02-12T12:01:17Z

...ain/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsToolResponse.java

+) {
+
+  public record CoverageSummary(
+    @JsonPropertyDescription("Total number of lines in the file") int totalLines,


totalLines is described as “Total number of lines in the file”, but GetFileCoverageDetailsTool computes it as sources.size(), which becomes “number of lines returned” (especially when from/to are used). Update the description to match the actual semantics (e.g., “Total number of lines returned in this response/range”) or change computation to reflect actual file total lines.

Suggested change

@JsonPropertyDescription("Total number of lines in the file") int totalLines,

@JsonPropertyDescription("Total number of lines returned in this response or range") int totalLines,

Copilot · 2026-02-12T12:01:17Z

...ain/java/org/sonarsource/sonarqube/mcp/tools/sources/GetFileCoverageDetailsToolResponse.java

+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonPropertyDescription;
+import jakarta.annotation.Nullable;


This file uses jakarta.annotation.Nullable, while several other newly added/updated classes use javax.annotation.Nullable (e.g., GetFileCoverageDetailsTool, SourceLinesResponse, ComponentTreeResponse, ComponentTreeParams). Mixing jakarta and javax nullability annotations in the same module commonly causes dependency/classpath friction; standardize on one annotation package across the project.

Suggested change

import jakarta.annotation.Nullable;

import javax.annotation.Nullable;

Copilot · 2026-02-12T12:01:17Z

src/main/java/org/sonarsource/sonarqube/mcp/serverapi/sources/response/SourceLinesResponse.java

+      return conditions != null && coveredConditions != null
+        && coveredConditions > 0 && coveredConditions < conditions;
+    }
+
+    public boolean hasNoBranchCoverage() {
+      return conditions != null && (coveredConditions == null || coveredConditions == 0);


hasNoBranchCoverage() treats conditions = 0 as “no branch coverage”, which can incorrectly classify lines with no branches as uncovered for branch coverage and add them to partiallyConditionalLines. Consider requiring conditions > 0 (and similarly guarding other branch-coverage helpers) so only lines with actual branches are included.

Suggested change

return conditions != null && coveredConditions != null

&& coveredConditions > 0 && coveredConditions < conditions;

}

public boolean hasNoBranchCoverage() {

return conditions != null && (coveredConditions == null || coveredConditions == 0);

return conditions != null && conditions > 0 && coveredConditions != null

&& coveredConditions > 0 && coveredConditions < conditions;

}

public boolean hasNoBranchCoverage() {

return conditions != null && conditions > 0 && (coveredConditions == null || coveredConditions == 0);

MCP-276 Provide line-by-line coverage via a tool

462fee4

nquinquenel added 2 commits February 5, 2026 23:21

Fix tests

195b0e4

Fix tests

767e15d

Copilot AI mentioned this pull request Feb 6, 2026

Fix S139: Move trailing comments to separate lines #195

Merged

Copilot AI and others added 2 commits February 6, 2026 11:23

Fix S139: Move trailing comments to separate lines (#195)

5200b14

Clean up

99e5f4d

nquinquenel requested a review from damien-urruty-sonarsource February 9, 2026 16:04

nquinquenel marked this pull request as ready for review February 9, 2026 16:04

nquinquenel requested review from eray-felek-sonarsource and removed request for damien-urruty-sonarsource February 11, 2026 09:53

eray-felek-sonarsource reviewed Feb 12, 2026

View reviewed changes

eray-felek-sonarsource requested a review from Copilot February 12, 2026 11:59

Copilot AI reviewed Feb 12, 2026

View reviewed changes

	private static final Pattern HTML_TAG_PATTERN = Pattern.compile("<[^>]*>");
	private static final Pattern HTML_TAG_PATTERN = Pattern.compile("</?span\\b[^>]*>");

		.addNumberProperty(FROM_PROPERTY, "First line to analyze (1-based, default: 1)")
		.addNumberProperty(TO_PROPERTY, "Last line to analyze (inclusive). If not specified, all lines are returned")

		var from = arguments.getOptionalInteger(FROM_PROPERTY);
		var to = arguments.getOptionalInteger(TO_PROPERTY);

		.addNumberProperty(PAGE_INDEX_PROPERTY, "Page index (1-based, default: 1)")
		.addNumberProperty(PAGE_SIZE_PROPERTY, "Page size (default: 100, max: 500)")

-    var minCoverage = arguments.getOptionalInteger(MIN_COVERAGE_PROPERTY);
-    var maxCoverage = arguments.getOptionalInteger(MAX_COVERAGE_PROPERTY);
-    var pageIndex = arguments.getOptionalInteger(PAGE_INDEX_PROPERTY);
-    var pageSize = arguments.getOptionalInteger(PAGE_SIZE_PROPERTY);
+    Number minCoverageNumber = arguments.getOptionalNumber(MIN_COVERAGE_PROPERTY);
+    Integer minCoverage = null;
+    if (minCoverageNumber != null) {
+      if (minCoverageNumber.doubleValue() % 1 != 0) {
+        return Tool.Result.failure("minCoverage must be an integer value");
+      }
+      minCoverage = minCoverageNumber.intValue();
+    }
+    Number maxCoverageNumber = arguments.getOptionalNumber(MAX_COVERAGE_PROPERTY);
+    Integer maxCoverage = null;
+    if (maxCoverageNumber != null) {
+      if (maxCoverageNumber.doubleValue() % 1 != 0) {
+        return Tool.Result.failure("maxCoverage must be an integer value");
+      }
+      maxCoverage = maxCoverageNumber.intValue();
+    }
+    Number pageIndexNumber = arguments.getOptionalNumber(PAGE_INDEX_PROPERTY);
+    Integer pageIndex = null;
+    if (pageIndexNumber != null) {
+      if (pageIndexNumber.doubleValue() % 1 != 0) {
+        return Tool.Result.failure("pageIndex must be an integer value");
+      }
+      pageIndex = pageIndexNumber.intValue();
+    }
+    Number pageSizeNumber = arguments.getOptionalNumber(PAGE_SIZE_PROPERTY);
+    Integer pageSize = null;
+    if (pageSizeNumber != null) {
+      if (pageSizeNumber.doubleValue() % 1 != 0) {
+        return Tool.Result.failure("pageSize must be an integer value");
+      }
+      pageSize = pageSizeNumber.intValue();
+    }

	@JsonPropertyDescription("Total number of lines in the file") int totalLines,
	@JsonPropertyDescription("Total number of lines returned in this response or range") int totalLines,

	import jakarta.annotation.Nullable;
	import javax.annotation.Nullable;

MCP-276 Provide line-by-line coverage via a tool #193

Are you sure you want to change the base?

MCP-276 Provide line-by-line coverage via a tool #193

Conversation

nquinquenel commented Feb 5, 2026

Uh oh!

hashicorp-vault-sonar-prod bot commented Feb 5, 2026 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nquinquenel commented Feb 6, 2026

Uh oh!

Copilot AI commented Feb 6, 2026

Uh oh!

sonarqubecloud bot commented Feb 6, 2026

SonarQube reviewer guide

Quality Gate passed

Uh oh!

eray-felek-sonarsource left a comment

Choose a reason for hiding this comment

Uh oh!

eray-felek-sonarsource Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hashicorp-vault-sonar-prod bot commented Feb 5, 2026 •

edited by atlassian bot

Loading

eray-felek-sonarsource Feb 12, 2026 •

edited

Loading