Add displayName and editing UUIDs for virtual servers

Signed-off-by: Mihai Criveti <[email protected]>

Author: crivetimihai

mcpgateway/alembic/versions/733159a4fa74_add_display_name_to_tools.py

@@ -22,10 +22,32 @@
 
 
 def upgrade() -> None:
-    """Add display_name column to tools table."""
+    """Add display_name column to tools table and populate smart defaults for existing tools."""
     bind = op.get_bind()
     inspector = sa.inspect(bind)
 
+    def generate_display_name(technical_name: str) -> str:
+        """Generate display name from technical name.
+
+        Args:
+            technical_name: The technical tool name
+
+        Returns:
+            str: Human-readable display name
+        """
+        # Standard
+        import re
+
+        if not technical_name:
+            return ""
+        # Replace underscores, hyphens, and dots with spaces
+        display_name = re.sub(r"[_\-\.]+", " ", technical_name)
+        # Remove extra whitespace and title case
+        display_name = " ".join(display_name.split())
+        if display_name:
+            display_name = display_name.title()
+        return display_name
+
     # Check if this is a fresh database without existing tables
     if not inspector.has_table("tools"):
         print("Tools table not found. Skipping display_name migration.")
@@ -34,8 +56,27 @@ def upgrade() -> None:
     # Check if column already exists
     tools_columns = [col["name"] for col in inspector.get_columns("tools")]
     if "display_name" not in tools_columns:
+        # Add the column first
         op.add_column("tools", sa.Column("display_name", sa.String(), nullable=True))
         print("Added display_name column to tools table.")
+
+        # Populate smart displayName for existing tools that don't have one
+        connection = bind
+        result = connection.execute(sa.text("SELECT id, original_name, custom_name FROM tools WHERE display_name IS NULL"))
+        tools_to_update = result.fetchall()
+
+        for tool in tools_to_update:
+            # Use custom_name if available, otherwise original_name
+            source_name = tool.custom_name if tool.custom_name else tool.original_name
+            smart_display_name = generate_display_name(source_name)
+
+            # Update only tools without existing display_name
+            connection.execute(sa.text("UPDATE tools SET display_name = :display_name WHERE id = :tool_id AND display_name IS NULL"), {"display_name": smart_display_name, "tool_id": tool.id})
+
+        if tools_to_update:
+            print(f"Populated smart displayName for {len(tools_to_update)} existing tools.")
+
+        connection.commit()
     else:
         print("display_name column already exists in tools table.")
 

mcpgateway/schemas.py

@@ -372,6 +372,9 @@ def validate_name(cls, v: str) -> str:
         Returns:
             str: Value if validated as safe
 
+        Raises:
+            ValueError: When displayName contains unsafe content or exceeds length limits
+
         Examples:
             >>> from mcpgateway.schemas import ToolCreate
             >>> ToolCreate.validate_name('valid_tool')
@@ -394,6 +397,9 @@ def validate_url(cls, v: str) -> str:
         Returns:
             str: Value if validated as safe
 
+        Raises:
+            ValueError: When displayName contains unsafe content or exceeds length limits
+
         Examples:
             >>> from mcpgateway.schemas import ToolCreate
             >>> ToolCreate.validate_url('https://example.com')
@@ -445,6 +451,9 @@ def validate_display_name(cls, v: Optional[str]) -> Optional[str]:
         Returns:
             str: Value if validated as safe
 
+        Raises:
+            ValueError: When displayName contains unsafe content or exceeds length limits
+
         Examples:
             >>> from mcpgateway.schemas import ToolCreate
             >>> ToolCreate.validate_display_name('My Custom Tool')
@@ -857,6 +866,9 @@ def validate_display_name(cls, v: Optional[str]) -> Optional[str]:
         Returns:
             str: Value if validated as safe
 
+        Raises:
+            ValueError: When displayName contains unsafe content or exceeds length limits
+
         Examples:
             >>> from mcpgateway.schemas import ToolUpdate
             >>> ToolUpdate.validate_display_name('My Custom Tool')
