Added or improved Javadoc

Author: orpiske

core/core-mcp/src/main/java/ai/wanaku/core/mcp/common/resolvers/Resolver.java

@@ -19,6 +19,10 @@
 
 import java.io.File;
 
+/**
+ * A resolver that consumes MCP requests and resolves what type of tool or resource acquirer
+ * should handle it
+ */
 public interface Resolver {
     String DEFAULT_RESOURCES_INDEX_FILE_NAME = "resources.json";
     String DEFAULT_TOOLS_INDEX_FILE_NAME = "tools.json";

core/core-mcp/src/main/java/ai/wanaku/core/mcp/common/resolvers/ResourceResolver.java

@@ -25,6 +25,10 @@
 import ai.wanaku.api.types.ResourceReference;
 import io.quarkiverse.mcp.server.ResourceManager;
 
+/**
+ * A resolver that consumes MCP requests and resolves what type of resource acquirer
+ * should handle it
+ */
 public interface ResourceResolver extends Resolver {
 
 

core/core-mcp/src/main/java/ai/wanaku/core/mcp/common/resolvers/ToolsResolver.java

@@ -24,6 +24,10 @@
 import ai.wanaku.api.types.ToolReference;
 import ai.wanaku.core.mcp.common.Tool;
 
+/**
+ * A resolver that consumes MCP requests and resolves what type of tool
+ * should handle it
+ */
 public interface ToolsResolver extends Resolver {
 
     /**

core/core-services/src/main/java/ai/wanaku/core/services/config/WanakuProviderConfig.java

@@ -3,6 +3,9 @@
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
 
+/**
+ * Configuration class for providers
+ */
 @ConfigMapping(prefix = "wanaku.service.provider")
 public interface WanakuProviderConfig extends WanakuServiceConfig {
 

core/core-services/src/main/java/ai/wanaku/core/services/config/WanakuRoutingConfig.java

@@ -3,6 +3,9 @@
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
 
+/**
+ * Configuration class for tool services
+ */
 @ConfigMapping(prefix = "wanaku.service.routing")
 public interface WanakuRoutingConfig extends WanakuServiceConfig {
 

core/core-services/src/main/java/ai/wanaku/core/services/config/WanakuServiceConfig.java

@@ -5,6 +5,9 @@
 import ai.wanaku.core.config.WanakuConfig;
 import io.smallrye.config.ConfigMapping;
 
+/**
+ * Base configuration class for the downstream services
+ */
 @ConfigMapping(prefix = "wanaku.service")
 public interface WanakuServiceConfig extends WanakuConfig {
 

core/core-services/src/main/java/ai/wanaku/core/services/provider/AbstractResourceDelegate.java

@@ -36,7 +36,7 @@ public abstract class AbstractResourceDelegate implements ResourceAcquirerDelega
      * The parameters are already merged w/ the requested ones, but feel free to override or
      * add more if necessary.
      * @param request the request
-     * @param parameters the merged (between config and defauts) request parameters
+     * @param parameters the merged (between config and defaults) request parameters
      * @return the URI as a string
      */
     protected abstract String getEndpointUri(ResourceRequest request, Map<String, String> parameters);
@@ -45,7 +45,8 @@ public abstract class AbstractResourceDelegate implements ResourceAcquirerDelega
      * Convert the response in whatever format it is to a String
      * @param response the response
      * @return the response as a String
-     * @throws InvalidResponseTypeException if the response cannot be converted
+     * @throws InvalidResponseTypeException if the response type is invalid (such as null)
+     * @throws NonConvertableResponseException if the response cannot be converted
      */
     protected abstract String coerceResponse(Object response)
             throws InvalidResponseTypeException, NonConvertableResponseException;

core/core-services/src/main/java/ai/wanaku/core/services/provider/DefaultResourceConsumer.java

@@ -5,6 +5,9 @@
 import org.apache.camel.CamelContext;
 import org.apache.camel.ConsumerTemplate;
 
+/**
+ * A simple consumer of resources implemented on top of Camel's ConsumerTemplate
+ */
 @ApplicationScoped
 public class DefaultResourceConsumer implements ResourceConsumer {
     private final ConsumerTemplate consumer;

core/core-services/src/main/java/ai/wanaku/core/services/provider/ResourceConsumer.java

@@ -1,5 +1,13 @@
 package ai.wanaku.core.services.provider;
 
+/**
+ * Consumes a resource from a service providing it
+ */
 public interface ResourceConsumer {
+    /**
+     * Consume the resource
+     * @param uri The URI pointing to the service to consume
+     * @return Whatever response was obtained by calling the server (it must be convertible to a String)
+     */
     Object consume(String uri);
 }

core/core-services/src/main/java/ai/wanaku/core/services/routing/Client.java

@@ -3,6 +3,15 @@
 import ai.wanaku.api.exceptions.WanakuException;
 import ai.wanaku.core.exchange.ToolInvokeRequest;
 
+/**
+ * A client is responsible for exchanging data with a service
+ */
 public interface Client {
+    /**
+     * Exchange data with a service
+     * @param request The tool invocation request as received by the MCP router
+     * @return Whatever response was obtained by calling the server (it must be convertible to a String)
+     * @throws WanakuException if the operation cannot be executed
+     */
     Object exchange(ToolInvokeRequest request) throws WanakuException;
 }

core/core-services/src/main/java/ai/wanaku/core/services/util/URIHelper.java

@@ -2,6 +2,9 @@
 
 import java.util.Map;
 
+/**
+ * Utility class to build URIs
+ */
 public class URIHelper {
 
     private static String buildFromBaseUri(Map<String, String> parameters, StringBuilder uri) {

core/core-util/src/main/java/ai/wanaku/core/config/WanakuConfig.java

@@ -2,6 +2,9 @@
 
 import io.smallrye.config.ConfigMapping;
 
+/**
+ * Base configuration class
+ */
 @ConfigMapping(prefix = "wanaku")
 public interface WanakuConfig {
 }

routers/wanaku-router/src/main/java/ai/wanaku/routers/AbstractProvider.java

@@ -24,6 +24,10 @@
 import ai.wanaku.core.mcp.common.resolvers.Resolver;
 import ai.wanaku.core.util.IndexHelper;
 
+/**
+ * Base provider class for tools and resources
+ * @param <Y> The type of the resolver
+ */
 abstract class AbstractProvider<Y extends Resolver> {
     private static File createSettingsDirectory(String settingsDirectory) {
         File resourcesDir = new File(settingsDirectory);
@@ -34,6 +38,12 @@ private static File createSettingsDirectory(String settingsDirectory) {
         return resourcesDir;
     }
 
+    /**
+     * Initializes the persisted index of resources
+     * @param resourcesPath the path to the index file
+     * @param fileName the name of the index file
+     * @return the File object representing the initialized index of resources
+     */
     protected File initializeResourcesIndex(String resourcesPath, String fileName) {
         File settingsDirectory = createSettingsDirectory(resourcesPath);
         File indexFile = new File(settingsDirectory, fileName);
@@ -47,7 +57,15 @@ protected File initializeResourcesIndex(String resourcesPath, String fileName) {
         return indexFile;
     }
 
+    /**
+     * Initializes the persisted index of resources
+     * @return the File object representing the initialized index of resources
+     */
     abstract File initializeIndex();
 
+    /**
+     * Gets the resolver associated with this provider
+     * @return the resolver instance
+     */
     abstract Y getResolver();
 }

routers/wanaku-router/src/main/java/ai/wanaku/routers/ResourcesProvider.java

@@ -30,6 +30,9 @@
 
 import static ai.wanaku.core.mcp.common.resolvers.Resolver.DEFAULT_RESOURCES_INDEX_FILE_NAME;
 
+/**
+ * A provider for resources resolvers
+ */
 @ApplicationScoped
 public class ResourcesProvider extends AbstractProvider<ResourceResolver> {
     @Inject

routers/wanaku-router/src/main/java/ai/wanaku/routers/ToolsProvider.java

@@ -35,6 +35,9 @@
 
 import static ai.wanaku.core.mcp.common.resolvers.Resolver.DEFAULT_TOOLS_INDEX_FILE_NAME;
 
+/**
+ * A provider for tools resolvers
+ */
 @ApplicationScoped
 public class ToolsProvider extends AbstractProvider<ToolsResolver> {
     private static final Logger LOG = Logger.getLogger(ToolsProvider.class);

routers/wanaku-router/src/main/java/ai/wanaku/routers/WanakuRouterMain.java

@@ -24,6 +24,9 @@
 import io.quarkus.runtime.annotations.QuarkusMain;
 import picocli.CommandLine;
 
+/**
+ * Main class for the router
+ */
 @QuarkusMain(name = "base")
 @CommandLine.Command(name = "camel", mixinStandardHelpOptions = true)
 public class WanakuRouterMain implements Runnable, QuarkusApplication {

routers/wanaku-router/src/main/java/ai/wanaku/routers/config/WanakuRouterConfig.java

@@ -4,6 +4,9 @@
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
 
+/**
+ * Base configuration class for the router
+ */
 @ConfigMapping(prefix = "wanaku.router")
 public interface WanakuRouterConfig extends WanakuConfig {
 

routers/wanaku-router/src/main/java/ai/wanaku/routers/proxies/Proxy.java

@@ -25,7 +25,7 @@
 public interface Proxy {
     /**
      * The name of the proxy
-     * @return
+     * @return the name of the proxy
      */
     String name();
 

routers/wanaku-router/src/main/java/ai/wanaku/routers/proxies/resources/ResourceAcquirerProxy.java

@@ -37,6 +37,9 @@
 import io.quarkiverse.mcp.server.TextResourceContents;
 import org.jboss.logging.Logger;
 
+/**
+ * A proxy class for acquiring resources
+ */
 public class ResourceAcquirerProxy implements ResourceProxy {
     private static final Logger LOG = Logger.getLogger(ResourceAcquirerProxy.class);
 

routers/wanaku-router/src/main/java/ai/wanaku/routers/proxies/tools/InvokerProxy.java

@@ -37,6 +37,9 @@
 import io.quarkiverse.mcp.server.ToolResponse;
 import org.jboss.logging.Logger;
 
+/**
+ * A proxy class for invoking tools
+ */
 public class InvokerProxy implements ToolsProxy {
     private static final Logger LOG = Logger.getLogger(InvokerProxy.class);
 

routers/wanaku-router/src/main/java/ai/wanaku/routers/resolvers/WanakuResourceResolver.java

@@ -28,6 +28,9 @@
 import ai.wanaku.core.mcp.common.resolvers.ResourceResolver;
 import ai.wanaku.routers.proxies.ResourceProxy;
 
+/**
+ * Represents resolvers for Wanaku resources
+ */
 public class WanakuResourceResolver implements ResourceResolver {
     private static final Logger LOG = Logger.getLogger(WanakuResourceResolver.class);
     private final File indexFile;