Pylint improvements (#239)

* Pylint cli

* Pylint sampling

* Pylint schemas

* Pyling completion_services

* Pylint resource_service

* Pylint streamablehttp_transport

* Pylint websocket_transport

* Pylint mcpgateway/admin.py

* Pylint mcpgateway/federation/discovery.py

* Pylint mcpgateway/federation/forward.py

* Pylint mcpgateway/federation/manager.py

* Pylint mcpgateway/services/prompt_service.py

* Pylint mcpgateway/services/server_service.py

* Pylint mcpgateway/services/tool_service.py

* Pylint mcpgateway/transports/sse_transport.py

* Pylint mcpgateway/version.py

* Pylint mcpgateway/wrapper.py

* Remove unneccessary pylint ignore comments

* Load pylint-pydantic plugin in .pylintrc

---------

Co-authored-by: Sebastian <[email protected]>

Author: ChrisPC-39

.pylintrc

@@ -81,7 +81,7 @@ limit-inference-results=100
 
 # List of plugins (as comma separated values of python module names) to load,
 # usually to register additional checkers.
-load-plugins=
+load-plugins=pylint_pydantic
 
 # Pickle collected data for later comparisons.
 persistent=yes

mcpgateway/admin.py

@@ -22,6 +22,11 @@
 import logging
 from typing import Any, Dict, List, Union
 
+# Third-Party
+from fastapi import APIRouter, Depends, HTTPException, Request
+from fastapi.responses import HTMLResponse, JSONResponse, RedirectResponse
+from sqlalchemy.orm import Session
+
 # First-Party
 from mcpgateway.config import settings
 from mcpgateway.db import get_db
@@ -59,11 +64,6 @@
 from mcpgateway.utils.create_jwt_token import get_jwt_token
 from mcpgateway.utils.verify_credentials import require_auth, require_basic_auth
 
-# Third-Party
-from fastapi import APIRouter, Depends, HTTPException, Request
-from fastapi.responses import HTMLResponse, JSONResponse, RedirectResponse
-from sqlalchemy.orm import Session
-
 # Initialize services
 server_service = ServerService()
 tool_service = ToolService()

mcpgateway/cli.py

@@ -41,12 +41,12 @@
 import sys
 from typing import List
 
-# First-Party
-from mcpgateway import __version__
-
 # Third-Party
 import uvicorn
 
+# First-Party
+from mcpgateway import __version__
+
 # ---------------------------------------------------------------------------
 # Configuration defaults (overridable via environment variables)
 # ---------------------------------------------------------------------------

mcpgateway/federation/discovery.py

@@ -23,15 +23,15 @@
 from typing import Dict, List, Optional
 from urllib.parse import urlparse
 
-# First-Party
-from mcpgateway.config import settings
-from mcpgateway.types import ServerCapabilities
-
 # Third-Party
 import httpx
 from zeroconf import ServiceInfo, ServiceStateChange
 from zeroconf.asyncio import AsyncServiceBrowser, AsyncZeroconf
 
+# First-Party
+from mcpgateway.config import settings
+from mcpgateway.types import ServerCapabilities
+
 logger = logging.getLogger(__name__)
 
 PROTOCOL_VERSION = os.getenv("PROTOCOL_VERSION", "2025-03-26")

mcpgateway/federation/forward.py

@@ -19,17 +19,17 @@
 import logging
 from typing import Any, Dict, List, Optional, Set, Tuple, Union
 
+# Third-Party
+import httpx
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
 # First-Party
 from mcpgateway.config import settings
 from mcpgateway.db import Gateway as DbGateway
 from mcpgateway.db import Tool as DbTool
 from mcpgateway.types import ToolResult
 
-# Third-Party
-import httpx
-from sqlalchemy import select
-from sqlalchemy.orm import Session
-
 logger = logging.getLogger(__name__)
 
 

mcpgateway/federation/manager.py

@@ -23,6 +23,11 @@
 import os
 from typing import Any, Dict, List, Optional, Set
 
+# Third-Party
+import httpx
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
 # First-Party
 from mcpgateway.config import settings
 from mcpgateway.db import Gateway as DbGateway
@@ -39,11 +44,6 @@
     Tool,
 )
 
-# Third-Party
-import httpx
-from sqlalchemy import select
-from sqlalchemy.orm import Session
-
 logger = logging.getLogger(__name__)
 
 PROTOCOL_VERSION = os.getenv("PROTOCOL_VERSION", "2025-03-26")

mcpgateway/handlers/sampling.py

@@ -13,11 +13,12 @@
 import logging
 from typing import Any, Dict, List
 
