Skip to content

Commit 7de4535

Browse files
Fix readme and user guide (#105)
Signed-off-by: Nathalie Jonathan <[email protected]>
1 parent c8377dd commit 7de4535

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Core tools are grouped under the `core_tools` category and can be disabled at on
4747
- [MsearchTool](https://docs.opensearch.org/docs/latest/api-reference/search-apis/multi-search/): Allows to execute several search operations in one request.
4848

4949
### Additional Tools (Disabled by Default)
50-
The following tools are available but disabled by default. To enable them, see the [Tool Filtering](USER_GUIDE.md#tool-filtering) section in the User Guide.
50+
The following tools are available but disabled by default. To enable them, see the [Tool Filter](USER_GUIDE.md#tool-filter) section in the User Guide.
5151

5252
- [GetClusterStateTool](https://docs.opensearch.org/docs/latest/api-reference/cluster-api/cluster-state/): Gets the current state of the cluster including node information, index settings, and more.
5353
- [GetSegmentsTool](https://docs.opensearch.org/docs/latest/api-reference/cat/cat-segments/): Gets information about Lucene segments in indices, including memory usage, document counts, and segment sizes.

USER_GUIDE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -540,6 +540,8 @@ tools:
540540
ListIndexTool:
541541
display_name: "Index_Manager"
542542
description: "List and manage OpenSearch indices"
543+
args:
544+
index: "Custom description for the 'index' argument in ListIndexTool."
543545
GetShardsTool:
544546
description: "Retrieve detailed information about OpenSearch shards"
545547
```
@@ -553,18 +555,18 @@ python -m mcp_server_opensearch --config path/to/config.yml
553555

554556
Customize tools directly via command line arguments:
555557
```bash
556-
python -m mcp_server_opensearch --tool.ListIndexTool.display_name="Index_Manager" --tool.SearchIndexTool.description="Custom search tool"
558+
python -m mcp_server_opensearch --tool.ListIndexTool.display_name="Index_Manager" --tool.SearchIndexTool.description="Custom search tool" --tool.GetShardsTool.args.index.description="Custom description"
557559
```
558560

559561
### Priority
560562

561-
Runtime parameters have higher priority than configuration file settings. If both are provided, runtime parameters will override the corresponding values in the configuration file.
563+
Configuration file settings have higher priority than runtime parameters. If both are provided, configuration file settings will override the corresponding values in the runtime parameters.
562564

563565
### Important Notes
564566
- Tool customization is available in both single and multi modes
565567
- Only existing tools can be customized; new tools cannot be created
566568
- Changes take effect immediately when the server starts
567-
- Invalid tool names or properties will be ignored
569+
- Invalid tool names or properties will throw an error
568570

569571
## LangChain Integration
570572

0 commit comments

Comments
 (0)