Added doctests to config and schema modules (#401)

* Added doctests to config and schema modules

Signed-off-by: Manav Gupta <[email protected]>

* Add missing doctest

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

* Add missing doctest

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

---------

Signed-off-by: Manav Gupta <[email protected]>
Signed-off-by: Mihai Criveti <[email protected]>
Co-authored-by: Mihai Criveti <[email protected]>

Author: manavgup

mcpgateway/config.py

@@ -27,6 +27,23 @@
 - TOOL_TIMEOUT: Tool invocation timeout (default: 60)
 - PROMPT_CACHE_SIZE: Max cached prompts (default: 100)
 - HEALTH_CHECK_INTERVAL: Gateway health check interval (default: 60)
+
+Examples:
+    >>> from mcpgateway.config import Settings
+    >>> s = Settings(basic_auth_user='admin', basic_auth_password='secret')
+    >>> s.api_key
+    'admin:secret'
+    >>> s2 = Settings(transport_type='http')
+    >>> s2.validate_transport()  # no error
+    >>> s3 = Settings(transport_type='invalid')
+    >>> try:
+    ...     s3.validate_transport()
+    ... except ValueError as e:
+    ...     print('error')
+    error
+    >>> s4 = Settings(database_url='sqlite:///./test.db')
+    >>> isinstance(s4.database_settings, dict)
+    True
 """
 
 # Standard
@@ -46,7 +63,26 @@
 
 
 class Settings(BaseSettings):
-    """MCP Gateway configuration settings."""
+    """
+    MCP Gateway configuration settings.
+
+    Examples:
+        >>> from mcpgateway.config import Settings
+        >>> s = Settings(basic_auth_user='admin', basic_auth_password='secret')
+        >>> s.api_key
+        'admin:secret'
+        >>> s2 = Settings(transport_type='http')
+        >>> s2.validate_transport()  # no error
+        >>> s3 = Settings(transport_type='invalid')
+        >>> try:
+        ...     s3.validate_transport()
+        ... except ValueError as e:
+        ...     print('error')
+        error
+        >>> s4 = Settings(database_url='sqlite:///./test.db')
+        >>> isinstance(s4.database_settings, dict)
+        True
+    """
 
     # Basic Settings
     app_name: str = "MCP_Gateway"
@@ -207,12 +243,14 @@ def _parse_federation_peers(cls, v):
 
     @property
     def api_key(self) -> str:
-        """Generate API key from auth credentials.
+        """
+        Generate API key from auth credentials.
 
         Returns:
             str: API key string in the format "username:password".
 
         Examples:
+            >>> from mcpgateway.config import Settings
             >>> settings = Settings(basic_auth_user="admin", basic_auth_password="secret")
             >>> settings.api_key
             'admin:secret'
@@ -284,10 +322,17 @@ def supports_sse(self) -> bool:
 
     @property
     def database_settings(self) -> dict:
-        """Get SQLAlchemy database settings.
+        """
+        Get SQLAlchemy database settings.
 
         Returns:
             dict: Dictionary containing SQLAlchemy database configuration options.
+
+        Examples:
+            >>> from mcpgateway.config import Settings
+            >>> s = Settings(database_url='sqlite:///./test.db')
+            >>> isinstance(s.database_settings, dict)
+            True
         """
         return {
             "pool_size": self.db_pool_size,
@@ -316,10 +361,22 @@ def cors_settings(self) -> dict:
         )
 
     def validate_transport(self) -> None:
-        """Validate transport configuration.
+        """
+        Validate transport configuration.
 
         Raises:
             ValueError: If the transport type is not one of the valid options.
+
+        Examples:
+            >>> from mcpgateway.config import Settings
+            >>> s = Settings(transport_type='http')
+            >>> s.validate_transport()  # no error
+            >>> s2 = Settings(transport_type='invalid')
+            >>> try:
+            ...     s2.validate_transport()
+            ... except ValueError as e:
+            ...     print('error')
+            error
         """
         valid_types = {"http", "ws", "sse", "all"}
         if self.transport_type not in valid_types:

mcpgateway/db.py

@@ -10,9 +10,13 @@
 - Resources with subscription tracking
 - Prompts with argument templates
 - Federated gateways with capability tracking
+- Updated to record server associations independently using many-to-many relationships,
+- and to record tool execution metrics.
 
-Updated to record server associations independently using many-to-many relationships,
-and to record tool execution metrics.
+Examples:
+    >>> from mcpgateway.db import connect_args
+    >>> isinstance(connect_args, dict)
+    True
 """
 
 # Standard