Add renaming tool and description features (#69)

* Add renaming tool and description features by runtime params or config file

Signed-off-by: Sun Ro Lee <[email protected]>

* write changelog for tool perperties override feature

Signed-off-by: Sun Ro Lee <[email protected]>

* add warning if the length of tool desciption is over 1024 char

Signed-off-by: Sun Ro Lee <[email protected]>

* Add tool field aliases for flexible tool naming

Signed-off-by: Sun Ro Lee <[email protected]>

* Add display_name field to tool generator

Signed-off-by: Sun Ro Lee <[email protected]>

* Modify error message on `is_tool_compatible` to show supported version

Signed-off-by: Sun Ro Lee <[email protected]>

* Add user guide for tool customization

Signed-off-by: Sun Ro Lee <[email protected]>

* merge example of config files to `example_config.yml`

Signed-off-by: Sun Ro Lee <[email protected]>

* add tool customization section to user guide table_of_content

Signed-off-by: Sun Ro Lee <[email protected]>

* Fix test isolation issues

- Add OPENSEARCH_SSL_VERIFY to environment variable cleanup in test_client.py
- Fix mock data structure issues in test_tool_filters.py by patching TOOL_REGISTRY
- Fix unpacking error in serverless compatibility test

Signed-off-by: Sun Ro Lee <[email protected]>

* Fix serverless compatibility test expectations

- Update test to correctly expect is_tool_compatible to be called with None version in serverless mode
- Mock should return True for serverless mode compatibility check
- Verify both tools are enabled in serverless environment

Signed-off-by: Sun Ro Lee <[email protected]>

---------

Signed-off-by: Sun Ro Lee <[email protected]>

Author: ssunno

CHANGELOG.md

@@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
+- Allow overriding tool properties via configuration ([#69](https://github.com/opensearch-project/opensearch-mcp-server-py/pull/69))
 - Extend list indices tool ([#68](https://github.com/opensearch-project/opensearch-mcp-server-py/pull/68))
 - Add `OPENSEARCH_NO_AUTH` environment variable for connecting to clusters without authentication
 

USER_GUIDE.md

@@ -10,6 +10,7 @@
 - [Authentication](#authentication)
 - [Running the Server](#running-the-server)
 - [Tool Filter](#tool-filter)
+- [Tool Customization](#tool-customization)
 - [LangChain Integration](#langchain-integration)
 
 ## Overview
@@ -99,15 +100,15 @@ See [Authentication](#authentication) section for detailed authentication setup.
       "args": [
         "opensearch-mcp-server-py",
         "--mode", "multi",
-        "--config", "/path/to/your/clusters.yml"
+        "--config", "/path/to/your/config.yml"
       ],
       "env": {}
     }
   }
 }
 ```
 
-**Example YAML Configuration File (`clusters.yml`):**
+**Example YAML Configuration File (`config.yml`):**
 ```yaml
 version: "1.0"
 description: "OpenSearch cluster configurations"
@@ -137,6 +138,15 @@ clusters:
     profile: "your-aws-profile"
     is_serverless: true
 
+# Tool customization configurations (supported in both Single and Multi Mode)
+tools:
+  ListIndexTool:
+    display_name: "Index Manager"
+    description: "List and manage OpenSearch indices with enhanced functionality"
+  SearchIndexTool:
+    display_name: "Super Searcher"
+  GetShardsTool:
+    description: "Retrieve detailed information about OpenSearch shards"
 ```
 
 **Key Points about Multi Mode:**
@@ -346,13 +356,13 @@ python -m mcp_server_opensearch --profile my-aws-profile
 ### Multi Mode
 ```bash
 # Stdio Server with config file
-python -m mcp_server_opensearch --mode multi --config clusters.yml
+python -m mcp_server_opensearch --mode multi --config config.yml
 
 # Streaming Server with config file
-python -m mcp_server_opensearch --mode multi --config clusters.yml --transport stream
+python -m mcp_server_opensearch --mode multi --config config.yml --transport stream
 
 # With AWS Profile (fallback if not in config)
-python -m mcp_server_opensearch --mode multi --config clusters.yml --profile my-aws-profile
+python -m mcp_server_opensearch --mode multi --config config.yml --profile my-aws-profile
 
 # Fallback to single mode behavior (no config file)
 python -m mcp_server_opensearch --mode multi
@@ -436,6 +446,8 @@ When using multi-mode, each cluster in your YAML configuration file accepts the
 
 OpenSearch MCP server supports tool filtering to disable specific tools by name, category, or operation type. You can configure filtering using either a YAML configuration file or environment variables.
 
+**Important Note: Tool filtering is only supported in Single Mode. In Multi Mode, all tools are available without any filtering.**
+
 ### Configuration Methods
 
 1. YAML Configuration File
@@ -495,6 +507,46 @@ export OPENSEARCH_SETTINGS_ALLOW_WRITE=true
 - When both config file and environment variables are provided, the config file will be prioritized
 - Tool filtering is only supported in single mode. In multi mode, tool filtering is not supported
 
+## Tool Customization
+
+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.
+
+### Configuration Methods
+
+1. **YAML Configuration File**
+
+Create a YAML file with your tool customization settings:
+```yaml
+tools:
+  ListIndexTool:
+    display_name: "Index Manager"
+    description: "List and manage OpenSearch indices"
+  GetShardsTool:
+    description: "Retrieve detailed information about OpenSearch shards"
+```
+
+Use the configuration file when starting the server:
+```bash
+python -m mcp_server_opensearch --config path/to/config.yml
+```
+
+2. **Runtime Parameters**
+
+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"
+```
+
+### Priority
+
+Runtime parameters have higher priority than configuration file settings. If both are provided, runtime parameters will override the corresponding values in the configuration file.
+
+### Important Notes
+- Tool customization is available in both single and multi modes
+- Only existing tools can be customized; new tools cannot be created
+- Changes take effect immediately when the server starts
+- Invalid tool names or properties will be ignored
+
 ## LangChain Integration
 
 The OpenSearch MCP server can be easily integrated with LangChain using the SSE server transport.

example_clusters.yml

@@ -0,0 +1,80 @@
+version: "1.0"
+description: "Unified OpenSearch MCP Server Configuration"
+
+# Cluster configurations (used in Multi Mode)
+clusters:
+  local-cluster:
+    opensearch_url: "http://localhost:9200"
+    opensearch_username: "admin"
+    opensearch_password: "your_password_here"
+
+  remote-cluster:
+    opensearch_url: "https://your-opensearch-domain.us-east-2.es.amazonaws.com"
+    profile: "your-aws-profile"
+  
+  remote-cluster-with-iam:
+    opensearch_url: "https://your-opensearch-domain.us-east-2.es.amazonaws.com"
+    iam_arn: "arn:aws:iam::123456789012:role/YourOpenSearchRole"
+    aws_region: "us-east-2"
+    profile: "your-aws-profile"
+
+  serverless-cluster:
+    opensearch_url: "https://collection-id.us-east-1.aoss.amazonaws.com"
+    aws_region: "us-east-1"
+    profile: "your-aws-profile"
+    is_serverless: true
+
+# Tool customization configurations (supported in both Single and Multi Mode)
+tools:
+  ListIndexTool:
+    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"
+  GetShardsTool:
+    description: "A better description to get information about shards in OpenSearch."
+
+# ==============================================================================
+# Tool filtering configurations (ONLY supported in Single Mode)
+# ==============================================================================
+# Note: These sections are ignored in Multi Mode. Tool filtering only works
+# when using Single Mode (--mode single or default mode).
+# Uncomment the sections below if you're using Single Mode and want to filter tools.
+
+# tool_category:
+#   search_tools:
+#     - "SearchIndexTool"
+#     - "MsearchTool"
+#   management_tools:
+#     - "ListIndexTool"
+#     - "CreateIndexTool"
+#     - "DeleteIndexTool"
+
+# tool_filters:
+#   disabled_tools:
+#     - "DangerousTool"  # Example: disable dangerous tools
+#   disabled_categories:
+#     - "experimental_tools"  # Example: disable experimental tool category  
+#   disabled_tools_regex:
+#     - "debug.*"  # Example: disable all tools starting with debug
+#   settings:
+#     allow_write: true  # Enable/disable write operations
+
+
+# Example configurations for different authentication methods:
+# 
+# 1. IAM Role Authentication (recommended for production):
+#    - Requires: opensearch_url, iam_arn, aws_region, profile
+#    - Uses AWS IAM roles for authentication
+#
+# 2. Basic Authentication:
+#    - Requires: opensearch_url, opensearch_username, opensearch_password
+#    - Uses username/password for authentication
+#
+# 3. AWS Profile Authentication:
+#    - Requires: opensearch_url, profile
+#    - Uses AWS credentials from the specified profile
+#
+# 4. OpenSearch Serverless:
+#    - Requires: opensearch_url, aws_region
+#    - Optional: profile, is_serverless: true 

example_config.yml

@@ -1,19 +1,36 @@
 # Copyright OpenSearch Contributors
 # SPDX-License-Identifier: Apache-2.0
 
+import argparse
+import asyncio
+import logging
+from typing import Dict, List
+
 from .stdio_server import serve as serve_stdio
 from .streaming_server import serve as serve_streaming
 
 
+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('--')}
+
+    for key in arg_keys:
+        parser.add_argument(key)
+
+    try:
+        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}")
+        return {}
+
+
 def main() -> None:
     """
     Main entry point for the OpenSearch MCP Server.
     Handles command line arguments and starts the appropriate server based on transport type.
     """
-    import argparse
-    import asyncio
-    import logging
-
     # Configure logging
     logging.basicConfig(
         level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
@@ -43,21 +60,35 @@ def main() -> None:
     parser.add_argument(
         '--profile', default='', help='AWS profile to use for OpenSearch connection'
     )
-    parser.add_argument('--config', default='', help='Path to a YAML configuration file')
+    parser.add_argument(
+        '--config',
+        dest='config_file_path',
+        default='',
+        help='Path to a YAML configuration file',
+    )
 
-    args = parser.parse_args()
+    args, unknown = parser.parse_known_args()
+    cli_tool_overrides = parse_unknown_args_to_dict(unknown)
 
     # Start the appropriate server based on transport type
     if args.transport == 'stdio':
-        asyncio.run(serve_stdio(mode=args.mode, profile=args.profile, config=args.config))
+        asyncio.run(
+            serve_stdio(
+                mode=args.mode,
+                profile=args.profile,
+                config_file_path=args.config_file_path,
+                cli_tool_overrides=cli_tool_overrides,
+            )
+        )
     else:
         asyncio.run(
             serve_streaming(
                 host=args.host,
                 port=args.port,
                 mode=args.mode,
                 profile=args.profile,
-                config=args.config,
+                config_file_path=args.config_file_path,
+                cli_tool_overrides=cli_tool_overrides,
             )
         )
 

src/mcp_server_opensearch/__init__.py

@@ -8,10 +8,17 @@
 from mcp_server_opensearch.clusters_information import load_clusters_from_yaml
 from tools.tool_filter import get_tools
 from tools.tool_generator import generate_tools_from_openapi
+from tools.tools import TOOL_REGISTRY
+from tools.config import apply_custom_tool_config
 
 
 # --- Server setup ---
-async def serve(mode: str = 'single', profile: str = '', config: str = '') -> None:
+async def serve(
+    mode: str = 'single',
+    profile: str = '',
+    config_file_path: str = '',
+    cli_tool_overrides: dict = None,
+) -> None:
     # Set the global profile if provided
     if profile:
         from opensearch.client import set_profile
@@ -21,11 +28,16 @@ async def serve(mode: str = 'single', profile: str = '', config: str = '') -> No
     server = Server('opensearch-mcp-server')
     # Load clusters from YAML file
     if mode == 'multi':
-        load_clusters_from_yaml(config)
+        load_clusters_from_yaml(config_file_path)
 
     # Call tool generator and tool filter
     await generate_tools_from_openapi()
-    enabled_tools = get_tools(mode, config)
+    customized_registry = apply_custom_tool_config(
+        TOOL_REGISTRY, config_file_path, cli_tool_overrides or {}
+    )
+    enabled_tools = get_tools(
+        tool_registry=customized_registry, mode=mode, config_file_path=config_file_path
+    )
     logging.info(f'Enabled tools: {list(enabled_tools.keys())}')
 
     @server.list_tools()
@@ -34,7 +46,7 @@ async def list_tools() -> list[Tool]:
         for tool_name, tool_info in enabled_tools.items():
             tools.append(
                 Tool(
-                    name=tool_name,
+                    name=tool_info.get('display_name', tool_name),
                     description=tool_info['description'],
                     inputSchema=tool_info['input_schema'],
                 )
@@ -43,9 +55,17 @@ async def list_tools() -> list[Tool]:
 
     @server.call_tool()
     async def call_tool(name: str, arguments: dict) -> list[TextContent]:
-        tool = enabled_tools.get(name)
-        if not tool:
+        # Find the tool by its display name, which is what the client sees
+        found_tool_key = None
+        for key, tool_info in enabled_tools.items():
+            if tool_info.get('display_name', key) == name:
+                found_tool_key = key
+                break
+
+        if not found_tool_key:
             raise ValueError(f'Unknown or disabled tool: {name}')
+
+        tool = enabled_tools.get(found_tool_key)
         parsed = tool['args_model'](**arguments)
         return await tool['function'](parsed)