+# Third-Party
+from sqlalchemy.orm import Session
+
 # First-Party
 from mcpgateway.types import CreateMessageResult, ModelPreferences, Role, TextContent
 
-# Third-Party
-from sqlalchemy.orm import Session
 
 logger = logging.getLogger(__name__)
 
@@ -94,6 +95,7 @@ async def create_message(self, db: Session, request: Dict[str, Any]) -> CreateMe
                 if not self._validate_message(msg):
                     raise SamplingError(f"Invalid message format: {msg}")
 
+            # pylint: disable=fixme
             # TODO: Sample from selected model
             # For now return mock response
             response = self._mock_sample(messages=messages)
@@ -160,6 +162,7 @@ async def _add_context(self, _db: Session, messages: List[Dict[str, Any]], _cont
         Returns:
             Messages with added context
         """
+        # pylint: disable=fixme
         # TODO: Implement context gathering based on type
         # For now return original messages
         return messages

mcpgateway/schemas.py

@@ -26,6 +26,9 @@
 import logging
 from typing import Any, Dict, List, Literal, Optional, Union
 
+# Third-Party
+from pydantic import AnyHttpUrl, BaseModel, ConfigDict, Field, field_serializer, field_validator, model_validator, ValidationInfo
+
 # First-Party
 from mcpgateway.types import ImageContent
 from mcpgateway.types import Prompt as MCPPrompt
@@ -34,9 +37,6 @@
 from mcpgateway.types import Tool as MCPTool
 from mcpgateway.utils.services_auth import decode_auth, encode_auth
 
-# Third-Party
-from pydantic import AnyHttpUrl, BaseModel, ConfigDict, Field, field_serializer, field_validator, model_validator, ValidationInfo
-
 logger = logging.getLogger(__name__)
 
 
@@ -519,7 +519,17 @@ class ResourceNotification(BaseModelWithConfigDict):
 
     @field_serializer("timestamp")
     def serialize_timestamp(self, dt: datetime) -> str:
-        # now returns ISO string with Z
+        """Serialize the `timestamp` field as an ISO 8601 string with UTC timezone.
+
+        Converts the given datetime to UTC and returns it in ISO 8601 format,
+        replacing the "+00:00" suffix with "Z" to indicate UTC explicitly.
+
+        Args:
+            dt (datetime): The datetime object to serialize.
+
+        Returns:
+            str: ISO 8601 formatted string in UTC, ending with 'Z'.
+        """
         return dt.astimezone(timezone.utc).isoformat().replace("+00:00", "Z")
 
 
@@ -1020,7 +1030,18 @@ class EventMessage(BaseModelWithConfigDict):
 
     @field_serializer("timestamp")
     def serialize_timestamp(self, dt: datetime) -> str:
-        # now returns ISO string with Z
+        """
+        Serialize the `timestamp` field as an ISO 8601 string with UTC timezone.
+
+        Converts the given datetime to UTC and returns it in ISO 8601 format,
+        replacing the "+00:00" suffix with "Z" to indicate UTC explicitly.
+
+        Args:
+            dt (datetime): The datetime object to serialize.
+
+        Returns:
+            str: ISO 8601 formatted string in UTC, ending with 'Z'.
+        """
         return dt.astimezone(timezone.utc).isoformat().replace("+00:00", "Z")
 
 

mcpgateway/services/completion_service.py

@@ -13,15 +13,15 @@
 import logging
 from typing import Any, Dict, List
 
+# Third-Party
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
 # First-Party
 from mcpgateway.db import Prompt as DbPrompt
 from mcpgateway.db import Resource as DbResource
 from mcpgateway.types import CompleteResult
 
-# Third-Party
-from sqlalchemy import select
-from sqlalchemy.orm import Session
-
 logger = logging.getLogger(__name__)
 
 

mcpgateway/services/prompt_service.py

@@ -21,18 +21,18 @@
 from string import Formatter
 from typing import Any, AsyncGenerator, Dict, List, Optional, Set
 
-# First-Party
-from mcpgateway.db import Prompt as DbPrompt
-from mcpgateway.db import PromptMetric, server_prompt_association
-from mcpgateway.schemas import PromptCreate, PromptRead, PromptUpdate
-from mcpgateway.types import Message, PromptResult, Role, TextContent
-
 # Third-Party
 from jinja2 import Environment, meta, select_autoescape
 from sqlalchemy import delete, func, not_, select
 from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm import Session
 
+# First-Party
+from mcpgateway.db import Prompt as DbPrompt
+from mcpgateway.db import PromptMetric, server_prompt_association
+from mcpgateway.schemas import PromptCreate, PromptRead, PromptUpdate
+from mcpgateway.types import Message, PromptResult, Role, TextContent
+
 logger = logging.getLogger(__name__)