@@ -2866,6 +2878,9 @@ def validate_id(cls, v: Optional[str]) -> Optional[str]:
         Returns:
             str: Value if validated as safe
 
+        Raises:
+            ValueError: When displayName contains unsafe content or exceeds length limits
+
         Examples:
             >>> from mcpgateway.schemas import ServerCreate
             >>> ServerCreate.validate_id('550e8400-e29b-41d4-a716-446655440000')
@@ -2987,6 +3002,9 @@ def validate_id(cls, v: Optional[str]) -> Optional[str]:
         Returns:
             str: Value if validated as safe
 
+        Raises:
+            ValueError: When displayName contains unsafe content or exceeds length limits
+
         Examples:
             >>> from mcpgateway.schemas import ServerUpdate
             >>> ServerUpdate.validate_id('550e8400-e29b-41d4-a716-446655440000')

mcpgateway/services/gateway_service.py

@@ -82,6 +82,7 @@
 from mcpgateway.services.oauth_manager import OAuthManager
 from mcpgateway.services.tool_service import ToolService
 from mcpgateway.utils.create_slug import slugify
+from mcpgateway.utils.display_name import generate_display_name
 from mcpgateway.utils.retry_manager import ResilientHttpClient
 from mcpgateway.utils.services_auth import decode_auth, encode_auth
 
