Skip to content

Commit bf02c3a

Browse files
authored
update description for cat index tool (opensearch-project#2025)
Signed-off-by: yuye-aws <yuyezhu@amazon.com>
1 parent 8bd9592 commit bf02c3a

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/CatIndexTool.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,14 @@
5353
@ToolAnnotation(CatIndexTool.TYPE)
5454
public class CatIndexTool implements Tool {
5555
public static final String TYPE = "CatIndexTool";
56-
private static final String DEFAULT_DESCRIPTION = "Use this tool to get index information.";
56+
private static final String DEFAULT_DESCRIPTION = String
57+
.join(
58+
" ",
59+
"This tool gets index information from the OpenSearch cluster.",
60+
"It 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),",
61+
"and `local` which means whether to return information from the local node only instead of the cluster manager node (default is false).",
62+
"The tool returns the indices information, including `health`, `status`, `index`, `uuid`, `pri`, `rep`, `docs.count`, `docs.deleted`, `store.size`, `pri.store. size `, `pri.store.size`, `pri.store`."
63+
);
5764

5865
@Setter
5966
@Getter

0 commit comments

Comments
 (0)