d365fo-client 0.2.4__py3-none-any.whl → 0.3.0__py3-none-any.whl

d365fo_client/mcp/auth_server/dependencies.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from mcp.server.auth.middleware.auth_context import (
+    get_access_token as _sdk_get_access_token,
+)
+from mcp.server.auth.provider import (
+    AccessToken as _SDKAccessToken,
+)
+from starlette.requests import Request
+
+from .auth import AccessToken
+
+# if TYPE_CHECKING:
+#     from fastmcp.server.context import Context
+
+__all__ = [
+    #"get_context",
+    "get_http_request",
+    "get_http_headers",
+    "get_access_token",
+    "AccessToken",
+]
+
+
+# --- Context ---
+
+
+# def get_context() -> Context:
+#     from fastmcp.server.context import _current_context
+
+#     context = _current_context.get()
+#     if context is None:
+#         raise RuntimeError("No active context found.")
+#     return context
+
+
+# --- HTTP Request ---
+
+
+def get_http_request() -> Request:
+    from mcp.server.lowlevel.server import request_ctx
+
+    request = None
+    try:
+        request = request_ctx.get().request
+    except LookupError:
+        pass
+
+    if request is None:
+        raise RuntimeError("No active HTTP request found.")
+    return request
+
+
+def get_http_headers(include_all: bool = False) -> dict[str, str]:
+    """
+    Extract headers from the current HTTP request if available.
+
+    Never raises an exception, even if there is no active HTTP request (in which case
+    an empty dict is returned).
+
+    By default, strips problematic headers like `content-length` that cause issues if forwarded to downstream clients.
+    If `include_all` is True, all headers are returned.
+    """
+    if include_all:
+        exclude_headers = set()
+    else:
+        exclude_headers = {
+            "host",
+            "content-length",
+            "connection",
+            "transfer-encoding",
+            "upgrade",
+            "te",
+            "keep-alive",
+            "expect",
+            "accept",
+            # Proxy-related headers
+            "proxy-authenticate",
+            "proxy-authorization",
+            "proxy-connection",
+            # MCP-related headers
+            "mcp-session-id",
+        }
+        # (just in case)
+        if not all(h.lower() == h for h in exclude_headers):
+            raise ValueError("Excluded headers must be lowercase")
+    headers = {}
+
+    try:
+        request = get_http_request()
+        for name, value in request.headers.items():
+            lower_name = name.lower()
+            if lower_name not in exclude_headers:
+                headers[lower_name] = str(value)
+        return headers
+    except RuntimeError:
+        return {}
+
+
+# --- Access Token ---
+
+
+def get_access_token() -> AccessToken | None:
+    """
+    Get the FastMCP access token from the current context.
+
+    Returns:
+        The access token if an authenticated user is available, None otherwise.
+    """
+    #
+    access_token: _SDKAccessToken | None = _sdk_get_access_token()
+
+    if access_token is None or isinstance(access_token, AccessToken):
+        return access_token
+
+    # If the object is not a FastMCP AccessToken, convert it to one if the fields are compatible
+    # This is a workaround for the case where the SDK returns a different type
+    # If it fails, it will raise a TypeError
+    try:
+        access_token_as_dict = access_token.model_dump()
+        return AccessToken(
+            token=access_token_as_dict["token"],
+            client_id=access_token_as_dict["client_id"],
+            scopes=access_token_as_dict["scopes"],
+            # Optional fields
+            expires_at=access_token_as_dict.get("expires_at"),
+            resource_owner=access_token_as_dict.get("resource_owner"),# type: ignore[arg-type]
+            claims=access_token_as_dict.get("claims"),
+        )
+    except Exception as e:
+        raise TypeError(
+            f"Expected fastmcp.server.auth.auth.AccessToken, got {type(access_token).__name__}. "
+            "Ensure the SDK is using the correct AccessToken type."
+        ) from e

d365fo_client/mcp/client_manager.py

