[MCP Server] Add tool registration step #11346
Conversation
rithin-pullela-aws
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
|
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. |
rithin-pullela-aws
force-pushed
the
mcp-server-update-doc
branch
from
3751476 to
948aaa5
Compare
Signed-off-by: rithin-pullela-aws <[email protected]>
rithin-pullela-aws
force-pushed
the
mcp-server-update-doc
branch
from
948aaa5 to
fdb2cfe
Compare
There was a problem hiding this comment.
Thank you, @rithin-pullela-aws! A couple of suggestions before we can move on to editorial review.
| While not required for normal usage, you can manually invoke the MCP server using JSON-RPC calls over HTTP. The following example presents typical MCP client behavior. | ||
|
|
||
| #### Step 1: Initialize a connection | ||
| #### Step 1: Register tools |
There was a problem hiding this comment.
| #### Step 1: Register tools | |
| #### Step 1 (Optional): Register custom tools |
| #### Step 1: Initialize a connection | ||
| #### Step 1: Register tools | ||
|
|
||
| Before connecting to the MCP server, you can register custom tools using the register API. Here's how to register a list index tool: |
There was a problem hiding this comment.
| Before connecting to the MCP server, you can register custom tools using the register API. Here's how to register a list index tool: | |
| Before connecting to the MCP server, you can register custom tools using the [Register MCP Tools API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/mcp-server-apis/register-mcp-tools/). For example, to register a [List Index tool]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/list-index-tool/), send the following request : |
2 participants
Description
Adds the tool registration step to make it clear for readers
Issues Resolved
Closes #[Replace this text, including the brackets, with the issue number. Leave "Closes #" so the issue is closed properly.]
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
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
For more information on following Developer Certificate of Origin and signing off your commits, please check here.