Add MCP Connectors documentation #9757

rithin-pullela-aws · 2025-04-28T23:02:58Z

Description

Adds documentation for the new feature which allows Agents to be provided with MCP Tools. Creating a new folder for MCP since many other features related to MCP will be added soon.

Issues Resolved

Closes #9758

Version

3.0

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

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

Signed-off-by: rithin-pullela-aws <[email protected]>

github-actions · 2025-04-28T23:03:10Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: rithin-pullela-aws <[email protected]>

_ml-commons-plugin/mcp/index.md

_ml-commons-plugin/mcp/mcp-connector.md

mingshl · 2025-04-29T00:30:47Z

_ml-commons-plugin/mcp/mcp-connector.md

+### MCP Server
+A running MCP server (Any MCP-compliant implementation) accessible from your OpenSearch cluster.
+
+## Using MCP Tools


can you add some brief introduction on what this use case is about?

I have mentioned this in the overview part

_ml-commons-plugin/mcp/mcp-connector.md

kolchfa-aws · 2025-05-02T14:57:16Z

@rithin-pullela-aws Please let me know when you address tech review comments and we can start a doc review. We need a doc and editorial review before we can merge, and we have to release the docs 5/6.

Signed-off-by: rithin-pullela-aws <[email protected]>

rithin-pullela-aws · 2025-05-02T18:10:40Z

@kolchfa-aws, I have addressed the comments, can you please look into this, thank you!!

Signed-off-by: Fanit Kolchina <[email protected]>

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

kolchfa-aws · 2025-05-02T20:19:35Z

@rithin-pullela-aws I made my edits and pushed into your PR. I think this topic is best placed in the Agents and tools section. I also changed the name to be more precise. Please review my changes and verify that everything is correct. Thanks!

_ml-commons-plugin/agents-tools/mcp/index.md

Signed-off-by: kolchfa-aws <[email protected]>

kolchfa-aws

LGTM

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

ylwu-amzn · 2025-05-05T16:46:55Z

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

