Fix Tool Renaming Edge cases (#80)

* Fix Tool Filtering Edge cases

Signed-off-by: rithin-pullela-aws <[email protected]>

* Add Change log

Signed-off-by: rithin-pullela-aws <[email protected]>

---------

Signed-off-by: rithin-pullela-aws <[email protected]>

Author: rithin-pullela-aws

CHANGELOG.md

@@ -13,6 +13,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ### Fixed
 - Handle Tool Filtering failure gracefully and define priority to the AWS Region definitions ([#74](https://github.com/opensearch-project/opensearch-mcp-server-py/pull/74))
+- Fix Tool Renaming Edge cases ([#80](https://github.com/opensearch-project/opensearch-mcp-server-py/pull/80))
 
 ### Security
 

USER_GUIDE.md

@@ -511,6 +511,23 @@ export OPENSEARCH_SETTINGS_ALLOW_WRITE=true
 
 OpenSearch MCP server supports tool customization to modify tool display names, descriptions, and other properties. You can customize tools using either a YAML configuration file or runtime parameters.
 
+**Note:** Display names must follow the pattern `^[a-zA-Z0-9_-]+$` (alphanumeric characters, underscores, and hyphens only).
+
+### Supported Field Aliases
+
+The following field aliases are supported for tool customization:
+
+**Display Name Aliases:**
+- `display_name` (standard)
+- `name`
+- `displayName` 
+- `customName`
+
+**Description Aliases:**
+- `description` (standard)
+- `desc`
+- `customDescription`
+
 ### Configuration Methods
 
 1. **YAML Configuration File**
@@ -519,7 +536,7 @@ Create a YAML file with your tool customization settings:
 ```yaml
 tools:
   ListIndexTool:
-    display_name: "Index Manager"
+    display_name: "Index_Manager"
     description: "List and manage OpenSearch indices"
   GetShardsTool:
     description: "Retrieve detailed information about OpenSearch shards"
@@ -534,7 +551,7 @@ python -m mcp_server_opensearch --config path/to/config.yml
 
 Customize tools directly via command line arguments:
 ```bash
-python -m mcp_server_opensearch --tool.ListIndexTool.display_name="Index Manager" --tool.SearchIndexTool.description="Custom search tool"
+python -m mcp_server_opensearch --tool.ListIndexTool.display_name="Index_Manager" --tool.SearchIndexTool.description="Custom search tool"
 ```
 
 ### Priority

example_config.yml

@@ -27,10 +27,10 @@ clusters:
 # Tool customization configurations (supported in both Single and Multi Mode)
 tools:
   ListIndexTool:
-    display_name: "My Custom Index Lister"
+    display_name: "My_Custom_Index_Lister"
     description: "This is a custom description for the tool that lists indices. It's much more descriptive now!"
   SearchIndexTool:
-    display_name: "Super Searcher"
+    display_name: "Super_Searcher"
   GetShardsTool:
     description: "A better description to get information about shards in OpenSearch."
 

src/mcp_server_opensearch/__init__.py

@@ -13,7 +13,21 @@
 def parse_unknown_args_to_dict(unknown_args: List[str]) -> Dict[str, str]:
     """Parses a list of unknown arguments into a dictionary."""
     parser = argparse.ArgumentParser()
-    arg_keys = {arg.split('=')[0] for arg in unknown_args if arg.startswith('--')}
+
+    # Extract argument keys and track duplicates with warnings
+    seen = set()
+    duplicates = set()
+    arg_keys = set()
+
+    for arg in unknown_args:
+        if arg.startswith('--'):
+            key = arg.split('=')[0]
+            arg_keys.add(key)
+            if key in seen:
+                duplicates.add(key)
+                logging.warning(f"Duplicate argument '{key}' found. Using the latest value.")
+            else:
+                seen.add(key)
 
     for key in arg_keys:
         parser.add_argument(key)
@@ -22,7 +36,7 @@ def parse_unknown_args_to_dict(unknown_args: List[str]) -> Dict[str, str]:
         parsed_args, _ = parser.parse_known_args(unknown_args)
         return {k: v for k, v in vars(parsed_args).items() if v is not None}
     except Exception as e:
-        logging.error(f"Error parsing unknown arguments: {e}")
+        logging.error(f'Error parsing unknown arguments: {e}')
         return {}
 
 

src/mcp_server_opensearch/stdio_server.py

@@ -30,11 +30,13 @@ async def serve(
     if mode == 'multi':
         load_clusters_from_yaml(config_file_path)
 
-    # Call tool generator and tool filter
+    # Call tool generator
     await generate_tools_from_openapi()
+    # Apply custom tool config (custom name and description)
     customized_registry = apply_custom_tool_config(
         TOOL_REGISTRY, config_file_path, cli_tool_overrides or {}
     )
+    # Get enabled tools (tool filter)
     enabled_tools = get_tools(
         tool_registry=customized_registry, mode=mode, config_file_path=config_file_path
     )

src/mcp_server_opensearch/streaming_server.py

@@ -38,11 +38,13 @@ async def create_mcp_server(
         load_clusters_from_yaml(config_file_path)
 
     server = Server('opensearch-mcp-server')
-    # Call tool generator and tool fitler
+    # Call tool generator
     await generate_tools_from_openapi()
+    # Apply custom tool config (custom name and description)
     customized_registry = apply_custom_tool_config(
         TOOL_REGISTRY, config_file_path, cli_tool_overrides or {}
     )
+    # Get enabled tools (tool filter)
     enabled_tools = get_tools(
         tool_registry=customized_registry, mode=mode, config_file_path=config_file_path
     )
@@ -146,9 +148,7 @@ async def serve(
     config_file_path: str = '',
     cli_tool_overrides: dict = None,
 ) -> None:
-    mcp_server = await create_mcp_server(
-        mode, profile, config_file_path, cli_tool_overrides
-    )
+    mcp_server = await create_mcp_server(mode, profile, config_file_path, cli_tool_overrides)
     app_handler = MCPStarletteApp(mcp_server)
     app = app_handler.create_app()
 

src/opensearch/client.py

@@ -160,11 +160,13 @@ def initialize_client_with_cluster(cluster_info: ClusterInfo | None) -> OpenSear
 
     session = boto3.Session(profile_name=profile) if profile else boto3.Session()
     aws_region = get_aws_region(cluster_info)
-    print("aws_region is", aws_region)
+    print('aws_region is', aws_region)
 
     # 1. Try no authentication if explicitly enabled
     if os.getenv('OPENSEARCH_NO_AUTH', '').lower() == 'true':
-        logger.info('[NO AUTH] Attempting connection without authentication (OPENSEARCH_NO_AUTH=true)')
+        logger.info(
+            '[NO AUTH] Attempting connection without authentication (OPENSEARCH_NO_AUTH=true)'
+        )
         try:
             return OpenSearch(**client_kwargs)
         except Exception as e:
@@ -219,7 +221,7 @@ def initialize_client_with_cluster(cluster_info: ClusterInfo | None) -> OpenSear
             return OpenSearch(**client_kwargs)
     except (boto3.exceptions.Boto3Error, Exception) as e:
         logger.error(f'[AWS CREDS] Failed to get AWS credentials: {str(e)}')
-        
+
     raise RuntimeError('No valid AWS or basic authentication provided for OpenSearch')