Make gateway slug use config value (#439)

* fixed gateway separator issue

Signed-off-by: Madhav Kandukuri <[email protected]>

* Fix pylint and fail a test
Signed-off-by: Madhav Kandukuri <[email protected]>

* linting fixes

Signed-off-by: Madhav Kandukuri <[email protected]>

* Linting fixes
Signed-off-by: Madhav Kandukuri <[email protected]>

* Flake8 fixes
Signed-off-by: Madhav Kandukuri <[email protected]>

* Ruff fixes
Signed-off-by: Madhav Kandukuri <[email protected]>

* Fix REST tool addition
Signed-off-by: Madhav Kandukuri <[email protected]>

* Fix REST tool name
Signed-off-by: Madhav Kandukuri <[email protected]>

* Allow dot in tool names
Signed-off-by: Madhav Kandukuri <[email protected]>

* Linting fixes
Signed-off-by: Madhav Kandukuri <[email protected]>

---------

Signed-off-by: Madhav Kandukuri <[email protected]>

Author: madhav165

.env.example

@@ -263,3 +263,4 @@ DEBUG=false
 
 # Gateway tool name separator
 GATEWAY_TOOL_NAME_SEPARATOR=-
+VALID_SLUG_SEPARATOR_REGEXP= r"^(-{1,2}|[_.])$"

.flake8

@@ -1,2 +1,4 @@
 [flake8]
 max-line-length = 600
+per-file-ignores =
+    mcpgateway/services/gateway_service.py: DAR401,DAR402

mcpgateway/alembic/versions/b77ca9d2de7e_uuid_pk_and_slug_refactor.py

@@ -12,9 +12,9 @@
 import uuid
 
 # Third-Party
-from alembic import op
 import sqlalchemy as sa
 from sqlalchemy.orm import Session
+from alembic import op
 
 # First-Party
 from mcpgateway.config import settings

mcpgateway/alembic/versions/e4fc04d1a442_add_annotations_to_tables.py

@@ -11,8 +11,8 @@
 from typing import Sequence, Union
 
 # Third-Party
-from alembic import op
 import sqlalchemy as sa
+from alembic import op
 
 # revision identifiers, used by Alembic.
 revision: str = "e4fc04d1a442"

mcpgateway/alembic/versions/e75490e949b1_add_improved_status_to_tables.py

@@ -10,9 +10,8 @@
 from typing import Sequence, Union
 
 # Third-Party
-# Alembic / SQLAlchemy
-from alembic import op
 import sqlalchemy as sa
+from alembic import op
 
 # Revision identifiers.
 revision: str = "e75490e949b1"

mcpgateway/bootstrap_db.py

@@ -25,9 +25,9 @@
 import logging
 
 # Third-Party
+from sqlalchemy import create_engine, inspect
 from alembic import command
 from alembic.config import Config
-from sqlalchemy import create_engine, inspect
 
 # First-Party
 from mcpgateway.config import settings

mcpgateway/config.py

@@ -50,8 +50,10 @@
 from functools import lru_cache
 from importlib.resources import files
 import json
+import logging
 from pathlib import Path
-from typing import Annotated, Any, Dict, List, Optional, Set, Union
+import re
+from typing import Annotated, Any, Dict, List, Optional, Set, Union, ClassVar
 
 # Third-Party
 from fastapi import HTTPException
@@ -61,6 +63,14 @@
 from pydantic import field_validator
 from pydantic_settings import BaseSettings, NoDecode, SettingsConfigDict
 
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    datefmt="%H:%M:%S",
+)
+
+logger = logging.getLogger(__name__)
+
 
 class Settings(BaseSettings):
     """
@@ -237,6 +247,26 @@ def _parse_federation_peers(cls, v):
     model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8", case_sensitive=False, extra="ignore")
 
     gateway_tool_name_separator: str = "-"
+    valid_slug_separator_regexp: ClassVar[str] = r"^(-{1,2}|[_.])$"
+
+    @field_validator("gateway_tool_name_separator")
+    @classmethod
+    def must_be_allowed_sep(cls, v: str) -> str:
+        """Validate the gateway tool name separator.
+
+        Args:
+            v: The separator value to validate.
+
+        Returns:
+            The validated separator, defaults to '-' if invalid.
+        """
+        if not re.fullmatch(cls.valid_slug_separator_regexp, v):
+            logger.warning(
+                f"Invalid gateway_tool_name_separator '{v}'. Must be '-', '--', '_' or '.'. Defaulting to '-'.",
+                stacklevel=2,
+            )
+            return "-"
+        return v
 
     @property
     def api_key(self) -> str:
@@ -393,11 +423,11 @@ def validate_database(self) -> None:
     validation_allowed_url_schemes: List[str] = ["http://", "https://", "ws://", "wss://"]
 
     # Character validation patterns
-    validation_name_pattern: str = r"^[a-zA-Z0-9_\-\s]+$"  # Allow spaces for names
+    validation_name_pattern: str = r"^[a-zA-Z0-9_.\-\s]+$"  # Allow spaces for names
     validation_identifier_pattern: str = r"^[a-zA-Z0-9_\-\.]+$"  # No spaces for IDs
     validation_safe_uri_pattern: str = r"^[a-zA-Z0-9_\-.:/?=&%]+$"
     validation_unsafe_uri_pattern: str = r'[<>"\'\\]'
-    validation_tool_name_pattern: str = r"^[a-zA-Z][a-zA-Z0-9_-]*$"  # MCP tool naming
+    validation_tool_name_pattern: str = r"^[a-zA-Z][a-zA-Z0-9._-]*$"  # MCP tool naming
 
     # MCP-compliant size limits (configurable via env)
     validation_max_name_length: int = 255

mcpgateway/db.py

@@ -21,7 +21,6 @@
 
 # Standard
 from datetime import datetime, timezone
-import re
 from typing import Any, Dict, List, Optional
 import uuid
 
@@ -62,6 +61,8 @@
 from mcpgateway.models import ResourceContent
 from mcpgateway.utils.create_slug import slugify
 from mcpgateway.utils.db_isready import wait_for_db_ready
+from mcpgateway.validators import SecurityValidator
+
 
 # ---------------------------------------------------------------------------
 # 1. Parse the URL so we can inspect backend ("postgresql", "sqlite", ...)
@@ -128,35 +129,41 @@ def utc_now() -> datetime:
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 
 
+def refresh_slugs_on_startup():
+    """Refresh slugs for all gateways and names of tools on startup."""
+
+    with SessionLocal() as session:
+        gateways = session.query(Gateway).all()
+        updated = False
+        for gateway in gateways:
+            new_slug = slugify(gateway.name)
+            if gateway.slug != new_slug:
+                gateway.slug = new_slug
+                updated = True
+        if updated:
+            session.commit()
+
+        tools = session.query(Tool).all()
+        for tool in tools:
+            session.expire(tool, ["gateway"])
+
+        updated = False
+        for tool in tools:
+            if tool.gateway:
+                new_name = f"{tool.gateway.slug}{settings.gateway_tool_name_separator}{slugify(tool.original_name)}"
+            else:
+                new_name = slugify(tool.original_name)
+            if tool.name != new_name:
+                tool.name = new_name
+                updated = True
+        if updated:
+            session.commit()
+
+
 class Base(DeclarativeBase):
     """Base class for all models."""
 
 
-# TODO: cleanup, not sure why this is commented out?
-# # Association table for tools and gateways (federation)
-# tool_gateway_table = Table(
-#     "tool_gateway_association",
-#     Base.metadata,
-#     Column("tool_id", String, ForeignKey("tools.id"), primary_key=True),
-#     Column("gateway_id", String, ForeignKey("gateways.id"), primary_key=True),
-# )
-
-# # Association table for resources and gateways (federation)
-# resource_gateway_table = Table(
-#     "resource_gateway_association",
-#     Base.metadata,
-#     Column("resource_id", Integer, ForeignKey("resources.id"), primary_key=True),
-#     Column("gateway_id", String, ForeignKey("gateways.id"), primary_key=True),
-# )
-
-# # Association table for prompts and gateways (federation)
-# prompt_gateway_table = Table(
-#     "prompt_gateway_association",
-#     Base.metadata,
-#     Column("prompt_id", Integer, ForeignKey("prompts.id"), primary_key=True),
-#     Column("gateway_id", String, ForeignKey("gateways.id"), primary_key=True),
-# )
-
 # Association table for servers and tools
 server_tool_association = Table(
     "server_tool_association",
@@ -1168,8 +1175,10 @@ def validate_tool_name(mapper, connection, target):
     _ = mapper
     _ = connection
     if hasattr(target, "name"):
-        if not re.match(r"^[a-zA-Z0-9_-]+$", target.name):
-            raise ValueError(f"Invalid tool name '{target.name}'. Only alphanumeric characters, hyphens, and underscores are allowed.")
+        try:
+            SecurityValidator.validate_tool_name(target.name)
+        except ValueError as e:
+            raise ValueError(f"Invalid tool name: {str(e)}")
 
 
 def validate_prompt_schema(mapper, connection, target):
@@ -1238,3 +1247,34 @@ def init_db():
     wait_for_db_ready(max_tries=int(settings.db_max_retries), interval=int(settings.db_retry_interval_ms) / 1000, sync=True)  # Converting ms to s
 
     init_db()
+
+
+@event.listens_for(Gateway, "before_insert")
+def set_gateway_slug(_mapper, _conn, target):
+    """Set the slug for a Gateway before insert.
+
+    Args:
+        _mapper: Mapper
+        _conn: Connection
+        target: Target Gateway instance
+    """
+
+    target.slug = slugify(target.name)
+
+
+@event.listens_for(Tool, "before_insert")
+def set_tool_name(_mapper, _conn, target):
+    """Set the computed name for a Tool before insert.
+
+    Args:
+        _mapper: Mapper
+        _conn: Connection
+        target: Target Tool instance
+    """
+
+    sep = settings.gateway_tool_name_separator
+    gateway_slug = target.gateway.slug if target.gateway_id else ""
+    if gateway_slug:
+        target.name = f"{gateway_slug}{sep}{slugify(target.original_name)}"
+    else:
+        target.name = slugify(target.original_name)

mcpgateway/main.py

@@ -60,7 +60,7 @@
 from mcpgateway.bootstrap_db import main as bootstrap_db
 from mcpgateway.cache import ResourceCache, SessionRegistry
 from mcpgateway.config import jsonpath_modifier, settings
-from mcpgateway.db import SessionLocal
+from mcpgateway.db import refresh_slugs_on_startup, SessionLocal
 from mcpgateway.handlers.sampling import SamplingHandler
 from mcpgateway.models import (
     InitializeRequest,
@@ -216,6 +216,7 @@ async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
         await sampling_handler.initialize()
         await resource_cache.initialize()
         await streamable_http_session.initialize()
+        refresh_slugs_on_startup()
 
         logger.info("All services initialized successfully")
         yield

mcpgateway/services/gateway_service.py

@@ -20,7 +20,7 @@
 import logging
 import os
 import tempfile
-from typing import Any, AsyncGenerator, Dict, List, Optional, Set
+from typing import Any, AsyncGenerator, Dict, List, Optional, Set, TYPE_CHECKING
 import uuid
 
 # Third-Party
@@ -249,18 +249,26 @@ async def register_gateway(self, db: Session, gateway: GatewayCreate) -> Gateway
             await self._notify_gateway_added(db_gateway)
 
             return GatewayRead.model_validate(gateway)
-        except GatewayConnectionError as ge:
-            logger.error(f"GatewayConnectionError: {ge}")
-            raise ge
-        except ValueError as ve:
-            logger.error(f"ValueError: {ve}")
-            raise ve
-        except RuntimeError as re:
-            logger.error(f"RuntimeError: {re}")
-            raise re
-        except BaseException as other:
-            logger.error(f"Other errors: {other}")
-            raise other
+        except* GatewayConnectionError as ge:
+            if TYPE_CHECKING:
+                ge: ExceptionGroup[GatewayConnectionError]
+            logger.error(f"GatewayConnectionError in group: {ge.exceptions}")
+            raise ge.exceptions[0]
+        except* ValueError as ve:
+            if TYPE_CHECKING:
+                ve: ExceptionGroup[ValueError]
+            logger.error(f"ValueErrors in group: {ve.exceptions}")
+            raise ve.exceptions[0]
+        except* RuntimeError as re:
+            if TYPE_CHECKING:
+                re: ExceptionGroup[RuntimeError]
+            logger.error(f"RuntimeErrors in group: {re.exceptions}")
+            raise re.exceptions[0]
+        except* BaseException as other:  # catches every other sub-exception
+            if TYPE_CHECKING:
+                other: ExceptionGroup[BaseException]
+            logger.error(f"Other grouped errors: {other.exceptions}")
+            raise other.exceptions[0]
 
     async def list_gateways(self, db: Session, include_inactive: bool = False) -> List[GatewayRead]:
         """List all registered gateways.