fix version introduced ListIndexTool

Signed-off-by: zane-neo <[email protected]>

Author: zane-neo

_automating-configurations/workflow-tutorial.md

@@ -16,10 +16,10 @@ The setup requires the following sequence of API requests, with provisioned reso
     * [`deploy_model_3`](#deploy_model_3): Deploy the model.
 1. **Use the deployed model for inference**
     * Set up several tools that perform specific tasks:
-      * [`cat_index_tool`](#cat_index_tool): Set up a tool to obtain index information.
+      * [`list_index_tool`](#list_index_tool): Set up a tool to obtain index information.
       * [`ml_model_tool`](#ml_model_tool): Set up a machine learning (ML) model tool.
     * Set up one or more agents that use some combination of the tools:
-      * [`sub_agent`](#sub_agent): Create an agent that uses the `cat_index_tool`.
+      * [`sub_agent`](#sub_agent): Create an agent that uses the `list_index_tool`.
     * Set up tools representing these agents:
       * [`agent_tool`](#agent_tool): Wrap the `sub_agent` so that you can use it as a tool.
     * [`root_agent`](#root_agent): Set up a root agent that may delegate the task to either a tool or another agent.
@@ -119,17 +119,17 @@ If you define `previous_node_inputs`, then defining edges is optional.
 A CoT agent can use the deployed model in a tool. This step doesn’t strictly correspond to an API but represents a component of the body required by the [Register Agent API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/). This simplifies the register request and allows reuse of the same tool in multiple agents. For more information about agents and tools, see [Agents and tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/).
 
 <!-- vale off -->
-### cat_index_tool
+### list_index_tool
 <!-- vale on -->
 
-You can configure other tools to be used by the CoT agent. For example, you can configure a `cat_index_tool` as follows. This tool does not depend on any previous steps:
+You can configure other tools to be used by the CoT agent. For example, you can configure a `list_index_tool` as follows. This tool does not depend on any previous steps:
 
 ```yaml
-- id: cat_index_tool
+- id: list_index_tool
   type: create_tool
   user_inputs:
-    name: CatIndexTool
-    type: CatIndexTool
+    name: ListIndexTool
+    type: ListIndexTool
     parameters:
       max_iteration: 5
 ```
@@ -138,15 +138,15 @@ You can configure other tools to be used by the CoT agent. For example, you can
 ### sub_agent
 <!-- vale on -->
 
-To use the `cat_index_tool` in the agent configuration, specify it as one of the tools in the `previous_node_inputs` field of the agent. You can add other tools to `previous_node_inputs` as necessary. The agent also needs a large language model (LLM) in order to reason with the tools. The LLM is defined by the `llm.model_id` field. This example assumes that the `model_id` from the `deploy_model_3` step will be used. However, if another model is already deployed, the `model_id` of that previously deployed model could be included in the `user_inputs` field instead:
+To use the `list_index_tool` in the agent configuration, specify it as one of the tools in the `previous_node_inputs` field of the agent. You can add other tools to `previous_node_inputs` as necessary. The agent also needs a large language model (LLM) in order to reason with the tools. The LLM is defined by the `llm.model_id` field. This example assumes that the `model_id` from the `deploy_model_3` step will be used. However, if another model is already deployed, the `model_id` of that previously deployed model could be included in the `user_inputs` field instead:
 
 ```yaml
 - id: sub_agent
   type: register_agent
   previous_node_inputs:
     # When llm.model_id is not present this can be used as a fallback value
     deploy-model-3: model_id
-    cat_index_tool: tools
+    list_index_tool: tools
   user_inputs:
     name: Sub Agent
     type: conversational
@@ -164,7 +164,7 @@ To use the `cat_index_tool` in the agent configuration, specify it as one of the
 OpenSearch will automatically create the following edges so that the agent can retrieve the fields from the previous node: 
 
 ```yaml
-- source: cat_index_tool
+- source: list_index_tool
   dest: sub_agent
 - source: deploy_model_3
   dest: sub_agent
@@ -322,19 +322,19 @@ workflows:
     # For example purposes, the model_id obtained as the output of the deploy_model_3 step will be used
     # for several below steps.  However, any other deployed model_id can be used for those steps.
     # This is one example tool from the Agent Framework.
-    - id: cat_index_tool
+    - id: list_index_tool
       type: create_tool
       user_inputs:
-        name: CatIndexTool
-        type: CatIndexTool
+        name: ListIndexTool
+        type: ListIndexTool
         parameters:
           max_iteration: 5
     # This simple agent only has one tool, but could be configured with many tools
     - id: sub_agent
       type: register_agent
       previous_node_inputs:
         deploy-model-3: model_id
-        cat_index_tool: tools
+        list_index_tool: tools
       user_inputs:
         name: Sub Agent
         type: conversational
@@ -394,7 +394,7 @@ workflows:
       dest: register_model_2
     - source: register_model_2
       dest: deploy_model_3
-    - source: cat_index_tool
+    - source: list_index_tool
       dest: sub_agent
     - source: deploy_model_3
       dest: sub_agent
@@ -479,11 +479,11 @@ The following is the same template in JSON format:
           }
         },
         {
-          "id": "cat_index_tool",
+          "id": "list_index_tool",
           "type": "create_tool",
           "user_inputs": {
-            "name": "CatIndexTool",
-            "type": "CatIndexTool",
+            "name": "ListIndexTool",
+            "type": "ListIndexTool",
             "parameters": {
               "max_iteration": 5
             }
@@ -494,7 +494,7 @@ The following is the same template in JSON format:
           "type": "register_agent",
           "previous_node_inputs": {
             "deploy-model-3": "llm.model_id",
-            "cat_index_tool": "tools"
+            "list_index_tool": "tools"
           },
           "user_inputs": {
             "name": "Sub Agent",
@@ -581,7 +581,7 @@ The following is the same template in JSON format:
           "dest": "deploy_model_3"
         },
         {
-          "source": "cat_index_tool",
+          "source": "list_index_tool",
           "dest": "sub_agent"
         },
         {

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

@@ -12,7 +12,7 @@ redirect_from:
 **Introduced 2.13**
 {: .label .label-purple }
 
-You can automate machine learning (ML) tasks using agents and tools. An _agent_ orchestrates and runs ML models and tools. A _tool_ performs a set of specific tasks. Some examples of tools are the `VectorDBTool`, which supports vector search, and the `CATIndexTool`, which executes the `cat indices` operation. For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/).
+You can automate machine learning (ML) tasks using agents and tools. An _agent_ orchestrates and runs ML models and tools. A _tool_ performs a set of specific tasks. Some examples of tools are the `VectorDBTool`, which supports vector search, and the `ListIndexTool`, which executes the `cat indices` operation. For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/).
 
 ## Agents
 
@@ -109,7 +109,7 @@ Assistant:"""
 
 ### Conversational agents
 
-Similarly to a conversational flow agent, a conversational agent stores the conversation in an index, in the following example, the `conversation_index`. A conversational agent can be configured with an LLM and a set of supplementary tools that perform specific jobs. For example, you can set up an LLM and a `CATIndexTool` when configuring an agent. When you send a question to the model, the agent also includes the `CATIndexTool` as context. The LLM then decides whether it needs to use the `CATIndexTool` to answer questions like "How many indexes are in my cluster?" The context allows an LLM to answer specific questions that are outside of its knowledge base. For example, the following agent is configured with an LLM and a `CATIndexTool` that retrieves information about your OpenSearch indexes:
+Similarly to a conversational flow agent, a conversational agent stores the conversation in an index, in the following example, the `conversation_index`. A conversational agent can be configured with an LLM and a set of supplementary tools that perform specific jobs. For example, you can set up an LLM and a `ListIndexTool` when configuring an agent. When you send a question to the model, the agent also includes the `ListIndexTool` as context. The LLM then decides whether it needs to use the `ListIndexTool` to answer questions like "How many indexes are in my cluster?" The context allows an LLM to answer specific questions that are outside of its knowledge base. For example, the following agent is configured with an LLM and a `ListIndexTool` that retrieves information about your OpenSearch indexes:
 
 ```json
 POST /_plugins/_ml/agents/_register
@@ -142,7 +142,7 @@ POST /_plugins/_ml/agents/_register
       }
     },
     {
-      "type": "CatIndexTool",
+      "type": "ListIndexTool",
       "name": "RetrieveIndexMetaTool",
       "description": "Use this tool to get OpenSearch index information: (health, status, index, uuid, primary count, replica count, docs.count, docs.deleted, store.size, primary.store.size)."
     }

_ml-commons-plugin/agents-tools/tools/cat-index-tool.md

@@ -16,9 +16,9 @@ grand_parent: Agents and tools
 **This tool is deprecated in OpenSearch 3.0**
 {: .label .label-red }
 
-The `CatIndexTool` retrieves index information for the OpenSearch cluster, similarly to the [CAT Indices API]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-indices/).
+The `ListIndexTool` retrieves index information for the OpenSearch cluster, similarly to the [CAT Indices API]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-indices/).
 
-## Step 1: Register a flow agent that will run the CatIndexTool
+## Step 1: Register a flow agent that will run the ListIndexTool
 
 A flow agent runs a sequence of tools in order and returns the last tool's output. To create a flow agent, send the following register agent request:
 
@@ -27,11 +27,11 @@ POST /_plugins/_ml/agents/_register
 {
   "name": "Test_Agent_For_CatIndex_tool",
   "type": "flow",
-  "description": "this is a test agent for the CatIndexTool",
+  "description": "this is a test agent for the ListIndexTool",
   "tools": [
     {
-      "type": "CatIndexTool",
-      "name": "DemoCatIndexTool",
+      "type": "ListIndexTool",
+      "name": "DemoListIndexTool",
       "parameters": {
         "input": "${parameters.question}"
       }

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

@@ -32,7 +32,8 @@ Each tool takes a list of parameters specific to that tool. In the preceding exa
 |Tool	| Description	|
 |:---	|:---	|
 |[`AgentTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/agent-tool/)	|Runs any agent. |
-|[`CatIndexTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/cat-index-tool/)	|Retrieves index information for the OpenSearch cluster. |
+|[`CatIndexTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/cat-index-tool/)	|Retrieves index information for the OpenSearch cluster, deprecated in OpenSearch 3.0 |
+|[`ListIndexTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/list-index-tool/)	|Retrieves index information for the OpenSearch cluster, introduced in OpenSearch 3.0 as CatIndexTool's replacement |
 |[`ConnectorTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/connector-tool/)	| Uses a [connector]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/) to call any REST API function. |
 |[`IndexMappingTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index-mapping-tool/)	|Retrieves index mapping and setting information for an index. |
 |[`CreateAnomalyDetectorTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/create-anomaly-detector/)	| Enables an LLM to suggest required parameters for creating an anomaly detector. |

_ml-commons-plugin/api/agent-apis/register-agent.md

@@ -173,7 +173,7 @@ POST /_plugins/_ml/agents/_register
       }
     },
     {
-      "type": "CatIndexTool",
+      "type": "ListIndexTool",
       "name": "RetrieveIndexMetaTool",
       "description": "Use this tool to get OpenSearch index information: (health, status, index, uuid, primary count, replica count, docs.count, docs.deleted, store.size, primary.store.size)."
     }

_ml-commons-plugin/api/memory-apis/get-message-traces.md

@@ -92,7 +92,7 @@ green    open    opensearch_dashboards_sample_data_flights    pJde0irnTce4-uobHw
 green    open    my_test_data    T4hwNs7CTJGIfw2QpCqQ_Q    1    1    6    0    91.7kb    45.8kb
 green    open    .opendistro-job-scheduler-lock    XjgmXAVKQ4e8Y-ac54VBzg    1    1    3    0    38.7kb    19.4kb
 """,
-      "origin": "CatIndexTool",
+      "origin": "ListIndexTool",
       "additional_info": {},
       "parent_message_id": "TAuCZY0BT2tRrkdmCPqZ",
       "trace_number": 2

_tutorials/gen-ai/chatbots/build-chatbot.md

@@ -279,7 +279,7 @@ POST _plugins/_ml/agents/_register
       }
     },
     {
-      "type": "CatIndexTool",
+      "type": "ListIndexTool",
       "description": "Use this tool to get OpenSearch index information: (health, status, index, uuid, primary count, replica count, docs.count, docs.deleted, store.size, primary.store.size). \nIt takes 2 optional arguments named `index` which is a comma-delimited list of one or more indices to get information from (default is an empty list meaning all indices), and `local` which means whether to return information from the local node only instead of the cluster manager node (default is false)."
     },
     {
@@ -313,7 +313,7 @@ Note the following testing tips:
    - Avoid configuring many tools in an agent.
    - Provide a detailed tool description clarifying what the tool can do. 
    - Specify the tool to use in the LLM question, for example, `Can you use the PPLTool to query the opensearch_dashboards_sample_data_ecommerce index so it can calculate how many orders were placed last week?`.
-   - Specify the tool to use when executing an agent. For example, specify that only `PPLTool` and `CatIndexTool` should be used to process the current request.
+   - Specify the tool to use when executing an agent. For example, specify that only `PPLTool` and `ListIndexTool` should be used to process the current request.
 
 Test the agent:
 
@@ -323,7 +323,7 @@ POST _plugins/_ml/agents/your_agent_id/_execute
     "parameters": {
     "question": "Can you query with index opensearch_dashboards_sample_data_ecommerce to calculate how many orders in last week?",
     "verbose": false,
-    "selected_tools": ["PPLTool", "CatIndexTool"]
+    "selected_tools": ["PPLTool", "ListIndexTool"]
     }
 }
 ```