Dev MCP: Set default enable for some methods. Update documentation

Signed-off-by: Phillip Kruger <[email protected]>

Author: phillip-kruger

docs/src/main/asciidoc/dev-mcp.adoc

@@ -52,7 +52,17 @@ footerPageBuildItem.addBuildTimeData(
 );
 ----
 
-The extra `description` argument is new: without it the data only appears in the Dev UI. Once supplied, the `jokes` data becomes an MCP resource.
+The extra `description` argument is new: without it the data only appears in the Dev UI. Once supplied, the `jokes` data becomes an MCP resource, however, by default this resource will be disabled. You can change the default by passing in `true` as another parameter after description, that will change this default to be enabled. Users can change this in Dev UI anyway, so this is just a sensible default.
+
+[source,java]
+----
+footerPageBuildItem.addBuildTimeData(
+    "jokes",
+    jokesBuildItem.getJokes(),
+    "Some funny jokes that the user might enjoy",
+    true
+);
+----
 
 ==== MCP Resources against a recorded value
 
@@ -76,6 +86,8 @@ BuildTimeActionBuildItem createBuildTimeActions() {
 <3> Set a human‑readable description.
 <4> Provide the runtime value returned by your recorder.
 
+By default this resource will be disabled, and the user has to enable it in Dev UI. You can change this default by adding `.enableMcpFuctionByDefault()` in the builder method.
+
 === MCP tools
 
 A tool corresponds to a method that a client can call. Any JSON‑RPC method can be exposed as a tool by supplying descriptions on the method and its parameters.
@@ -100,6 +112,8 @@ public class MyExtensionRPCService {
 <1> Description of the method.
 <2> Description of each parameter.
 
+By default this tool will be disabled, and the user has to enable it in Dev UI. You can change this default by adding the `@DevMCPEnableByDefault` annotation on the method.
+
 You must register the JSON‑RPC service in the deployment module:
 
 [source,java]
@@ -145,6 +159,8 @@ BuildTimeActionBuildItem createBuildTimeActions() {
 
 The code in the `function` runs on the deployment classpath. The function can return a plain value, a `CompletionStage` or `CompletableFuture` for asynchronous work.
 
+By default this tool will be disabled, and the user has to enable it in Dev UI. You can change this default by adding `.enableMcpFuctionByDefault()` in the builder method.
+
 === JSON‑RPC usage
 
 By default all JSON‑RPC methods are visible in the Dev UI. Only methods with descriptions are exposed via Dev MCP. 

extensions/agroal/runtime-dev/src/main/java/io/quarkus/agroal/runtime/dev/ui/DatabaseInspector.java

@@ -40,6 +40,7 @@
 import io.quarkus.assistant.runtime.dev.Assistant;
 import io.quarkus.datasource.common.runtime.DataSourceUtil;
 import io.quarkus.runtime.LaunchMode;
+import io.quarkus.runtime.annotations.DevMCPEnableByDefault;
 import io.quarkus.runtime.annotations.JsonRpcDescription;
 
 public final class DatabaseInspector {
@@ -96,6 +97,7 @@ protected void init() {
     }
 
     @JsonRpcDescription("Get all available datasources for the Database")
+    @DevMCPEnableByDefault
     public List<Datasource> getDataSources() {
         if (isDev) {
             List<Datasource> datasources = new ArrayList<>();
@@ -110,6 +112,7 @@ public List<Datasource> getDataSources() {
     }
 
     @JsonRpcDescription("Get a spesific datasource for the Database by name")
+    @DevMCPEnableByDefault
     private Datasource getDatasource(@JsonRpcDescription("Datasource name") String datasource) {
         if (isDev) {
             AgroalDataSource ads = checkedDataSources.get(datasource);
@@ -126,6 +129,7 @@ private Datasource getDatasource(@JsonRpcDescription("Datasource name") String d
     }
 
     @JsonRpcDescription("Get all the tables for a certain datasource")
+    @DevMCPEnableByDefault
     public List<Table> getTables(@JsonRpcDescription("Datasource name") String datasource) {
         if (isDev) {
             List<Table> tableList = new ArrayList<>();
@@ -238,6 +242,7 @@ public String generateDot(@JsonRpcDescription("Datasource name") String datasour
     }
 
     @JsonRpcDescription("Execute SQL against a certain datasource")
+    @DevMCPEnableByDefault
     public DataSet executeSQL(@JsonRpcDescription("Datasource name") String datasource,
             @JsonRpcDescription("Valid SQL to execute") String sql,
             @JsonRpcDescription("Page number for pagable rusults, starting at 1") Integer pageNumber,

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/BuildTimeConstBuildItem.java

@@ -32,11 +32,11 @@ public BuildTimeConstBuildItem(String customIdentifier, Map<String, BuildTimeDat
     }
 
     public void addBuildTimeData(String fieldName, Object fieldData) {
-        this.addBuildTimeData(fieldName, fieldData, null);
+        this.addBuildTimeData(fieldName, fieldData, null, false);
     }
 
-    public void addBuildTimeData(String fieldName, Object fieldData, String description) {
-        this.buildTimeData.put(fieldName, new BuildTimeData(fieldData, description));
+    public void addBuildTimeData(String fieldName, Object fieldData, String description, boolean mcpEnabledAsDefault) {
+        this.buildTimeData.put(fieldName, new BuildTimeData(fieldData, description, mcpEnabledAsDefault));
     }
 
     public void addAllBuildTimeData(Map<String, BuildTimeData> buildTimeData) {

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/BuildTimeContentProcessor.java

@@ -672,7 +672,7 @@ private void addFooterTabBuildTimeData(BuildTimeConstBuildItem internalBuildTime
         }
 
         internalBuildTimeData.addBuildTimeData("footerTabs", footerTabs);
-        internalBuildTimeData.addBuildTimeData("loggerLevels", LEVELS, "All the available logger levels");
+        internalBuildTimeData.addBuildTimeData("loggerLevels", LEVELS, "All the available logger levels", true);
     }
 
     private void addApplicationInfoBuildTimeData(BuildTimeConstBuildItem internalBuildTimeData,

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/logstream/LogStreamProcessor.java

@@ -62,6 +62,7 @@ void registerBuildTimeActions(BuildProducer<BuildTimeActionBuildItem> buildTimeA
                     RuntimeUpdatesProcessor.INSTANCE.doScan(true, true);
                     return Map.of();
                 })
+                .enableMcpFuctionByDefault()
                 .build();
 
         keyStrokeActions.actionBuilder()

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/menu/ConfigurationProcessor.java

@@ -126,6 +126,7 @@ void registerBuildTimeActions(
                     updateConfig(name, value, profile, target);
                     return true;
                 })
+                .enableMcpFuctionByDefault()
                 .build();
 
         configActions.actionBuilder()

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/menu/ContinuousTestingProcessor.java

@@ -112,6 +112,7 @@ private void registerStartMethod(LaunchModeBuildItem launchModeBuildItem, BuildT
                         throw new RuntimeException(e);
                     }
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 
@@ -137,6 +138,7 @@ private void registerStopMethod(LaunchModeBuildItem launchModeBuildItem, BuildTi
                         throw new RuntimeException(e);
                     }
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 
@@ -157,6 +159,7 @@ private void registerRunAllMethod(LaunchModeBuildItem launchModeBuildItem, Build
                         throw new RuntimeException(e);
                     }
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 
@@ -258,6 +261,7 @@ private void registerGetStatusMethod(LaunchModeBuildItem launchModeBuildItem, Bu
                         throw new RuntimeException(e);
                     }
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/menu/DevServicesProcessor.java

@@ -89,6 +89,7 @@ private void getDevServices(BuildTimeActionBuildItem buildTimeActions,
                 .function(ignored -> CompletableFuture.supplyAsync(() -> getServices(devServiceDescriptions, otherDevServices)))
                 .description(
                         "Get all the DevServices started by this Quarkus app, including information on container (if any) and the config that is being set automatically")
+                .enableMcpFuctionByDefault()
                 .build();
     }
 

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/menu/ExtensionsProcessor.java

@@ -46,7 +46,8 @@ InternalPageBuildItem createExtensionsPages(ExtensionsBuildItem extensionsBuildI
 
         extensionsPages.addBuildTimeData("extensions", response, "All the extensions added to this Quarkus application. "
                 + "Some extensions are 'active' meaning they have actions in Dev UI, and some are 'inactive', meaning they will be listed in Dev UI, but a user can not perform any actions."
-                + "For both active and inactive all sorts of information is available about the extension, like it's name, URL to the guide, GAV and much more");
+                + "For both active and inactive all sorts of information is available about the extension, like it's name, URL to the guide, GAV and much more",
+                true, null);
 
         // Page
         extensionsPages.addPage(Page.webComponentPageBuilder()
@@ -127,6 +128,7 @@ private void getInstallableExtensions(BuildTimeActionBuildItem buildTimeActions)
                         }
                     });
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 
@@ -197,6 +199,7 @@ private void removeExtension(BuildTimeActionBuildItem buildTimeActions) {
                         }
                     });
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 
@@ -222,6 +225,7 @@ private void addExtension(BuildTimeActionBuildItem buildTimeActions) {
                         }
                     });
                 })
+                .enableMcpFuctionByDefault()
                 .build();
     }
 

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/menu/WorkspaceProcessor.java

@@ -175,6 +175,7 @@ void createBuildTimeActions(Optional<WorkspaceBuildItem> workspaceBuildItem,
                     .function((t) -> {
                         return workspaceBuildItem.get().getWorkspaceItems();
                     })
+                    .enableMcpFuctionByDefault()
                     .build();
 
             buildItemActions.actionBuilder()
@@ -236,6 +237,7 @@ void createBuildTimeActions(Optional<WorkspaceBuildItem> workspaceBuildItem,
                         }
                         return null;
                     })
+                    .enableMcpFuctionByDefault()
                     .build();
 
             buildItemActions.actionBuilder()
@@ -254,6 +256,7 @@ void createBuildTimeActions(Optional<WorkspaceBuildItem> workspaceBuildItem,
                         }
                         return new SavedResult(null, false, "Invalid input");
                     })
+                    .enableMcpFuctionByDefault()
                     .build();
 
             buildTimeActionProducer.produce(buildItemActions);