initial commit for MCP server in OpenSearch

common/src/main/java/org/opensearch/ml/common/transport/mcpserver/action/MLMcpToolsRegisterOnNodesAction.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.common.transport.mcpserver.action;
+
+import org.opensearch.action.ActionType;
+import org.opensearch.ml.common.transport.mcpserver.responses.register.MLMcpRegisterNodesResponse;
+
+public class MLMcpToolsRegisterOnNodesAction extends ActionType<MLMcpRegisterNodesResponse> {
+    public static MLMcpToolsRegisterOnNodesAction INSTANCE = new MLMcpToolsRegisterOnNodesAction();
+    public static final String NAME = "cluster:admin/opensearch/ml/mcp_tools/register_on_nodes";
+
+    private MLMcpToolsRegisterOnNodesAction() {
+        super(NAME, MLMcpRegisterNodesResponse::new);
+    }
+
+}

common/src/main/java/org/opensearch/ml/common/transport/mcpserver/action/MLMcpToolsRemoveOnNodesAction.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.common.transport.mcpserver.action;
+
+import org.opensearch.action.ActionType;
+import org.opensearch.ml.common.transport.mcpserver.responses.remove.MLMcpRemoveNodesResponse;
+
+public class MLMcpToolsRemoveOnNodesAction extends ActionType<MLMcpRemoveNodesResponse> {
+    public static MLMcpToolsRemoveOnNodesAction INSTANCE = new MLMcpToolsRemoveOnNodesAction();
+    public static final String NAME = "cluster:admin/opensearch/ml/mcp_tools/remove_on_nodes";
+
+    private MLMcpToolsRemoveOnNodesAction() {
+        super(NAME, MLMcpRemoveNodesResponse::new);
+    }
+
+}

common/src/main/java/org/opensearch/ml/common/transport/mcpserver/requests/register/MLMcpToolsRegisterNodeRequest.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.common.transport.mcpserver.requests.register;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+
+import org.opensearch.action.ActionRequest;
+import org.opensearch.action.ActionRequestValidationException;
+import org.opensearch.core.common.io.stream.InputStreamStreamInput;
+import org.opensearch.core.common.io.stream.OutputStreamStreamOutput;
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
+import org.opensearch.transport.TransportRequest;
+
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+public class MLMcpToolsRegisterNodeRequest extends ActionRequest {
+    private McpTools mcpTools;
+
+    public MLMcpToolsRegisterNodeRequest(StreamInput in) throws IOException {
+        super(in);
+        this.mcpTools = new McpTools(in);
+    }
+
+    @Override
+    public ActionRequestValidationException validate() {
+        return null;
+    }
+
+    @Builder
+    public MLMcpToolsRegisterNodeRequest(McpTools mcpTools) {
+        this.mcpTools = mcpTools;
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        mcpTools.writeTo(out);
+    }
+
+    public static MLMcpToolsRegisterNodeRequest fromActionRequest(TransportRequest actionRequest) {
+        if (actionRequest instanceof MLMcpToolsRegisterNodeRequest) {
+            return (MLMcpToolsRegisterNodeRequest) actionRequest;
+        }
+
+        try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); OutputStreamStreamOutput osso = new OutputStreamStreamOutput(baos)) {
+            actionRequest.writeTo(osso);
+            try (StreamInput input = new InputStreamStreamInput(new ByteArrayInputStream(baos.toByteArray()))) {
+                return new MLMcpToolsRegisterNodeRequest(input);
+            }
+        } catch (IOException e) {
+            throw new UncheckedIOException("Failed to parse ActionRequest into MLMcpToolsRegisterNodeRequest", e);
+        }
+    }
+
+}

common/src/main/java/org/opensearch/ml/common/transport/mcpserver/requests/register/MLMcpToolsRegisterNodesRequest.java

@@ -0,0 +1,62 @@
+package org.opensearch.ml.common.transport.mcpserver.requests.register;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+
+import org.opensearch.action.ActionRequest;
+import org.opensearch.action.ActionRequestValidationException;
+import org.opensearch.action.support.nodes.BaseNodesRequest;
+import org.opensearch.core.common.io.stream.InputStreamStreamInput;
+import org.opensearch.core.common.io.stream.OutputStreamStreamOutput;
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
+import org.opensearch.core.common.util.CollectionUtils;
+
+import lombok.Data;
+
+@Data
+public class MLMcpToolsRegisterNodesRequest extends BaseNodesRequest<MLMcpToolsRegisterNodesRequest> {
+    private McpTools mcpTools;
+
+    public MLMcpToolsRegisterNodesRequest(StreamInput in) throws IOException {
+        super(in);
+        this.mcpTools = new McpTools(in);
+    }
+
+    public MLMcpToolsRegisterNodesRequest(String[] nodeIds, McpTools mcpTools) {
+        super(nodeIds);
+        this.mcpTools = mcpTools;
+    }
+
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        mcpTools.writeTo(out);
+    }
+
+    @Override
+    public ActionRequestValidationException validate() {
+        if (CollectionUtils.isEmpty(mcpTools.getTools())) {
+            ActionRequestValidationException exception = new ActionRequestValidationException();
+            exception.addValidationError("tools list can not be null");
+            return exception;
+        }
+        return null;
+    }
+
+    public static MLMcpToolsRegisterNodesRequest fromActionRequest(ActionRequest actionRequest) {
+        if (actionRequest instanceof MLMcpToolsRegisterNodesRequest) {
+            return (MLMcpToolsRegisterNodesRequest) actionRequest;
+        }
+
+        try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); OutputStreamStreamOutput osso = new OutputStreamStreamOutput(baos)) {
+            actionRequest.writeTo(osso);
+            try (StreamInput input = new InputStreamStreamInput(new ByteArrayInputStream(baos.toByteArray()))) {
+                return new MLMcpToolsRegisterNodesRequest(input);
+            }
+        } catch (IOException e) {
+            throw new UncheckedIOException("Failed to parse ActionRequest into MLMcpToolsRegisterRequest", e);
+        }
+    }
+}

