Merge pull request #111 from IBM/documentation-review

Linting

Author: crivetimihai

.env.example

@@ -146,10 +146,10 @@ SSE_RETRY_TIMEOUT=5000
 #####################################
 
 # Set False to use stateless sessions without event store and True for stateful sessions
-USE_STATEFUL_SESSIONS=false  
+USE_STATEFUL_SESSIONS=false
 
 # Set true for JSON responses, false for SSE streams
-JSON_RESPONSE_ENABLED=true 
+JSON_RESPONSE_ENABLED=true
 
 
 #####################################

README.md

@@ -275,6 +275,8 @@ docker run -d --name mcpgateway \
   ghcr.io/ibm/mcp-context-forge:0.1.1
 ```
 
+Using `--network=host` allows Docker to access the local network, allowing you to add MCP servers running on your host. See [Docker Host network driver documentation](https://docs.docker.com/engine/network/drivers/host/) for more details.
+
 </details>
 
 ---
@@ -1719,7 +1721,7 @@ podman-prod          - Build production container image (using ubi-micro → scr
 podman-run           - Run the container on HTTP  (port 4444)
 podman-run-shell     - Run the container on HTTP  (port 4444) and start a shell
 podman-run-ssl       - Run the container on HTTPS (port 4444, self-signed)
-podman-run-ssl-host  - Run the container on HTTPS with --network-host (port 4444, self-signed)
+podman-run-ssl-host  - Run the container on HTTPS with --network=host (port 4444, self-signed)
 podman-stop          - Stop & remove the container
 podman-test          - Quick curl smoke-test against the container
 podman-logs          - Follow container logs (⌃C to quit)

mcpgateway/main.py

@@ -104,7 +104,10 @@
     ToolService,
 )
 from mcpgateway.transports.sse_transport import SSETransport
-from mcpgateway.transports.streamablehttp_transport import SessionManagerWrapper, JWTAuthMiddlewareStreamableHttp
+from mcpgateway.transports.streamablehttp_transport import (
+    JWTAuthMiddlewareStreamableHttp,
+    SessionManagerWrapper,
+)
 from mcpgateway.types import (
     InitializeRequest,
     InitializeResult,
@@ -204,18 +207,7 @@ async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
     finally:
         logger.info("Shutting down MCP Gateway services")
         # await stop_streamablehttp()
-        for service in [
-            resource_cache,
-            sampling_handler,
-            logging_service,
-            completion_service,
-            root_service,
-            gateway_service,
-            prompt_service,
-            resource_service,
-            tool_service,
-            streamable_http_session
-        ]:
+        for service in [resource_cache, sampling_handler, logging_service, completion_service, root_service, gateway_service, prompt_service, resource_service, tool_service, streamable_http_session]:
             try:
                 await service.shutdown()
             except Exception as e:

mcpgateway/transports/streamablehttp_transport.py

@@ -11,48 +11,42 @@
 - SessionManagerWrapper: Manages the lifecycle of streamable HTTP sessions
 - JWTAuthMiddlewareStreamableHttp: Middleware for JWT authentication
 - Configuration options for:
-        1. stateful/stateless operation 
+        1. stateful/stateless operation
         2. JSON response mode or SSE streams
 - InMemoryEventStore: A simple in-memory event storage system for maintaining session state
 
 """
 
 import logging
+from collections import deque
 from contextlib import AsyncExitStack, asynccontextmanager
+from dataclasses import dataclass
 from typing import List, Union
-
-from starlette.types import Receive, Scope, Send
-from starlette.middleware.base import BaseHTTPMiddleware
-from starlette.requests import Request
-from starlette.responses import JSONResponse
-from starlette.datastructures import Headers
-from fastapi.security.utils import get_authorization_scheme_param
-from starlette.status import HTTP_401_UNAUTHORIZED
-from starlette.types import ASGIApp
+from uuid import uuid4
 
 import mcp.types as types
+from fastapi.security.utils import get_authorization_scheme_param
 from mcp.server.lowlevel import Server
-from mcp.server.streamable_http_manager import StreamableHTTPSessionManager
-
-from mcpgateway.services.tool_service import ToolService
-from mcpgateway.db import SessionLocal
-from mcpgateway.config import settings  
-from mcpgateway.utils.verify_credentials import verify_credentials
-
-
-from collections import deque
-from dataclasses import dataclass
-from uuid import uuid4
-
 from mcp.server.streamable_http import (
     EventCallback,
     EventId,
     EventMessage,
     EventStore,
     StreamId,
 )
+from mcp.server.streamable_http_manager import StreamableHTTPSessionManager
 from mcp.types import JSONRPCMessage
+from starlette.datastructures import Headers
+from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.requests import Request
+from starlette.responses import JSONResponse
+from starlette.status import HTTP_401_UNAUTHORIZED
+from starlette.types import ASGIApp, Receive, Scope, Send
 
+from mcpgateway.config import settings
+from mcpgateway.db import SessionLocal
+from mcpgateway.services.tool_service import ToolService
+from mcpgateway.utils.verify_credentials import verify_credentials
 
 logger = logging.getLogger(__name__)
 logging.basicConfig(level=logging.INFO)
@@ -63,6 +57,7 @@
 
 ## ------------------------------ Event store ------------------------------
 
+
 @dataclass
 class EventEntry:
     """
@@ -95,14 +90,10 @@ def __init__(self, max_events_per_stream: int = 100):
         # event_id -> EventEntry for quick lookup
         self.event_index: dict[EventId, EventEntry] = {}
 
-    async def store_event(
-        self, stream_id: StreamId, message: JSONRPCMessage
-    ) -> EventId:
+    async def store_event(self, stream_id: StreamId, message: JSONRPCMessage) -> EventId:
         """Stores an event with a generated event ID."""
         event_id = str(uuid4())
-        event_entry = EventEntry(
-            event_id=event_id, stream_id=stream_id, message=message
-        )
+        event_entry = EventEntry(event_id=event_id, stream_id=stream_id, message=message)
 
         # Get or create deque for this stream
         if stream_id not in self.streams:
@@ -148,6 +139,7 @@ async def replay_events_after(
 
 ## ------------------------------ Streamable HTTP Transport ------------------------------
 
+
 @asynccontextmanager
 async def get_db():
     """
@@ -184,12 +176,7 @@ async def call_tool(name: str, arguments: dict) -> List[Union[types.TextContent,
                 logger.warning(f"No content returned by tool: {name}")
                 return []
 
-            return [
-                types.TextContent(
-                    type=result.content[0].type,
-                    text=result.content[0].text
-                )
-            ]
+            return [types.TextContent(type=result.content[0].type, text=result.content[0].text)]
     except Exception as e:
         logger.exception(f"Error calling tool '{name}': {e}")
         return []
@@ -207,19 +194,12 @@ async def list_tools() -> List[types.Tool]:
     try:
         async with get_db() as db:
             tools = await tool_service.list_tools(db)
-            return [
-                types.Tool(
-                    name=tool.name,
-                    description=tool.description,
-                    inputSchema=tool.input_schema
-                ) for tool in tools
-            ]
+            return [types.Tool(name=tool.name, description=tool.description, inputSchema=tool.input_schema) for tool in tools]
     except Exception as e:
         logger.exception("Error listing tools")
         return []
 
 
-
 class SessionManagerWrapper:
     """
     Wrapper class for managing the lifecycle of a StreamableHTTPSessionManager instance.
@@ -230,13 +210,13 @@ def __init__(self) -> None:
         """
         Initializes the session manager and the exit stack used for managing its lifecycle.
         """
-        
+
         if settings.use_stateful_sessions:
             event_store = InMemoryEventStore()
-            stateless=False
+            stateless = False
         else:
-            event_store=None
-            stateless=True
+            event_store = None
+            stateless = True
 
         self.session_manager = StreamableHTTPSessionManager(
             app=mcp_app,
@@ -252,7 +232,7 @@ async def start(self) -> None:
         """
         logger.info("Initializing Streamable HTTP service")
         await self.stack.enter_async_context(self.session_manager.run())
-        
+
     async def shutdown(self) -> None:
         """
         Gracefully shuts down the Streamable HTTP session manager.
@@ -276,14 +256,17 @@ async def handle_streamable_http(self, scope: Scope, receive: Receive, send: Sen
             logger.exception("Error handling streamable HTTP request")
             raise
 
+
 ## ------------------------- FastAPI Middleware for Authentication ------------------------------
 
+
 class JWTAuthMiddlewareStreamableHttp(BaseHTTPMiddleware):
     """
     Middleware for handling JWT authentication in an ASGI application.
     This middleware checks for JWT tokens in the authorization header or cookies
     and verifies the credentials before allowing access to protected routes.
     """
+
     def __init__(self, app: ASGIApp):
         """
         Initialize the middleware with the given ASGI application.
@@ -344,5 +327,3 @@ async def dispatch(self, request: Request, call_next):
                 status_code=HTTP_401_UNAUTHORIZED,
                 headers={"WWW-Authenticate": "Bearer"},
             )
-
-

mcpgateway/wrapper.py

@@ -113,13 +113,14 @@ def _extract_base_url(url: str) -> str:
 
     path = parsed.path or ""
     if "/servers/" in path:
-        path = path.split("/servers")[0]           # ".../servers/123" -> "..."
+        path = path.split("/servers")[0]  # ".../servers/123" -> "..."
     elif path.endswith("/servers"):
-        path = path[:-len("/servers")]             # ".../servers"     -> "..."
+        path = path[: -len("/servers")]  # ".../servers"     -> "..."
     # otherwise keep the existing path (supports APP_ROOT_PATH)
 
     return f"{parsed.scheme}://{parsed.netloc}{path}"
 
+
 BASE_URL: str = _extract_base_url(SERVER_CATALOG_URLS[0]) if SERVER_CATALOG_URLS else ""
 
 # -----------------------------------------------------------------------------