Configure OpenSearch MCP Backend and Tools

OpenSearch MCP Backend

To create a Backend for MCP Virtual Server go to MCP Virtual Server details page and click “Create Backend”

OpenSearch backend allows configuration of MCP tools operating on data in an Instaclustr OpenSearch cluster.

Specify the name for the backend, note that this name will be prepended to all the tools configured for this backend.

Provide a OpenSearch Cluster ID and credentials that MCP Gateway will use to authenticate to the OpenSearch cluster. Follow Creating an OpenSearch Cluster to create an OpenSearch cluster, and OpenSearch Access Control on how to create a OpenSearch user and ensure the user has only the privileges required.

If the OpenSearch cluster is a Private Network cluster or you want the MCP Gateway to use private networking to communicate with the OpenSearch cluster consider enabling “Create a network peering connection” and “Use private network” options.

To create OpenSearch tools go to OpenSearch backend details page and click “Create Tool” 

OpenSearch Document Search Tool

OpenSearch Document Search Tool will execute a pre-configured OpenSearch query on the pre-configured index on your OpenSearch cluster and return the hits.

Specify the name and description for the tool. These should provide information about the tool’s intented use and effects.

Specify the index you want searched.

Specify the OpenSearch query for the tool to execute. Use {"$param": "paramName"} syntax to mark bind variables that the AI agent will supply at call time (e.g. {“query”:{“match”:{“type”:{"$param": "type"}}}}).

Optionally specify parameters to declare the bind variables referenced in the query. Multiple parameters can be configured with the “Add Parameter” button. Specify how the parameter name, the parameter type and an optional description.

OpenSearch Index Document Tool

OpenSearch Index Document Tool will add an AI agent supplied document to a pre-configured index on your OpenSearch cluster.

Specify the name and description for the tool. These should provide information about the tool’s intented use and effects.

Specify the index you want to document to be added to.

Optionally specify the document schema in the JSON schema format.