@@ -469,7 +470,7 @@ async def register_gateway(
                     original_name=tool.name,
                     custom_name=tool.name,
                     custom_name_slug=slugify(tool.name),
-                    display_name=tool.name,
+                    display_name=generate_display_name(tool.name),
                     url=normalized_url,
                     description=tool.description,
                     integration_type="MCP",  # Gateway-discovered tools are MCP type
@@ -656,7 +657,7 @@ async def fetch_tools_after_oauth(self, db: Session, gateway_id: str) -> Dict[st
                             original_name=tool.name,
                             custom_name=tool.name,
                             custom_name_slug=slugify(tool.name),
-                            display_name=tool.name,
+                            display_name=generate_display_name(tool.name),
                             url=gateway.url.rstrip("/"),
                             description=tool.description,
                             integration_type="MCP",  # Gateway-discovered tools are MCP type
@@ -842,7 +843,7 @@ async def update_gateway(self, db: Session, gateway_id: str, gateway_update: Gat
                                         original_name=tool.name,
                                         custom_name=tool.custom_name,
                                         custom_name_slug=slugify(tool.custom_name),
-                                        display_name=tool.custom_name,
+                                        display_name=generate_display_name(tool.custom_name),
                                         url=gateway.url,
                                         description=tool.description,
                                         integration_type="MCP",  # Gateway-discovered tools are MCP type
@@ -1031,7 +1032,7 @@ async def toggle_gateway_status(self, db: Session, gateway_id: str, activate: bo
                                         original_name=tool.name,
                                         custom_name=tool.custom_name,
                                         custom_name_slug=slugify(tool.custom_name),
-                                        display_name=tool.custom_name,
+                                        display_name=generate_display_name(tool.custom_name),
                                         url=gateway.url,
                                         description=tool.description,
                                         integration_type="MCP",  # Gateway-discovered tools are MCP type

mcpgateway/services/tool_service.py

@@ -48,6 +48,7 @@
 from mcpgateway.services.logging_service import LoggingService
 from mcpgateway.services.oauth_manager import OAuthManager
 from mcpgateway.utils.create_slug import slugify
+from mcpgateway.utils.display_name import generate_display_name
 from mcpgateway.utils.metrics_common import build_top_performers
 from mcpgateway.utils.passthrough_headers import get_passthrough_headers
 from mcpgateway.utils.retry_manager import ResilientHttpClient
@@ -1340,7 +1341,7 @@ async def create_tool_from_a2a_agent(
         # Create tool entry for the A2A agent
         tool_data = ToolCreate(
             name=tool_name,
-            displayName=f"A2A: {agent.name}",
+            displayName=generate_display_name(agent.name),
             url=agent.endpoint_url,
             description=f"A2A Agent: {agent.description or agent.name}",
             integration_type="A2A",  # Special integration type for A2A agents

mcpgateway/static/admin.js

@@ -5469,7 +5469,10 @@ async function viewTool(toolId) {
                 }
             };
 
-            setTextSafely(".tool-display-name", tool.displayName || tool.customName || tool.name);
+            setTextSafely(
+                ".tool-display-name",
+                tool.displayName || tool.customName || tool.name,
+            );
             setTextSafely(".tool-name", tool.name);
             setTextSafely(".tool-url", tool.url);
             setTextSafely(".tool-type", tool.integrationType);

mcpgateway/utils/display_name.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+"""Location: ./mcpgateway/utils/display_name.py
+Copyright 2025
+SPDX-License-Identifier: Apache-2.0
+Authors: Mihai Criveti
+
+Display Name Utilities.
+This module provides utilities for converting technical tool names to user-friendly display names.
+
+Examples:
+    >>> from mcpgateway.utils.display_name import generate_display_name
+    >>> generate_display_name("duckduckgo_search")
+    'Duckduckgo Search'
+    >>> generate_display_name("weather-api")
+    'Weather Api'
+    >>> generate_display_name("get_user.profile")
+    'Get User Profile'
+"""
+
+# Standard
+import re
+
+
+def generate_display_name(technical_name: str) -> str:
+    """Convert technical tool name to human-readable display name.
+
+    Converts underscores, hyphens, and dots to spaces, then capitalizes the first letter.
+
+    Args:
+        technical_name: The technical tool name (e.g., "duckduckgo_search")
+
+    Returns:
+        str: Human-readable display name (e.g., "Duckduckgo Search")
+
+    Examples:
+        >>> generate_display_name("duckduckgo_search")
+        'Duckduckgo Search'
+        >>> generate_display_name("weather-api")
+        'Weather Api'
+        >>> generate_display_name("get_user.profile")
+        'Get User Profile'
+        >>> generate_display_name("simple_tool")
+        'Simple Tool'
+        >>> generate_display_name("UPPER_CASE")
+        'Upper Case'
+        >>> generate_display_name("mixed_Case-Name.test")
+        'Mixed Case Name Test'
+        >>> generate_display_name("")
+        ''
+        >>> generate_display_name("single")
+        'Single'
+        >>> generate_display_name("multiple___underscores")
+        'Multiple Underscores'
+        >>> generate_display_name("tool_with-mixed.separators")
+        'Tool With Mixed Separators'
+    """
+    if not technical_name:
+        return ""
+
+    # Replace underscores, hyphens, and dots with spaces
+    display_name = re.sub(r"[_\-\.]+", " ", technical_name)
+
+    # Remove extra whitespace and capitalize first letter
+    display_name = " ".join(display_name.split())  # Normalize whitespace
+
+    if display_name:
+        # Capitalize each word (title case)
+        display_name = display_name.title()
+
+    return display_name

mcpgateway/validators.py

@@ -51,8 +51,8 @@
 import html
 import logging
 import re
-import uuid
 from urllib.parse import urlparse
+import uuid
 
 # First-Party
 from mcpgateway.config import settings
@@ -283,17 +283,17 @@ def validate_tool_name(cls, value: str) -> str:
     @classmethod
     def validate_uuid(cls, value: str, field_name: str = "UUID") -> str:
         """Validate UUID format
-        
+
         Args:
             value (str): Value to validate
             field_name (str): Name of field being validated
-            
+
         Returns:
             str: Value if validated as safe
-            
+
         Raises:
             ValueError: When value is not a valid UUID
-            
+
         Examples:
             >>> SecurityValidator.validate_uuid('550e8400-e29b-41d4-a716-446655440000')
             '550e8400-e29b-41d4-a716-446655440000'
@@ -304,7 +304,7 @@ def validate_uuid(cls, value: str, field_name: str = "UUID") -> str:
         """
         if not value:
             return value
-            
+
         try:
             # Validate UUID format by attempting to parse it
             uuid_obj = uuid.UUID(value)