support customized message endpoint and addressing comments by zane-neo · Pull Request #3810 · opensearch-project/ml-commons

zane-neo · 2025-04-30T06:47:27Z

Description

support customized message endpoint and addressing comments

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

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.

Signed-off-by: zane-neo <zaniu@amazon.com>

codecov · 2025-04-30T10:11:45Z

Codecov Report

Attention: Patch coverage is 63.15789% with 14 lines in your changes missing coverage. Please review.

Project coverage is 77.98%. Comparing base (ed4f09f) to head (89d5901).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
...server/TransportMcpToolsRegisterOnNodesAction.java	55.55%	3 Missing and 1 partial ⚠️
...cpserver/requests/message/MLMcpMessageRequest.java	25.00%	1 Missing and 2 partials ⚠️
...transport/mcpserver/requests/register/McpTool.java	83.33%	2 Missing ⚠️
...cpserver/OpenSearchMcpServerTransportProvider.java	50.00%	1 Missing and 1 partial ⚠️
...l/rest/mcpserver/RestMLRegisterMcpToolsAction.java	0.00%	1 Missing and 1 partial ⚠️
...erver/RestMcpConnectionMessageStreamingAction.java	75.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3810      +/-   ##
============================================
- Coverage     78.20%   77.98%   -0.22%     
- Complexity     7162     7314     +152     
============================================
  Files           631      655      +24     
  Lines         32248    32998     +750     
  Branches       3666     3708      +42     
============================================
+ Hits          25219    25733     +514     
- Misses         5465     5677     +212     
- Partials       1564     1588      +24