+        "mcp_connector_id": "<MCP_CONNECTOR_ID_FROM_STEP_1`>",
+        "tool_filters": [
+          "^get_forecast",    
+          "search_indices"    


Why add this ?

Suggest explain what tools are in the MCP server and what tools will be used with this filter

Addressed this comment in a new commit, please take a look

Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

…out tool_filters regex matching condition Signed-off-by: rithin-pullela-aws <[email protected]>

rithin-pullela-aws · 2025-05-05T17:54:52Z

@kolchfa-aws, I pushed another commit, please take a look

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

kolchfa-aws · 2025-05-05T18:33:10Z

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

@@ -176,9 +176,9 @@ POST /_plugins/_ml/agents/_register
    "mcp_connectors": [
      {
        "mcp_connector_id": "<MCP_CONNECTOR_ID_FROM_STEP_1>",
+        /* MCP server has get_alerts and get_forecasts tools, but only get_alerts will be included due to regex pattern */


@rithin-pullela-aws We have a copy button on the requests, so they must be executable as is. Please move this to the intro sentence on line 155 and delete from here.

Sure will update

kolchfa-aws · 2025-05-05T18:33:57Z

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

@@ -74,7 +74,7 @@ The following table describes the connector parameters. For more information abo

 | Parameter | Data type | Required | Description |
 |:----------|:---------|:------------|
-| `protocol` | String | Yes | Specify `mcp_sse` to use the SSE protocol (currently the only supported protocol type).  |
+| `protocol` | String | Yes | Specify `mcp_sse` to use the SSE protocol (currently the only supported protocol type for MCP).  |


I would remove "currently". This is implied.

Signed-off-by: rithin-pullela-aws <[email protected]>

rithin-pullela-aws · 2025-05-05T18:44:38Z

@kolchfa-aws @ylwu-amzn, I addressed the comments, can you help review the chanegs

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

rithin-pullela-aws · 2025-05-05T19:24:48Z

Committed @kolchfa-aws's suggestions.

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

Signed-off-by: kolchfa-aws <[email protected]>

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md

Signed-off-by: kolchfa-aws <[email protected]>

* Add MCP Connectors documentation Signed-off-by: rithin-pullela-aws <[email protected]> * Change nav structure Signed-off-by: rithin-pullela-aws <[email protected]> * address comments Signed-off-by: rithin-pullela-aws <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Fix links Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Add comment demonstrating tool filter working and add more details about tool_filters regex matching condition Signed-off-by: rithin-pullela-aws <[email protected]> * Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Address comments Signed-off-by: rithin-pullela-aws <[email protected]> * Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> * Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: rithin-pullela-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Yaliang Wu <[email protected]>

Add MCP Connectors documentation

58e4de7

Signed-off-by: rithin-pullela-aws <[email protected]>

github-actions bot assigned kolchfa-aws Apr 28, 2025

Change nav structure

feeb6dc

Signed-off-by: rithin-pullela-aws <[email protected]>

rithin-pullela-aws marked this pull request as ready for review April 28, 2025 23:49

rithin-pullela-aws requested review from kolchfa-aws, Naarcha-AWS, AMoo-Miki, natebower, dlvenable and epugh as code owners April 28, 2025 23:49

mingshl reviewed Apr 29, 2025

View reviewed changes

_ml-commons-plugin/mcp/mcp-connector.md Outdated Show resolved Hide resolved

kolchfa-aws added v3.0.0 3 - Tech review PR: Tech review in progress release-notes PR: Include this PR in the automated release notes labels Apr 29, 2025

ylwu-amzn reviewed Apr 30, 2025

View reviewed changes

_ml-commons-plugin/mcp/mcp-connector.md Outdated Show resolved Hide resolved

ylwu-amzn reviewed Apr 30, 2025

View reviewed changes

_ml-commons-plugin/mcp/mcp-connector.md Outdated Show resolved Hide resolved

nathaliellenaa reviewed May 1, 2025

View reviewed changes

_ml-commons-plugin/mcp/mcp-connector.md Outdated Show resolved Hide resolved

nathaliellenaa reviewed May 1, 2025

View reviewed changes

_ml-commons-plugin/mcp/mcp-connector.md Outdated Show resolved Hide resolved

address comments

b0ee81e

Signed-off-by: rithin-pullela-aws <[email protected]>

kolchfa-aws added the experimental label May 2, 2025

Doc review

063bc33

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws reviewed May 2, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed May 2, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/index.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed May 2, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/index.md Outdated Show resolved Hide resolved

Fix links

ab15e10

Signed-off-by: kolchfa-aws <[email protected]>

kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Editorial review PR: Editorial review in progress labels May 5, 2025

kolchfa-aws approved these changes May 5, 2025

View reviewed changes

ylwu-amzn reviewed May 5, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

ylwu-amzn reviewed May 5, 2025

View reviewed changes

rithin-pullela-aws and others added 2 commits May 5, 2025 10:37

Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md

dfebd09

Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

Add comment demonstrating tool filter working and add more details ab…

8aaecfd

…out tool_filters regex matching condition Signed-off-by: rithin-pullela-aws <[email protected]>

ylwu-amzn reviewed May 5, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md

3727bc2

Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

kolchfa-aws reviewed May 5, 2025

View reviewed changes

Address comments

031d907

Signed-off-by: rithin-pullela-aws <[email protected]>

kolchfa-aws reviewed May 5, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed May 5, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

ylwu-amzn approved these changes May 5, 2025

View reviewed changes

rithin-pullela-aws and others added 2 commits May 5, 2025 12:24

Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md

bbf31c6

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md

e9a0f4e

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

Merge branch 'main' into mcpInit

88984bc

kolchfa-aws reviewed May 5, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed May 5, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

rithin-pullela-aws and others added 3 commits May 5, 2025 23:48

Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md

18656f0

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]>

Merge branch 'main' into mcpInit

d76d9e6

Apply suggestions from code review

3a48b58

Signed-off-by: kolchfa-aws <[email protected]>

kolchfa-aws reviewed May 6, 2025

View reviewed changes

_ml-commons-plugin/agents-tools/mcp/mcp-connector.md Outdated Show resolved Hide resolved

Update _ml-commons-plugin/agents-tools/mcp/mcp-connector.md

2b6ccd8

Signed-off-by: kolchfa-aws <[email protected]>

kolchfa-aws merged commit 7638ee7 into opensearch-project:main May 6, 2025
5 checks passed

Add MCP Connectors documentation #9757

Add MCP Connectors documentation #9757

Uh oh!

Conversation

rithin-pullela-aws commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Version

Frontend features

Checklist

Uh oh!

github-actions bot commented Apr 28, 2025

Uh oh!

Uh oh!

Uh oh!

mingshl Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

rithin-pullela-aws May 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kolchfa-aws commented May 2, 2025

Uh oh!

rithin-pullela-aws commented May 2, 2025

Uh oh!

Uh oh!

kolchfa-aws commented May 2, 2025

Uh oh!

Uh oh!

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ylwu-amzn May 5, 2025

Choose a reason for hiding this comment

Uh oh!

rithin-pullela-aws May 5, 2025

Choose a reason for hiding this comment

Uh oh!

rithin-pullela-aws commented May 5, 2025

Uh oh!

Uh oh!

kolchfa-aws May 5, 2025

Choose a reason for hiding this comment

Uh oh!

rithin-pullela-aws May 5, 2025

Choose a reason for hiding this comment

Uh oh!

kolchfa-aws May 5, 2025

Choose a reason for hiding this comment

Uh oh!

rithin-pullela-aws commented May 5, 2025

Uh oh!

Uh oh!

Uh oh!

rithin-pullela-aws commented May 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rithin-pullela-aws commented Apr 28, 2025 •

edited

Loading