Link Search Menu Expand Document Documentation Menu
Documentation

Update MCP tools

Introduced 3.0

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion on the OpenSearch forum.

Use this API to update one or more Model Context Protocol (MCP)-based tools. For more information about supported tools, see Tools.

Endpoints

POST /_plugins/_ml/mcp/tools/_update

Request body fields

The following table lists the available request fields.

Field Data type Required/Optional Description
tools Array Required A list of tools.

The tools array contains a list of tools. Each tool contains the following fields.

Field Data type Required/Optional Description
name String Required The name of the tool to update.
type String Optional The tool type. For a list of supported tools, see Tools.
description String Optional The description of the tool.
parameters Object Optional The parameters for the tool. The parameters are dependent on the tool type. For information about specific tool types, see Tools.
attributes Object Optional The configuration properties (attributes) for the tool. The most important attribute in this field is the tool’s input_schema, which defines the expected parameter format for the tool. This schema is sent to the large language model (LLM) so it can properly format parameters when executing the tool.

Example requests

The following sections provide example requests for updating tools. For information about tool-specific parameters, see the corresponding tool documentation.

WebSearchTool

POST /_plugins/_ml/mcp/tools/_update
{
  "tools": [
    {
      "type": "WebSearchTool",
      "name": "GoogleSearchTool",
      "description": "This tool can be used to perform search via google engine and parse the content of the searched results",
      "attributes": {
        "input_schema": {
          "type": "object",
          "properties": {
            "engine": {
              "type": "string",
              "description": "The search engine that will be used by the tool."
            },
            "query": {
              "type": "string",
              "description": "The search query parameter that will be used by the engine to perform the search."
            },
            "next_page": {
              "type": "string",
              "description": "The search result's next page link. If this is provided, the WebSearchTool will fetch the next page results using this link and crawl the links on the page."
            }
          },
          "required": [
            "engine",
            "query"
          ]
        },
        "strict": false
      }
    }
  ]
}

PPLTool

POST /_plugins/_ml/mcp/tools/_update
{
  "type": "PPLTool",
  "name": "TransferQuestionToPPLAndExecuteTool",
  "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": "${your_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."
        }
      }
    }
  }
}

Example response

For each node, OpenSearch responds with the node ID and the status of the update operation for all tools:

{
    "_ZNV5BrNTVm6ilcM7Jn1pw": {
        "updated": true
    },
    "NZ9aiUCrSp2b5KBqdJGJKw": {
        "updated": true
    }
}
350 characters left

Have a question? .

Want to contribute? or .