MCP-193 Support tool annotations (#133)

Author: nquinquenel

src/main/java/org/sonarsource/sonarqube/mcp/tools/SchemaToolBuilder.java

@@ -34,6 +34,7 @@ public class SchemaToolBuilder {
   private String name;
   private String title;
   private String description;
+  private boolean isReadOnly;
 
   public SchemaToolBuilder(Map<String, Object> outputSchemaFromClass) {
     this.properties = new HashMap<>();
@@ -106,6 +107,14 @@ public SchemaToolBuilder addRequiredEnumProperty(String propertyName, String[] i
     return this;
   }
 
+  /**
+   * Marks this tool as read-only, indicating it only reads data and doesn't modify any state.
+   */
+  public SchemaToolBuilder setReadOnlyHint() {
+    this.isReadOnly = true;
+    return this;
+  }
+
   public McpSchema.Tool build() {
     if (name == null || description == null) {
       throw new IllegalStateException("Name and description must be set before building the tool.");
@@ -115,8 +124,18 @@ public McpSchema.Tool build() {
       throw new IllegalStateException("Cannot set a required property that does not exist.");
     }
 
-    var jsonSchema = new McpSchema.JsonSchema("object", properties, requiredProperties, false, Collections.emptyMap(), Collections.emptyMap());
-
-    return new McpSchema.Tool(name, title, description, jsonSchema, outputSchemaFromClass, null, Map.of());
+    var jsonSchema = new McpSchema.JsonSchema("object", properties, requiredProperties, false, Collections.emptyMap(),
+      Collections.emptyMap());
+
+    var toolAnnotations = new McpSchema.ToolAnnotations(
+      null,
+      isReadOnly,
+      false,
+      false,
+      true,
+      null
+    );
+    
+    return new McpSchema.Tool(name, title, description, jsonSchema, outputSchemaFromClass, toolAnnotations, null);
   }
 }

src/main/java/org/sonarsource/sonarqube/mcp/tools/analysis/AnalysisTool.java

@@ -58,6 +58,7 @@ public AnalysisTool(BackendService backendService, ServerApiProvider serverApiPr
       .addRequiredStringProperty(PROJECT_KEY_PROPERTY, "The SonarQube project key")
       .addRequiredStringProperty(SNIPPET_PROPERTY, "Code snippet or full file content")
       .addStringProperty(LANGUAGE_PROPERTY, "Language of the code snippet")
+      .setReadOnlyHint()
       .build());
     this.backendService = backendService;
     this.serverApiProvider = serverApiProvider;

src/main/java/org/sonarsource/sonarqube/mcp/tools/analysis/AnalyzeFileListTool.java

@@ -36,6 +36,7 @@ public AnalyzeFileListTool(SonarQubeIdeBridgeClient bridgeClient) {
       .setDescription("Analyze files in the current working directory using SonarQube for IDE. " +
         "This tool connects to a running SonarQube for IDE instance to perform code quality analysis on a list of files.")
       .addArrayProperty(FILE_ABSOLUTE_PATHS_PROPERTY, "string", "List of absolute file paths to analyze")
+      .setReadOnlyHint()
       .build());
     this.bridgeClient = bridgeClient;
   }

src/main/java/org/sonarsource/sonarqube/mcp/tools/dependencyrisks/SearchDependencyRisksTool.java

@@ -42,6 +42,7 @@ public SearchDependencyRisksTool(ServerApiProvider serverApiProvider, SonarQubeV
       .addRequiredStringProperty(PROJECT_KEY_PROPERTY, "The project key")
       .addStringProperty(BRANCH_KEY_PROPERTY, "The branch key")
       .addStringProperty(PULL_REQUEST_KEY_PROPERTY, "The pull request key")
+      .setReadOnlyHint()
       .build());
     this.serverApiProvider = serverApiProvider;
     this.sonarQubeVersionChecker = sonarQubeVersionChecker;

src/main/java/org/sonarsource/sonarqube/mcp/tools/enterprises/ListEnterprisesTool.java

@@ -41,6 +41,7 @@ private static McpSchema.Tool createToolDefinition() {
       .setDescription("List the enterprises available in SonarQube Cloud that you have access to. " +
         "Use this tool to discover enterprise IDs that can be used with other tools.")
       .addStringProperty(ENTERPRISE_KEY_PROPERTY, "Optional enterprise key to filter results")
+      .setReadOnlyHint()
       .build();
   }
 

src/main/java/org/sonarsource/sonarqube/mcp/tools/issues/SearchIssuesTool.java

@@ -42,6 +42,7 @@ public SearchIssuesTool(ServerApiProvider serverApiProvider) {
       .addArrayProperty(SEVERITIES_PROPERTY, "string", "An optional list of severities to filter by, separated by a comma. Possible values: INFO, LOW, MEDIUM, HIGH, BLOCKER")
       .addNumberProperty(PAGE_PROPERTY, "An optional page number. Defaults to 1.")
       .addNumberProperty(PAGE_SIZE_PROPERTY, "An optional page size. Must be greater than 0 and less than or equal to 500. Defaults to 100.")
+      .setReadOnlyHint()
       .build());
     this.serverApiProvider = serverApiProvider;
   }

src/main/java/org/sonarsource/sonarqube/mcp/tools/languages/ListLanguagesTool.java

@@ -34,6 +34,7 @@ public ListLanguagesTool(ServerApiProvider serverApiProvider) {
       .setTitle("List Supported Languages in SonarQube")
       .setDescription("List all programming languages supported in this SonarQube instance")
       .addStringProperty(QUERY_PROPERTY, "Optional pattern to match language keys/names against")
+      .setReadOnlyHint()
       .build());
     this.serverApiProvider = serverApiProvider;
   }

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

@@ -41,6 +41,7 @@ public GetComponentMeasuresTool(ServerApiProvider serverApiProvider) {
       .addStringProperty(BRANCH_PROPERTY, "The branch to analyze for measures")
       .addArrayProperty(METRIC_KEYS_PROPERTY, "string", "The metric keys to retrieve (e.g. ncloc, complexity, violations, coverage)")
       .addStringProperty(PULL_REQUEST_PROPERTY, "The pull request identifier to analyze for measures")
+      .setReadOnlyHint()
       .build());
     this.serverApiProvider = serverApiProvider;
   }

src/main/java/org/sonarsource/sonarqube/mcp/tools/metrics/SearchMetricsTool.java

@@ -36,6 +36,7 @@ public SearchMetricsTool(ServerApiProvider serverApiProvider) {
       .setDescription("Search for SonarQube metrics")
       .addNumberProperty(PAGE_PROPERTY, "1-based page number (default: 1)")
       .addNumberProperty(PAGE_SIZE_PROPERTY, "Page size. Must be greater than 0 and less than or equal to 500 (default: 100)")
+      .setReadOnlyHint()
       .build());
     this.serverApiProvider = serverApiProvider;
   }

src/main/java/org/sonarsource/sonarqube/mcp/tools/portfolios/ListPortfoliosTool.java

@@ -65,7 +65,9 @@ private static McpSchema.Tool createToolDefinition(boolean isSonarCloud) {
         .addNumberProperty(PAGE_SIZE_PROPERTY, "Page size, max 500 (default: 100)");
     }
 
-    return builder.build();
+    return builder
+      .setReadOnlyHint()
+      .build();
   }
 
   @Override