@@ -20,14 +20,13 @@ logger = logging.getLogger(__name__)
 class D365FOClientManager:
     """Manages D365FO client instances and connection pooling."""
 
-    def __init__(self, config: dict, profile_manager: Optional[ProfileManager] = None):
+    def __init__(self, profile_manager: Optional[ProfileManager] = None):
         """Initialize the client manager.
 
         Args:
             config: Configuration dictionary with client settings
             profile_manager: Optional shared ProfileManager instance
         """
-        self.config = config
         self._client_pool: Dict[str, FOClient] = {}
         self._session_lock = asyncio.Lock()
         self._last_health_check: Optional[datetime] = None
@@ -49,7 +48,11 @@ class D365FOClientManager:
         async with self._session_lock:
             if profile not in self._client_pool:
                 client_config = self._build_client_config(profile)
+                if not client_config:
+                    raise ValueError(f"Profile '{profile}' configuration is invalid")
+                
                 client = FOClient(client_config)
+                await client.initialize_metadata()
 
                 # Test connection
                 try:
@@ -172,7 +175,7 @@ class D365FOClientManager:
         # Clear all cached clients
         await self.cleanup()
 
-    def _build_client_config(self, profile: str) -> FOClientConfig:
+    def _build_client_config(self, profile: str) -> Optional[FOClientConfig]:
         """Build FOClientConfig from profile configuration.
 
         Args:
@@ -185,7 +188,7 @@ class D365FOClientManager:
         env_profile = None
 
         # If requesting "default", resolve to the actual default profile
-        if profile == "default":
+        if profile == "default" or not profile:
             env_profile = self.profile_manager.get_default_profile()
             if not env_profile:
                 # No default profile set, try to get a profile named "default"
@@ -203,72 +206,18 @@ class D365FOClientManager:
                 )
             
             # Check if legacy config should override certain settings
-            default_config = self.config.get("default_environment", {})
-            if default_config and profile == "default":
-                # Override use_default_credentials if specified in legacy config
-                if "use_default_credentials" in default_config:
-                    config.use_default_credentials = default_config["use_default_credentials"]
+
             
             return config
+        
+        raise ValueError(
+                    f"Profile '{profile}' not found in profile manager"
+                )
 
-        # Fallback to legacy config-based profiles
-        profile_config = self.config.get("profiles", {}).get(profile, {})
-        default_config = self.config.get("default_environment", {})
-
-        # If requesting a specific profile name that doesn't exist in profiles, don't fall back
-        if (
-            profile != "default"
-            and profile not in self.config.get("profiles", {})
-            and not profile_config
-        ):
-            available_profiles = list(self.profile_manager.list_profiles().keys())
-            legacy_profiles = list(self.config.get("profiles", {}).keys())
-            all_profiles = sorted(set(available_profiles + legacy_profiles))
-
-            default_profile = self.profile_manager.get_default_profile()
-
-            error_msg = f"Profile '{profile}' not found"
-            if all_profiles:
-                error_msg += f". Available profiles: {', '.join(all_profiles)}"
-            if default_profile:
-                error_msg += f". Default profile is '{default_profile.name}'"
-            else:
-                error_msg += ". No default profile is set"
-
-            raise ValueError(error_msg)
-
-        # Merge configs (profile overrides default)
-        config = {**default_config, **profile_config}
-
-        # Validate base_url
-        base_url = config.get("base_url")
-        if not base_url:
-            available_profiles = list(self.profile_manager.list_profiles().keys())
-            default_profile = self.profile_manager.get_default_profile()
-
-            error_msg = f"No configuration found for profile '{profile}'"
-            if available_profiles:
-                error_msg += f". Available profiles: {', '.join(available_profiles)}"
-            if default_profile:
-                error_msg += f". Default profile is '{default_profile.name}'"
-            else:
-                error_msg += ". No default profile is set"
-
-            raise ValueError(error_msg)
-
-        return FOClientConfig(
-            base_url=base_url,
-            client_id=config.get("client_id"),
-            client_secret=config.get("client_secret"),
-            tenant_id=config.get("tenant_id"),
-            use_default_credentials=config.get("use_default_credentials", True),
-            timeout=config.get("timeout", 60),
-            verify_ssl=config.get("verify_ssl", True),
-            use_label_cache=config.get("use_label_cache", True),
-            metadata_cache_dir=config.get("metadata_cache_dir"),
-            use_cache_first=config.get("use_cache_first", True),
-        )
-
+    async def shutdown(self):
+        """Shutdown the client manager and close all connections."""
+        await self.cleanup()
+        
     async def _test_client_connection(self, client: FOClient) -> bool:
         """Test a client connection.
 