Flag	Coverage Δ
ml-commons	`77.98% <63.15%> (-0.22%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: zane-neo <zaniu@amazon.com>

dhrubo-os · 2025-04-30T16:05:48Z

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

                    break;
+                case NAME_FIELD:
+                    name = parser.text();
+                    break;


let add this in the test? it should be quite easy.

dhrubo-os · 2025-04-30T16:08:07Z

plugin/build.gradle

        'org.opensearch.ml.jobs.MLBatchTaskUpdateExtension',
        'org.opensearch.ml.jobs.MLBatchTaskUpdateJobRunner',
-        'org.opensearch.ml.action.agents.TransportRegisterAgentAction'
+        'org.opensearch.ml.action.agents.TransportRegisterAgentAction',


Please create an issue about improving test coverage for these classes

Please add this issue as a todo in the code.

Thanks. We need to be mindful to increase this exclusion list more and more.

dhrubo-os · 2025-04-30T16:08:22Z

...n/src/main/java/org/opensearch/ml/action/mcpserver/OpenSearchMcpServerTransportProvider.java

+                    if (ssePrefix) {
+                        result = String.format(Locale.ROOT, "/sse/message?sessionId=%s", sessionId);
+                    } else {
+                        result = String.format(Locale.ROOT, "/message?sessionId=%s", sessionId);


dhrubo-os · 2025-04-30T16:09:02Z

plugin/src/main/java/org/opensearch/ml/rest/mcpserver/RestMLRegisterMcpToolsAction.java

            .collect(Collectors.toSet());
        if (!unrecognizedTools.isEmpty()) {
-            exception.addValidationError(String.format(Locale.ROOT, "Unrecognized tool in request: {}", unrecognizedTools));
+            exception.addValidationError(String.format(Locale.ROOT, "Unrecognized tool in request: %s", unrecognizedTools));


this should be quite easy to add a test on this.

dhrubo-os · 2025-04-30T16:09:42Z

Approving this PR for now just to unblock other PRs. But Please address these comments in another PR. Thanks.

* support customized message endpoint and addressing comments Signed-off-by: zane-neo <zaniu@amazon.com> * fix UT failures Signed-off-by: zane-neo <zaniu@amazon.com> * add files to jacoco exception Signed-off-by: zane-neo <zaniu@amazon.com> * fix tool name issue and optimize register tool api Signed-off-by: zane-neo <zaniu@amazon.com> * fix schema not parsed correctly issue and NPE when parameters is null Signed-off-by: zane-neo <zaniu@amazon.com> * fix failure UT Signed-off-by: zane-neo <zaniu@amazon.com> --------- Signed-off-by: zane-neo <zaniu@amazon.com> (cherry picked from commit 887c90a)

…3817) * support customized message endpoint and addressing comments * fix UT failures * add files to jacoco exception * fix tool name issue and optimize register tool api * fix schema not parsed correctly issue and NPE when parameters is null * fix failure UT --------- (cherry picked from commit 887c90a) Signed-off-by: zane-neo <zaniu@amazon.com> Co-authored-by: zane-neo <zaniu@amazon.com>

zane-neo · 2025-05-01T09:10:05Z

Approving this PR for now just to unblock other PRs. But Please address these comments in another PR. Thanks.

Sure, will create issue to track on the UT coverage.

* [BUG] Agent Framework: Handle model response when toolUse is not accompanied by text (#3755) * fix: handle model response when toolUse is not accompanied by text Signed-off-by: Pavan Yekbote <pybot@amazon.com> * feat: add test case for parseLLMOutput Signed-off-by: Pavan Yekbote <pybot@amazon.com> --------- Signed-off-by: Pavan Yekbote <pybot@amazon.com> * [BUG] Allow user to control react agent max_interations value to prevent empty response (#3756) * fix: expose max_iteration for react Signed-off-by: Pavan Yekbote <pybot@amazon.com> * fix: defaults for agent execution and differentiate between step and step result Signed-off-by: Pavan Yekbote <pybot@amazon.com> * fix: return react agent id in agent response to expose more details Signed-off-by: Pavan Yekbote <pybot@amazon.com> * spotless Signed-off-by: Pavan Yekbote <pybot@amazon.com> * fix: remove test prompt from react system prompt Signed-off-by: Pavan Yekbote <pybot@amazon.com> * refactor: rename parameters exposed to user to executor Signed-off-by: Pavan Yekbote <pybot@amazon.com> * fix: give user complete control over planner system prompt Signed-off-by: Pavan Yekbote <pybot@amazon.com> --------- Signed-off-by: Pavan Yekbote <pybot@amazon.com> * Clean up JSM from MCP (#3773) Signed-off-by: rithin-pullela-aws <rithinp@amazon.com> * [Bug] ListTools call does not return tool attributes (#3785) * initial commit for MCP server in OpenSearch (#3781) * initial commit for MCP server in OpenSearch Signed-off-by: zane-neo <zaniu@amazon.com> * Make change to support register or remove tools across cluster Signed-off-by: zane-neo <zaniu@amazon.com> * format code Signed-off-by: zane-neo <zaniu@amazon.com> * fix UT failure caused by code change Signed-off-by: zane-neo <zaniu@amazon.com> * format code Signed-off-by: zane-neo <zaniu@amazon.com> * format code Signed-off-by: zane-neo <zaniu@amazon.com> * add license header Signed-off-by: zane-neo <zaniu@amazon.com> * fix notifications initialized not respond issue Signed-off-by: zane-neo <zaniu@amazon.com> * fix minor issues and add UTs Signed-off-by: zane-neo <zaniu@amazon.com> * Add more UTs Signed-off-by: zane-neo <zaniu@amazon.com> --------- Signed-off-by: zane-neo <zaniu@amazon.com> * Remove beta1 qualifier (#3794) (#3795) (cherry picked from commit 3f503f1) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> * [AUTO] Increment version to 3.1.0-SNAPSHOT (#3789) * Increment version to 3.1.0-SNAPSHOT Signed-off-by: opensearch-ci-bot <opensearch-infra@amazon.com> * Update build.gradle Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> --------- Signed-off-by: opensearch-ci-bot <opensearch-infra@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: opensearch-ci-bot <opensearch-infra@amazon.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> * add release note for 3.0 (#3792) Signed-off-by: Mingshi Liu <mingshl@amazon.com> * support MCP session management (#3803) * support MCP session management Signed-off-by: zane-neo <zaniu@amazon.com> * Addressing comments Signed-off-by: zane-neo <zaniu@amazon.com> * add feature flag for mcp server and renaming mcp connector feature flag Signed-off-by: zane-neo <zaniu@amazon.com> * Address critical comments in #3781 Signed-off-by: zane-neo <zaniu@amazon.com> --------- Signed-off-by: zane-neo <zaniu@amazon.com> * upgrade http client to version align with core (#3809) * upgrade http client to versoin align with core Signed-off-by: zane-neo <zaniu@amazon.com> * upgrade httpclient-h2 to correct versiono Signed-off-by: zane-neo <zaniu@amazon.com> * use placeholder approach Signed-off-by: zane-neo <zaniu@amazon.com> --------- Signed-off-by: zane-neo <zaniu@amazon.com> * support customized message endpoint and addressing comments (#3810) * support customized message endpoint and addressing comments Signed-off-by: zane-neo <zaniu@amazon.com> * fix UT failures Signed-off-by: zane-neo <zaniu@amazon.com> * add files to jacoco exception Signed-off-by: zane-neo <zaniu@amazon.com> * fix tool name issue and optimize register tool api Signed-off-by: zane-neo <zaniu@amazon.com> * fix schema not parsed correctly issue and NPE when parameters is null Signed-off-by: zane-neo <zaniu@amazon.com> * fix failure UT Signed-off-by: zane-neo <zaniu@amazon.com> --------- Signed-off-by: zane-neo <zaniu@amazon.com> * excluding circuit breaker for Agent (#3814) Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> * change release note (#3811) * change release note Signed-off-by: zane-neo <zaniu@amazon.com> * Update opensearch-ml-common.release-notes-3.0.0.0.md * Update opensearch-ml-common.release-notes-3.0.0.0.md * Update opensearch-ml-common.release-notes-3.0.0.0.md --------- Signed-off-by: zane-neo <zaniu@amazon.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> * Downgrade MCP version to 0.9 (#3821) Signed-off-by: rithin-pullela-aws <rithinp@amazon.com> * remove libs folder (#3824) Signed-off-by: Yaliang Wu <ylwu@amazon.com> * add more logging to deploy/undeploy flows for better debugging (#3825) * add more logging to deploy/undeploy flows for better debugging Signed-off-by: Bhavana Goud Ramaram <rbhavna@amazon.com> * Fix python client not able to connect to MCP server issue (#3822) Signed-off-by: zane-neo <zaniu@amazon.com> Co-authored-by: Dhrubo Saha <dhrubo@amazon.com> * exclude trusted connector check for hidden model (#3838) Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> * adding tenantId to the connector executor when this is inline connector (#3837) * adding tenantId to the connector executor when this is inline connector Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> * added more unit tests Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> --------- Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> --------- Signed-off-by: Pavan Yekbote <pybot@amazon.com> Signed-off-by: rithin-pullela-aws <rithinp@amazon.com> Signed-off-by: zane-neo <zaniu@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: opensearch-ci-bot <opensearch-infra@amazon.com> Signed-off-by: Mingshi Liu <mingshl@amazon.com> Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> Signed-off-by: Yaliang Wu <ylwu@amazon.com> Signed-off-by: Bhavana Goud Ramaram <rbhavna@amazon.com> Co-authored-by: Pavan Yekbote <pybot@amazon.com> Co-authored-by: Rithin Pullela <rithinp@amazon.com> Co-authored-by: zane-neo <zaniu@amazon.com> Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: opensearch-ci-bot <opensearch-infra@amazon.com> Co-authored-by: Mingshi Liu <mingshl@amazon.com> Co-authored-by: Yaliang Wu <ylwu@amazon.com> Co-authored-by: Bhavana Goud Ramaram <rbhavna@amazon.com>

…ch-project#3810) * support customized message endpoint and addressing comments Signed-off-by: zane-neo <zaniu@amazon.com> * fix UT failures Signed-off-by: zane-neo <zaniu@amazon.com> * add files to jacoco exception Signed-off-by: zane-neo <zaniu@amazon.com> * fix tool name issue and optimize register tool api Signed-off-by: zane-neo <zaniu@amazon.com> * fix schema not parsed correctly issue and NPE when parameters is null Signed-off-by: zane-neo <zaniu@amazon.com> * fix failure UT Signed-off-by: zane-neo <zaniu@amazon.com> --------- Signed-off-by: zane-neo <zaniu@amazon.com> Signed-off-by: Abdul Muneer Kolarkunnu <muneer.kolarkunnu@netapp.com>

support customized message endpoint and addressing comments

5b40c02

Signed-off-by: zane-neo <zaniu@amazon.com>

zane-neo requested review from HenryL27, Zhangxunmt, austintlee, b4sjoo, dhrubo-os, jngz-es, mingshl, model-collapse, rbhavna, xinyual and ylwu-amzn as code owners April 30, 2025 06:47

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 06:49 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 06:49 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 06:49 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 06:49 — with GitHub Actions Error

peterzhuamazon mentioned this pull request Apr 30, 2025

[RELEASE] Release version 3.0.0 opensearch-project/opensearch-build#3747

Closed

66 tasks

fix UT failures

1820d67

Signed-off-by: zane-neo <zaniu@amazon.com>

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 08:15 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 08:15 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 08:15 — with GitHub Actions Error

add files to jacoco exception

54bc7c3

Signed-off-by: zane-neo <zaniu@amazon.com>

zane-neo temporarily deployed to ml-commons-cicd-env April 30, 2025 09:09 — with GitHub Actions Inactive

zane-neo temporarily deployed to ml-commons-cicd-env April 30, 2025 10:12 — with GitHub Actions Inactive

zane-neo temporarily deployed to ml-commons-cicd-env April 30, 2025 10:41 — with GitHub Actions Inactive

zane-neo temporarily deployed to ml-commons-cicd-env April 30, 2025 11:43 — with GitHub Actions Inactive

fix schema not parsed correctly issue and NPE when parameters is null

768d111

Signed-off-by: zane-neo <zaniu@amazon.com>

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 12:21 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 12:21 — with GitHub Actions Failure

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 12:21 — with GitHub Actions Error

zane-neo had a problem deploying to ml-commons-cicd-env April 30, 2025 12:22 — with GitHub Actions Failure

fix failure UT

89d5901

Signed-off-by: zane-neo <zaniu@amazon.com>

zane-neo temporarily deployed to ml-commons-cicd-env April 30, 2025 12:46 — with GitHub Actions Inactive

zane-neo temporarily deployed to ml-commons-cicd-env April 30, 2025 13:49 — with GitHub Actions Inactive

dhrubo-os reviewed Apr 30, 2025

View reviewed changes

dhrubo-os added the backport 3.0 label Apr 30, 2025

mingshl approved these changes Apr 30, 2025

View reviewed changes

dhrubo-os approved these changes Apr 30, 2025

View reviewed changes

dhrubo-os merged commit 887c90a into opensearch-project:main Apr 30, 2025
12 of 14 checks passed

opensearch-trigger-bot bot mentioned this pull request Apr 30, 2025

[Backport 3.0] support customized message endpoint and addressing comments #3817

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support customized message endpoint and addressing comments#3810

support customized message endpoint and addressing comments#3810
dhrubo-os merged 6 commits intoopensearch-project:mainfrom
zane-neo:support-customized-message-endpoint

zane-neo commented Apr 30, 2025

Uh oh!

codecov bot commented Apr 30, 2025 •

edited

Loading

Uh oh!

dhrubo-os Apr 30, 2025

Uh oh!

dhrubo-os Apr 30, 2025

Uh oh!

dhrubo-os Apr 30, 2025

Uh oh!

dhrubo-os Apr 30, 2025

Uh oh!

dhrubo-os commented Apr 30, 2025

Uh oh!

Uh oh!

zane-neo commented May 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

zane-neo commented Apr 30, 2025

Description

Related Issues

Check List

Uh oh!

codecov bot commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dhrubo-os Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

dhrubo-os Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

dhrubo-os Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

dhrubo-os Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

dhrubo-os commented Apr 30, 2025

Uh oh!

Uh oh!

zane-neo commented May 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Apr 30, 2025 •

edited

Loading