common/src/main/java/org/opensearch/ml/common/transport/mcpserver/requests/register/McpTool.java

@@ -0,0 +1,136 @@
+/*
+ *
+ *  * Copyright OpenSearch Contributors
+ *  * SPDX-License-Identifier: Apache-2.0
+ *
+ */
+
+package org.opensearch.ml.common.transport.mcpserver.requests.register;
+
+import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
+
+import java.io.IOException;
+import java.util.Map;
+
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
+import org.opensearch.core.common.io.stream.Writeable;
+import org.opensearch.core.xcontent.ToXContent;
+import org.opensearch.core.xcontent.ToXContentObject;
+import org.opensearch.core.xcontent.XContentBuilder;
+import org.opensearch.core.xcontent.XContentParser;
+
+import lombok.Data;
+import lombok.extern.log4j.Log4j2;
+
+/**
+ *  This class represents a tool that can be registered with OpenSearch. It contains information about the tool's name,
+ * description, parameters, and schema.
+ */
+@Log4j2
+@Data
+public class McpTool implements ToXContentObject, Writeable {
+    private static final String NAME_FIELD = "name";
+    private static final String DESCRIPTION_FIELD = "description";
+    private static final String PARAMS_FIELD = "params";
+    private static final String SCHEMA_FIELD = "schema";
+    private final String name;
+    private final String description;
+    private Map<String, Object> params;
+    private Map<String, Object> schema;
+    private static final String nameNotShownExceptionMessage = "name field required";
+
+    public McpTool(StreamInput streamInput) throws IOException {
+        name = streamInput.readString();
+        if (name == null) {
+            throw new IllegalArgumentException(nameNotShownExceptionMessage);
+        }
+        description = streamInput.readOptionalString();
+        if (streamInput.readBoolean()) {
+            params = streamInput.readMap(StreamInput::readString, StreamInput::readGenericValue);
+        }
+        if (streamInput.readBoolean()) {
+            schema = streamInput.readMap(StreamInput::readString, StreamInput::readGenericValue);
+        }
+    }
+
+    public McpTool(String name, String description, Map<String, Object> params, Map<String, Object> schema) {
+        if (name == null) {
+            throw new IllegalArgumentException(nameNotShownExceptionMessage);
+        }
+        this.name = name;
+        this.description = description;
+        this.params = params;
+        this.schema = schema;
+    }
+
+    public static McpTool parse(XContentParser parser) throws IOException {
+        String name = null;
+        String description = null;
+        Map<String, Object> params = null;
+        Map<String, Object> schema = null;
+        ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
+        while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
+            String fieldName = parser.currentName();
+            parser.nextToken();
+
+            switch (fieldName) {
+                case NAME_FIELD:
+                    name = parser.text();
+                    break;
+                case DESCRIPTION_FIELD:
+                    description = parser.text();
+                    break;
+                case PARAMS_FIELD:
+                    params = parser.map();
+                    break;
+                case SCHEMA_FIELD:
+                    schema = parser.map();
+                    break;
+                default:
+                    parser.skipChildren();
+                    break;
+            }
+        }
+        if (name == null) {
+            throw new IllegalArgumentException(nameNotShownExceptionMessage);
+        }
+        return new McpTool(name, description, params, schema);
+    }
+
+    @Override
+    public void writeTo(StreamOutput streamOutput) throws IOException {
+        streamOutput.writeString(name);
+        streamOutput.writeOptionalString(description);
+        if (params != null) {
+            streamOutput.writeBoolean(true);
+            streamOutput.writeMap(params, StreamOutput::writeString, StreamOutput::writeGenericValue);
+        } else {
+            streamOutput.writeBoolean(false);
+        }
+
+        if (schema != null) {
+            streamOutput.writeBoolean(true);
+            streamOutput.writeMap(schema, StreamOutput::writeString, StreamOutput::writeGenericValue);
+        } else {
+            streamOutput.writeBoolean(false);
+        }
+    }
+
+    @Override
+    public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params xcontentParams) throws IOException {
+        builder.startObject();
+        builder.field(NAME_FIELD, name);
+        if (description != null) {
+            builder.field(DESCRIPTION_FIELD, description);
+        }
+        if (params != null && !params.isEmpty()) {
+            builder.field(PARAMS_FIELD, params);
+        }
+        if (schema != null && !schema.isEmpty()) {
+            builder.field(SCHEMA_FIELD, schema);
+        }
+        builder.endObject();
+        return builder;
+    }
+}