d365fo_client/mcp/fastmcp_main.py

@@ -0,0 +1,358 @@
+#!/usr/bin/env python3
+"""Entry point for the FastMCP-based D365FO MCP Server."""
+
+import argparse
+import asyncio
+import logging
+import logging.handlers
+import os
+import sys
+from pathlib import Path
+from typing import Literal, Optional
+from mcp.server.fastmcp import FastMCP
+from pydantic import AnyHttpUrl, AnyUrl
+
+from d365fo_client import __version__
+from d365fo_client.mcp.auth_server.auth.providers.azure import AzureProvider
+from d365fo_client.mcp import FastD365FOMCPServer
+from d365fo_client.mcp.fastmcp_utils import create_default_profile_if_needed, load_default_config, migrate_legacy_config
+from d365fo_client.profile_manager import ProfileManager
+from d365fo_client.settings import get_settings
+from mcp.server.auth.settings import  AuthSettings,ClientRegistrationOptions
+
+
+
+def setup_logging(level: str = "INFO", log_file_path: Optional[str] = None) -> None:
+    """Set up logging configuration with 24-hour log rotation.
+
+    Args:
+        level: Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+        log_file_path: Custom log file path, if None uses default from settings
+    """
+    log_level = getattr(logging, level.upper(), logging.INFO)
+
+    # Get log file path from parameter or settings
+    if log_file_path:
+        log_file = Path(log_file_path)
+        # Ensure parent directory exists
+        log_file.parent.mkdir(parents=True, exist_ok=True)
+    else:
+        # Use default log file path from settings
+        settings = get_settings()
+        log_file = Path(settings.log_file) #type: ignore
+        # Settings already ensures directories exist
+        log_file.parent.mkdir(parents=True, exist_ok=True)
+
+    # Clear existing handlers to avoid duplicate logging
+    root_logger = logging.getLogger()
+    for handler in root_logger.handlers[:]:
+        root_logger.removeHandler(handler)
+
+    # Create rotating file handler - rotates every 24 hours (midnight)
+    file_handler = logging.handlers.TimedRotatingFileHandler(
+        filename=str(log_file),
+        when='midnight',        # Rotate at midnight
+        interval=1,             # Every 1 day
+        backupCount=30,         # Keep 30 days of logs
+        encoding='utf-8',       # Use UTF-8 encoding
+        utc=False              # Use local time for rotation
+    )
+    file_handler.setLevel(log_level)
+    
+    # Create console handler
+    console_handler = logging.StreamHandler(sys.stderr)
+    console_handler.setLevel(log_level)
+    
+    # Create formatter
+    formatter = logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+    file_handler.setFormatter(formatter)
+    console_handler.setFormatter(formatter)
+
+    # Configure root logger
+    root_logger.setLevel(log_level)
+    root_logger.addHandler(file_handler)
+    root_logger.addHandler(console_handler)
+
+
+def parse_arguments() -> argparse.Namespace:
+    """Parse command line arguments.
+
+    Returns:
+        Parsed command line arguments
+    """
+    parser = argparse.ArgumentParser(
+        description="FastMCP-based D365FO MCP Server with multi-transport support",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Transport Options:
+  stdio       Standard input/output (default, for development and CLI tools)
+  sse         Server-Sent Events (for web applications and browsers)  
+  http        Streamable HTTP (for production deployments and microservices)
+
+
+Production Examples:
+  # Development (default)
+  %(prog)s                                    
+  
+  # Web development
+  %(prog)s --transport sse --port 8000 --debug       
+  
+  # Basic production HTTP
+  %(prog)s --transport http --host 0.0.0.0 --port 8000
+  
+  
+Environment Variables:
+  D365FO_BASE_URL           D365FO environment URL
+  D365FO_CLIENT_ID          Azure AD client ID (optional)
+  D365FO_CLIENT_SECRET      Azure AD client secret (optional)  
+  D365FO_TENANT_ID          Azure AD tenant ID (optional)
+  D365FO_MCP_TRANSPORT      Default transport protocol (stdio, sse, http, streamable-http)
+  D365FO_MCP_HTTP_HOST          Default HTTP host (default: 127.0.0.1)
+  D365FO_MCP_HTTP_PORT          Default HTTP port (default: 8000)
+  D365FO_MCP_HTTP_STATELESS     Enable stateless mode (true/false)
+  D365FO_MCP_HTTP_JSON          Enable JSON response mode (true/false)
+  D365FO_MCP_MAX_CONCURRENT_REQUESTS  Max concurrent requests (default: 10)
+  D365FO_MCP_REQUEST_TIMEOUT    Request timeout in seconds (default: 30)
+  D365FO_MCP_AUTH_CLIENT_ID     Azure AD client ID for authentication
+  D365FO_MCP_AUTH_CLIENT_SECRET Azure AD client secret for authentication
+  D365FO_MCP_AUTH_TENANT_ID    Azure AD tenant ID for authentication
+  D365FO_MCP_AUTH_BASE_URL     http://localhost:8000
+  D365FO_MCP_AUTH_REQUIRED_SCOPES  User.Read,email,openid,profile
+  D365FO_LOG_LEVEL               Logging level (DEBUG, INFO, WARNING, ERROR)
+  D365FO_LOG_FILE                Custom log file path (default: ~/.d365fo-mcp/logs/fastmcp-server.log)
+  D365FO_META_CACHE_DIR          Metadata cache directory (default: ~/.d365fo-mcp/cache)
+
+        """
+    )
+    
+    parser.add_argument(
+        "--version",
+        action="version", 
+        version=f"%(prog)s {__version__}"
+    )
+    
+    # Get settings for defaults
+    settings = get_settings()
+    
+    parser.add_argument(
+        "--transport",
+        type=str,
+        choices=["stdio", "sse", "http", "streamable-http"],
+        default=settings.mcp_transport.value,
+        help=f"Transport protocol to use (default: {settings.mcp_transport.value}, from D365FO_MCP_TRANSPORT env var)"
+    )
+    
+    parser.add_argument(
+        "--host",
+        type=str,
+        default=settings.http_host,
+        help=f"Host to bind to for SSE/HTTP transports (default: {settings.http_host})"
+    )
+    
+    parser.add_argument(
+        "--port",
+        type=int,
+        default=settings.http_port,
+        help=f"Port to bind to for SSE/HTTP transports (default: {settings.http_port})"
+    )
+    
+    parser.add_argument(
+        "--stateless",
+        action="store_true",
+        help="Enable stateless HTTP mode for horizontal scaling and load balancing. " +
+             "In stateless mode, each request is independent and sessions are not persisted."
+    )
+    
+    parser.add_argument(
+        "--json-response",
+        action="store_true",
+        help="Use JSON responses instead of SSE streams (HTTP transport only). " +
+             "Useful for API gateways and clients that prefer standard JSON responses."
+    )
+    
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="Enable debug mode with verbose logging and detailed error information"
+    )
+    
+    parser.add_argument(
+        "--log-level",
+        type=str,
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default=settings.log_level.value,
+        help=f"Set logging level (default: {settings.log_level.value}, from D365FO_LOG_LEVEL env var)"
+    )
+    
+    
+
+    return parser.parse_args()
+
+
+# Get settings first
+settings = get_settings()
+
+# Parse arguments  
+args = parse_arguments()
+arg_transport = args.transport
+
+# Set up logging and load configuration
+if arg_transport == "http":
+    arg_transport = "streamable-http"
+
+transport: Literal["stdio", "sse", "streamable-http"] = arg_transport
+
+# Use settings for logging setup
+setup_logging(args.log_level or settings.log_level.value, settings.log_file)
+logger = logging.getLogger(__name__)
+
+logger.info(f"Starting FastD365FOMCPServer v{__version__} with transport: {transport}")
+
+# Use load_default_config with args instead of separate load_config function
+config = load_default_config(args)
+
+default_fo = config.get("default_environment", {})
+
+config_path = default_fo.get("metadata_cache_dir", settings.meta_cache_dir)
+
+
+# Create profile manager with config path
+profile_manager = ProfileManager(str(Path(config_path) / "config.yaml"))
+
+# Migrate legacy configuration if needed
+if migrate_legacy_config(profile_manager):
+    logger.info("Legacy configuration migrated successfully")
+else:
+    logger.debug("No legacy configuration migration needed")
+
+if not create_default_profile_if_needed(profile_manager, config):
+    logger.debug("Default profile already exists or creation not needed")
+
+# Extract server configuration
+server_config = config.get("server", {})
+transport_config = server_config.get("transport", {})
+
+is_remote_transport = transport in ["sse", "streamable-http"]
+
+# Log startup configuration details
+logger.info("=== Server Startup Configuration ===")
+logger.info(f"Transport: {transport}")
+if is_remote_transport:
+    logger.info(f"Host: {transport_config.get('http', {}).get('host', '127.0.0.1')}")
+    logger.info(f"Port: {transport_config.get('http', {}).get('port', 8000)}")
+
+logger.info(f"Debug mode: {server_config.get('debug', False)}")
+logger.info(f"JSON response: {transport_config.get('http', {}).get('json_response', False)}")
+logger.info(f"Stateless HTTP: {transport_config.get('http', {}).get('stateless', False)}")
+logger.info(f"Log level: {args.log_level}")
+logger.info(f"Config path: {config_path}")
+logger.info(f"D365FO Base URL: {default_fo.get('base_url', settings.base_url)}")
+logger.info(f"Settings Base URL: {settings.base_url}")
+logger.info(f"Startup Mode: {settings.get_startup_mode()}")
+logger.info(f"Client Credentials: {'Configured' if settings.has_client_credentials() else 'Not configured'}")
+logger.info("====================================")
+
+if is_remote_transport and not settings.has_mcp_auth_credentials():
+
+    logger.error("Warning: Client credentials (D365FO_MCP_AUTH_CLIENT_ID and D365FO_MCP_AUTH_CLIENT_SECRET, D365FO_MCP_AUTH_TENANT_ID,D365FO_MCP_AUTH_BASE_URL and D365FO_MCP_AUTH_REQUIRED_SCOPES) are not set. " +
+                   "Remote transports require authentication to the D365FO environment.")
+    sys.exit(1)    
+
+auth_provider: AzureProvider | None = None
+auth: AuthSettings | None = None
+
+if is_remote_transport:
+    assert settings.mcp_auth_client_id is not None
+    assert settings.mcp_auth_client_secret is not None
+    assert settings.mcp_auth_tenant_id is not None
+    assert settings.mcp_auth_base_url is not None
+    assert settings.mcp_auth_required_scopes is not None
+    required_scopes=settings.mcp_auth_required_scopes_list()
+
+    # if "AX.FullAccess" not in required_scopes:
+    #     logger.warning("Warning: 'AX.FullAccess' scope is not supported. Adding it automatically.")
+    #     required_scopes.append("https://erp.dynamics.com/AX.FullAccess")
+
+    # Initialize authorization settings
+    auth_provider = AzureProvider(
+        client_id=settings.mcp_auth_client_id,  # Your Azure App Client ID
+        client_secret=settings.mcp_auth_client_secret,                 # Your Azure App Client Secret
+        tenant_id=settings.mcp_auth_tenant_id, # Your Azure Tenant ID (REQUIRED)
+        base_url=settings.mcp_auth_base_url,                   # Must match your App registration
+        required_scopes=required_scopes or ["User.Read"],  # type: ignore # Scopes your app needs
+        redirect_path="/auth/callback",  # Ensure callback path is explicit
+        clients_storage_path=config_path or ...
+    )
+    from mcp.shared.auth import OAuthClientInformationFull
+
+    # auth_provider._clients["eae68fdd-610b-47c5-9907-709c7452f1b3"] = OAuthClientInformationFull(
+    #     client_id="5eae68fdd-610b-47c5-9907-709c7452f1b3",
+    #     client_name="Test Client",
+    #     redirect_uris=[AnyUrl("http://127.0.0.1:33418")],
+    #     scope=",".join(required_scopes)
+    # )
+
+
+    auth=AuthSettings(
+            issuer_url=AnyHttpUrl(settings.mcp_auth_base_url),
+            client_registration_options=ClientRegistrationOptions(
+                enabled=True,
+                valid_scopes=required_scopes or ["User.Read"], # type: ignore
+                default_scopes=required_scopes or ["User.Read"], # type: ignore
+            ),
+            required_scopes=required_scopes or ["User.Read"], # type: ignore
+            resource_server_url=AnyHttpUrl(settings.mcp_auth_base_url),
+            
+        )
+
+# Initialize FastMCP server with configuration
+mcp = FastMCP(
+    name=server_config.get("name", "d365fo-mcp-server"),
+    auth_server_provider=auth_provider,
+    auth=auth,
+    instructions=server_config.get(
+        "instructions",
+        "Microsoft Dynamics 365 Finance & Operations MCP Server providing comprehensive access to D365FO data, metadata, and operations",
+    ),
+    host=transport_config.get("http", {}).get("host", "127.0.0.1"),
+    port=transport_config.get("http", {}).get("port", 8000),
+    debug=server_config.get("debug", False),
+    json_response=transport_config.get("http", {}).get("json_response", False),
+    stateless_http=transport_config.get("http", {}).get("stateless", False),
+    streamable_http_path= "/" if transport == "streamable-http" else "/mcp",
+    sse_path="/" if transport == "streamable-http" else "/sse",
+
+)
+
+if is_remote_transport:
+    from starlette.requests import Request
+    from starlette.responses import RedirectResponse
+    
+    @mcp.custom_route(path=auth_provider._redirect_path, methods=["GET"]) # type: ignore
+    async def handle_idp_callback(request: Request) -> RedirectResponse:
+        return await auth_provider._handle_idp_callback(request) # type: ignore
+
+server = FastD365FOMCPServer(mcp, config, profile_manager=profile_manager)
+
+logger.info("FastD365FOMCPServer initialized successfully")
+
+
+def main() -> None:
+    """Main entry point for the FastMCP server."""
+
+    # Handle Windows event loop policy
+    if sys.platform == "win32":
+        asyncio.set_event_loop_policy(asyncio.WindowsProactorEventLoopPolicy())
+    try:
+        mcp.run(transport=transport)
+    except KeyboardInterrupt:
+        logger.info("Server stopped by user (Ctrl+C)")
+    except Exception as e:
+        logger.error(f"Fatal error: {e}", exc_info=True)
+        print(f"Fatal error: {e}", file=sys.stderr)
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main()