Review, rebase and lint

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>

Author: crivetimihai

.env.example

@@ -173,4 +173,4 @@ PLUGINS_CLI_COMPLETION=false
 #  markdown: allow markdown in help strings
 #  disabled: disable markup
 # If unset (commented out), uses "rich" if rich is detected, otherwise disables it.
-PLUGINS_CLI_MARKUP_MODE=rich
+PLUGINS_CLI_MARKUP_MODE=rich

docs/docs/using/plugins/lifecycle.md

@@ -160,4 +160,4 @@ make serve
 ```
 
 !!! note
-        `PLUGINS_ENABLED=true` should be set in your gateway `.env` file.
+        `PLUGINS_ENABLED=true` should be set in your gateway `.env` file.

mcpgateway/plugins/framework/external/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """External plugin which connects to a remote server.
 
 Copyright 2025

mcpgateway/plugins/framework/external/mcp/client.py

@@ -107,7 +107,7 @@ async def __connect_to_stdio_server(self, server_script_path: str) -> None:
             ValueError: if stdio script is not a python script.
         """
         is_python = server_script_path.endswith(PYTHON_SUFFIX) if server_script_path else False
-        if not (is_python):
+        if not is_python:
             raise ValueError("Server script must be a .py file")
 
         current_env = os.environ.copy()

mcpgateway/plugins/framework/external/mcp/server/runtime.py

@@ -36,17 +36,17 @@
 
 logger = logging.getLogger(__name__)
 
-server = None
+SERVER = None
 
 
 @mcp_tool(name="get_plugin_configs", description="Get the plugin configurations installed on the server")
 async def get_plugin_configs() -> list[dict]:
-    """Return a list of plugin configurations for plugins currently installed on the MCP server.
+    """Return a list of plugin configurations for plugins currently installed on the MCP SERVER.
 
     Returns:
         A list of plugin configurations.
     """
-    return await server.get_plugin_configs()
+    return await SERVER.get_plugin_configs()
 
 
 @mcp_tool(name="get_plugin_config", description="Get the plugin configuration installed on the server given a plugin name")
@@ -59,7 +59,7 @@ async def get_plugin_config(name: str) -> dict:
     Returns:
         A list of plugin configurations.
     """
-    return await server.get_plugin_config(name)
+    return await SERVER.get_plugin_config(name)
 
 
 @mcp_tool(name="prompt_pre_fetch", description="Execute prompt prefetch hook for a plugin")
@@ -91,7 +91,7 @@ def prompt_pre_fetch_func(plugin: Plugin, payload: PromptPrehookPayload, context
         """
         return plugin.prompt_pre_fetch(payload, context)
 
-    return await server.invoke_hook(PromptPrehookPayload, prompt_pre_fetch_func, plugin_name, payload, context)
+    return await SERVER.invoke_hook(PromptPrehookPayload, prompt_pre_fetch_func, plugin_name, payload, context)
 
 
 @mcp_tool(name="prompt_post_fetch", description="Execute prompt postfetch hook for a plugin")
@@ -123,7 +123,7 @@ def prompt_post_fetch_func(plugin: Plugin, payload: PromptPosthookPayload, conte
         """
         return plugin.prompt_post_fetch(payload, context)
 
-    return await server.invoke_hook(PromptPosthookPayload, prompt_post_fetch_func, plugin_name, payload, context)
+    return await SERVER.invoke_hook(PromptPosthookPayload, prompt_post_fetch_func, plugin_name, payload, context)
 
 
 @mcp_tool(name="tool_pre_invoke", description="Execute tool pre-invoke hook for a plugin")
@@ -155,7 +155,7 @@ def tool_pre_invoke_func(plugin: Plugin, payload: ToolPreInvokePayload, context:
         """
         return plugin.tool_pre_invoke(payload, context)
 
-    return await server.invoke_hook(ToolPreInvokePayload, tool_pre_invoke_func, plugin_name, payload, context)
+    return await SERVER.invoke_hook(ToolPreInvokePayload, tool_pre_invoke_func, plugin_name, payload, context)
 
 
 @mcp_tool(name="tool_post_invoke", description="Execute tool post-invoke hook for a plugin")
@@ -187,7 +187,7 @@ def tool_post_invoke_func(plugin: Plugin, payload: ToolPostInvokePayload, contex
         """
         return plugin.tool_post_invoke(payload, context)
 
-    return await server.invoke_hook(ToolPostInvokePayload, tool_post_invoke_func, plugin_name, payload, context)
+    return await SERVER.invoke_hook(ToolPostInvokePayload, tool_post_invoke_func, plugin_name, payload, context)
 
 
 @mcp_tool(name="resource_pre_fetch", description="Execute resource prefetch hook for a plugin")
@@ -219,7 +219,7 @@ def resource_pre_fetch_func(plugin: Plugin, payload: ResourcePreFetchPayload, co
         """
         return plugin.resource_pre_fetch(payload, context)
 
-    return await server.invoke_hook(ResourcePreFetchPayload, resource_pre_fetch_func, plugin_name, payload, context)
+    return await SERVER.invoke_hook(ResourcePreFetchPayload, resource_pre_fetch_func, plugin_name, payload, context)
 
 
 @mcp_tool(name="resource_post_fetch", description="Execute resource postfetch hook for a plugin")
@@ -251,25 +251,25 @@ def resource_post_fetch_func(plugin: Plugin, payload: ResourcePostFetchPayload,
         """
         return plugin.resource_post_fetch(payload, context)
 
-    return await server.invoke_hook(ResourcePostFetchPayload, resource_post_fetch_func, plugin_name, payload, context)
+    return await SERVER.invoke_hook(ResourcePostFetchPayload, resource_post_fetch_func, plugin_name, payload, context)
 
 
 async def run():  # pragma: no cover
-    """Run the external plugin server.
+    """Run the external plugin SERVER.
 
     Raises:
-        Exception: if unnable to run the plugin server.
+        Exception: if unnable to run the plugin SERVER.
     """
-    global server
-    server = ExternalPluginServer()
-    if await server.initialize():
+    global SERVER  # pylint: disable=global-statement
+    SERVER = ExternalPluginServer()
+    if await SERVER.initialize():
         try:
             await main_async()
         except Exception:
             logger.exception("Caught error while executing plugin server")
             raise
         finally:
-            await server.shutdown()
+            await SERVER.shutdown()
 
 
 if __name__ == "__main__":  # pragma: no cover

mcpgateway/plugins/framework/external/mcp/server/server.py

@@ -19,7 +19,7 @@
 from pydantic import BaseModel
 
 # First-Party
-from mcpgateway.plugins.framework import Plugin
+from mcpgateway.plugins.framework.base import Plugin
 from mcpgateway.plugins.framework.errors import convert_exception_to_error
 from mcpgateway.plugins.framework.loader.config import ConfigLoader
 from mcpgateway.plugins.framework.manager import DEFAULT_PLUGIN_TIMEOUT, PluginManager

mcpgateway/plugins/framework/loader/plugin.py

@@ -23,7 +23,7 @@
 logger = logging.getLogger(__name__)
 
 
-class PluginLoader(object):
+class PluginLoader:
     """A plugin loader object for loading and instantiating plugins.
 
     Examples:

mcpgateway/plugins/framework/manager.py

@@ -206,7 +206,7 @@ async def execute(
                     if pluginref.plugin.mode == PluginMode.ENFORCE:
                         logger.warning(f"Plugin {pluginref.plugin.name} blocked request in enforce mode")
                         return (PluginResult[T](continue_processing=False, modified_payload=current_payload, violation=result.violation, metadata=combined_metadata), res_local_contexts)
-                    elif pluginref.plugin.mode == PluginMode.PERMISSIVE:
+                    if pluginref.plugin.mode == PluginMode.PERMISSIVE:
                         logger.warning(f"Plugin {pluginref.plugin.name} would block (permissive mode): {result.violation.description if result.violation else 'No description'}")
 
             except asyncio.TimeoutError:

mcpgateway/plugins/framework/models.py

@@ -268,7 +268,7 @@ def validate_script(cls, script: str | None) -> str | None:
             file_path = Path(script)
             if not file_path.is_file():
                 raise ValueError(f"MCP server script {script} does not exist.")
-            elif file_path.suffix != PYTHON_SUFFIX:
+            if file_path.suffix != PYTHON_SUFFIX:
                 raise ValueError(f"MCP server script {script} does not have a .py suffix.")
         return script
 
@@ -309,7 +309,7 @@ class PluginConfig(BaseModel):
     mcp: Optional[MCPConfig] = None
 
     @model_validator(mode=AFTER)
-    def check_url_or_script_filled(self) -> Self:
+    def check_url_or_script_filled(self) -> Self:  # pylint: disable=bad-classmethod-argument
         """Checks to see that at least one of url or script are set depending on MCP server configuration.
 
         Raises:
@@ -322,14 +322,14 @@ def check_url_or_script_filled(self) -> Self:
             return self
         if self.mcp.proto == TransportType.STDIO and not self.mcp.script:
             raise ValueError(f"Plugin {self.name} has transport type set to SSE but no script value")
-        elif (self.mcp.proto == TransportType.STREAMABLEHTTP or self.mcp.proto == TransportType.SSE) and not self.mcp.url:
+        if self.mcp.proto in (TransportType.STREAMABLEHTTP, TransportType.SSE) and not self.mcp.url:
             raise ValueError(f"Plugin {self.name} has transport type set to StreamableHTTP but no url value")
-        elif self.mcp.proto != TransportType.SSE and self.mcp.proto != TransportType.STREAMABLEHTTP and self.mcp.proto != TransportType.STDIO:
+        if self.mcp.proto not in (TransportType.SSE, TransportType.STREAMABLEHTTP, TransportType.STDIO):
             raise ValueError(f"Plugin {self.name} must set transport type to either SSE or STREAMABLEHTTP or STDIO")
         return self
 
     @model_validator(mode=AFTER)
-    def check_config_and_external(self, info: ValidationInfo) -> Self:
+    def check_config_and_external(self, info: ValidationInfo) -> Self:  # pylint: disable=bad-classmethod-argument
         """Checks to see that a plugin's 'config' section is not defined if the kind is 'external'. This is because developers cannot override items in the plugin config section for external plugins.
 
         Args:

mcpgateway/plugins/framework/utils.py

@@ -142,7 +142,7 @@ def pre_prompt_matches(payload: PromptPrehookPayload, conditions: list[PluginCon
             current_result = False
         if current_result:
             return True
-        elif index < len(conditions) - 1:
+        if index < len(conditions) - 1:
             current_result = True
     return current_result
 
@@ -167,7 +167,7 @@ def post_prompt_matches(payload: PromptPosthookPayload, conditions: list[PluginC
             current_result = False
         if current_result:
             return True
-        elif index < len(conditions) - 1:
+        if index < len(conditions) - 1:
             current_result = True
     return current_result
 
@@ -203,7 +203,7 @@ def pre_tool_matches(payload: ToolPreInvokePayload, conditions: list[PluginCondi
             current_result = False
         if current_result:
             return True
-        elif index < len(conditions) - 1:
+        if index < len(conditions) - 1:
             current_result = True
     return current_result
 
@@ -239,7 +239,7 @@ def post_tool_matches(payload: ToolPostInvokePayload, conditions: list[PluginCon
             current_result = False
         if current_result:
             return True
-        elif index < len(conditions) - 1:
+        if index < len(conditions) - 1:
             current_result = True
     return current_result
 
@@ -275,7 +275,7 @@ def pre_resource_matches(payload: ResourcePreFetchPayload, conditions: list[Plug
             current_result = False
         if current_result:
             return True
-        elif index < len(conditions) - 1:
+        if index < len(conditions) - 1:
             current_result = True
     return current_result
 
@@ -313,6 +313,6 @@ def post_resource_matches(payload: ResourcePostFetchPayload, conditions: list[Pl
             current_result = False
         if current_result:
             return True
-        elif index < len(conditions) - 1:
+        if index < len(conditions) - 1:
             current_result = True
     return current_result