Support persisting MCP tools in system index #3874

zane-neo · 2025-05-26T08:31:09Z

Description

Support persisting MCP tools in system index in register API and adding new API, below are the new APIs specification:
Update MCP tools

POST /_plugins/_ml/mcp/tools/_update
{
  "type": "PPLTool",
  "name": "My_TransferQuestionToPPLAndExecuteTool", //name is mandatory.
  "description": "Use this tool to convert natural language into PPL queries and execute them. Use this tool after you know the index name; otherwise, call IndexRoutingTool first. The input parameters are: {index: IndexName, question: UserQuestion}",
  "parameters": {
    "model_id": "${new_model_id}",
    "model_type": "FINETUNE"
  },
  "attributes": {
    "input_schema": {
      "type": "object",
      "properties": {
        "question": {
          "type": "string",
          "description": "The user's natural language question that needs to be converted to PPL."
        },
        "index": {
          "type": "string",
          "description": "The index on which the generated PPL query will be executed."
        }
      }
    }
  }
}

Sample response

{
    "3OVC3xeVSzmd60pbnlEeRw": {
        "updated": true
    }
}

List MCP tools

GET /_plugins/_ml/mcp/tools/_list

Sample response

{
    "tools": [
        {
            "type": "ListIndexTool",
            "name": "MyListIndexTool1",
            "description": "This is my first list index tool",
            "attributes": {
                "input_schema": {
                    "additionalProperties": false,
                    "type": "object",
                    "properties": {
                        "indices": {
                            "description": "A comma-separated list of OpenSearch index names. For example: [\"index1\", \"index2\"]. Use [] (an empty array) to list all indices in the cluster.",
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                }
            },
            "create_time": 1748421099398
        }
    ]
}

Related Issues

#3841

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

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

rithin-pullela-aws · 2025-05-28T23:59:44Z

...ain/java/org/opensearch/ml/common/transport/mcpserver/requests/register/RegisterMcpTool.java

+import lombok.extern.log4j.Log4j2;
+
+/**
+ *  This class represents a tool that can be registered with OpenSearch. It contains information about the tool's name,


I think we can make it clear by mentioning openSearch MCP Server.

Also can we use a better name for RegisterMcpTool. This sounds like an action(function) rather than a class's name

Renamed to McpToolRegsiterInput for this and McpToolUpdateInput for UpdateMcpTool.

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

rithin-pullela-aws · 2025-05-29T00:12:06Z

...ain/java/org/opensearch/ml/common/transport/mcpserver/requests/register/RegisterMcpTool.java

+        Instant lastUpdateTime
+    ) {
+        super(name, type, description, parameters, attributes, createdTime, lastUpdateTime);
+        if (type == null) {


Should we check for type first and then call the super method?

super invocation should be in the first line of a constructor which is a java syntax limitation.

rithin-pullela-aws · 2025-05-29T00:16:29Z

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

-    private static final String TYPE_NOT_SHOWN_EXCEPTION_MESSAGE = "type field required";
+    private Instant createdTime;
+    private Instant lastUpdatedTime;
+    public static final String TYPE_NOT_SHOWN_EXCEPTION_MESSAGE = "type field required";


Should we move this variable to the RegisterBaseTool file if we are not using it here?

rithin-pullela-aws · 2025-05-29T00:17:59Z

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

+    private Instant createdTime;
+    private Instant lastUpdatedTime;
+    public static final String TYPE_NOT_SHOWN_EXCEPTION_MESSAGE = "type field required";
+    public static final String NAME_NOT_SHOWN_EXCEPTION_MESSAGE = "name field required";


Same as above, can we move to the update file?

rithin-pullela-aws · 2025-05-29T00:21:41Z

...rc/main/java/org/opensearch/ml/common/transport/mcpserver/requests/update/UpdateMcpTool.java

@@ -0,0 +1,74 @@
+package org.opensearch.ml.common.transport.mcpserver.requests.update;


Add the license header?

rithin-pullela-aws · 2025-05-29T00:26:25Z

...java/org/opensearch/ml/common/transport/mcpserver/responses/list/MLMcpToolsListResponse.java

@@ -0,0 +1,45 @@
+package org.opensearch.ml.common.transport.mcpserver.responses.list;


Add license header?

dhrubo-os · 2025-05-29T23:00:39Z

...rc/main/java/org/opensearch/ml/common/transport/mcpserver/action/MLMcpToolsRemoveAction.java

+import org.opensearch.action.ActionType;
+import org.opensearch.ml.common.transport.mcpserver.responses.remove.MLMcpToolsRemoveNodesResponse;
+
+public class MLMcpToolsRemoveAction extends ActionType<MLMcpToolsRemoveNodesResponse> {


Is that delete? Can we be consistent with other apis as well?

Do you mean to rename the class or rename the API? In first release we named the API like below:

POST /_plugins/_ml/mcp/tools/_remove [ "WebSearchTool", "ListIndexTool" ]

Signed-off-by: zane-neo <[email protected]>

zane-neo requested review from b4sjoo, dhrubo-os, mingshl, jngz-es, model-collapse, rbhavna, ylwu-amzn, Zhangxunmt, austintlee, HenryL27 and xinyual as code owners May 26, 2025 08:31

zane-neo force-pushed the persist-mcp-tools branch 2 times, most recently from d50ddf6 to e7e8369 Compare May 26, 2025 08:39

dhrubo-os had a problem deploying to ml-commons-cicd-env May 28, 2025 14:02 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env May 28, 2025 14:02 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env May 28, 2025 14:02 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env May 28, 2025 14:02 — with GitHub Actions Failure

ylwu-amzn reviewed May 28, 2025

View reviewed changes

...n/src/main/java/org/opensearch/ml/common/transport/mcpserver/requests/register/McpTools.java Show resolved Hide resolved

rithin-pullela-aws reviewed May 29, 2025

View reviewed changes

zane-neo force-pushed the persist-mcp-tools branch from a60f924 to 1f6f359 Compare May 29, 2025 06:20

zane-neo had a problem deploying to ml-commons-cicd-env May 29, 2025 06:21 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env May 29, 2025 06:21 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env May 29, 2025 06:21 — with GitHub Actions Error

dhrubo-os reviewed May 29, 2025

View reviewed changes

zane-neo added 4 commits June 3, 2025 11:00

Support MCP tools configuration persistence

15c10e7

Signed-off-by: zane-neo <[email protected]>

Support persisting mcp tools configuration in system index

38c0da5

Signed-off-by: zane-neo <[email protected]>

format code

1429c2c

Signed-off-by: zane-neo <[email protected]>

Address comments

606a7c1

Signed-off-by: zane-neo <[email protected]>

zane-neo force-pushed the persist-mcp-tools branch from 1f6f359 to 606a7c1 Compare June 3, 2025 03:01

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 03:02 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 03:02 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 06:23 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 06:23 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 06:23 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 06:23 — with GitHub Actions Error

add ignore code coverage

4e27d95

Signed-off-by: zane-neo <[email protected]>

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 08:36 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env June 3, 2025 08:36 — with GitHub Actions Error

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Support persisting MCP tools in system index #3874

Support persisting MCP tools in system index #3874

Uh oh!

zane-neo commented May 26, 2025 •

edited

Loading

Uh oh!

Uh oh!

rithin-pullela-aws May 28, 2025

Uh oh!

zane-neo May 29, 2025

Uh oh!

Uh oh!

rithin-pullela-aws May 29, 2025

Uh oh!

zane-neo May 29, 2025

Uh oh!

rithin-pullela-aws May 29, 2025

Uh oh!

zane-neo May 29, 2025

Uh oh!

rithin-pullela-aws May 29, 2025

Uh oh!

zane-neo May 29, 2025

Uh oh!

rithin-pullela-aws May 29, 2025

Uh oh!

zane-neo May 29, 2025

Uh oh!

rithin-pullela-aws May 29, 2025

Uh oh!

zane-neo May 29, 2025

Uh oh!

dhrubo-os May 29, 2025

Uh oh!

zane-neo May 30, 2025

Uh oh!

Uh oh!

		@@ -0,0 +1,74 @@
		package org.opensearch.ml.common.transport.mcpserver.requests.update;

		@@ -0,0 +1,45 @@
		package org.opensearch.ml.common.transport.mcpserver.responses.list;

Support persisting MCP tools in system index #3874

Are you sure you want to change the base?

Support persisting MCP tools in system index #3874

Uh oh!

Conversation

zane-neo commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zane-neo commented May 26, 2025 •

edited

Loading