mcp-proxy-adapter 2.0.1__py3-none-any.whl → 6.9.50__py3-none-any.whl

mcp_proxy_adapter/examples/queue_server_example.py

@@ -0,0 +1,85 @@
+"""
+Queue Server Example for MCP Proxy Adapter.
+
+This example demonstrates how to run an MCP server with queue integration
+for managing background jobs.
+
+Author: Vasiliy Zdanovskiy
+email: vasilyvz@gmail.com
+"""
+
+import asyncio
+from hypercorn.asyncio import serve
+from hypercorn.config import Config as HyperConfig
+from mcp_proxy_adapter.api.app import create_app
+from mcp_proxy_adapter.commands.command_registry import registry
+from mcp_proxy_adapter.commands.queue_commands import (
+    QueueAddJobCommand,
+    QueueStartJobCommand,
+    QueueStopJobCommand,
+    QueueDeleteJobCommand,
+    QueueGetJobStatusCommand,
+    QueueListJobsCommand,
+    QueueHealthCommand,
+)
+from mcp_proxy_adapter.integrations.queuemgr_integration import (
+    init_global_queue_manager,
+    shutdown_global_queue_manager,
+)
+
+
+async def setup_queue_commands():
+    """Setup queue management commands."""
+    print("🔧 Setting up queue management commands...")
+    
+    # Register queue commands
+    registry.register(QueueAddJobCommand())
+    registry.register(QueueStartJobCommand())
+    registry.register(QueueStopJobCommand())
+    registry.register(QueueDeleteJobCommand())
+    registry.register(QueueGetJobStatusCommand())
+    registry.register(QueueListJobsCommand())
+    registry.register(QueueHealthCommand())
+    
+    print("✅ Queue commands registered")
+
+
+def create_queue_server_app() -> any:
+    """Create MCP server application with queue integration."""
+    app = create_app()
+    
+    @app.on_event("startup")
+    async def _on_startup() -> None:
+        await init_global_queue_manager()
+        await setup_queue_commands()
+    
+    @app.on_event("shutdown")
+    async def _on_shutdown() -> None:
+        await shutdown_global_queue_manager()
+    
+    return app
+
+
+async def main():
+    """Main function to run the queue server with Hypercorn."""
+    print("🚀 Starting MCP Proxy Adapter Queue Server")
+    print("=" * 50)
+    
+    app = create_queue_server_app()
+
+    hc = HyperConfig()
+    hc.bind = ["0.0.0.0:8000"]
+    hc.loglevel = "info"
+
+    print("✅ MCP Queue Server will start at http://localhost:8000")
+    print("📝 Example usage:")
+    print("  curl -X POST http://localhost:8000/api/jsonrpc \\")
+    print("    -H 'Content-Type: application/json' \\")
+    print("    -d '{\"jsonrpc\": \"2.0\", \"method\": \"queue_health\", \"params\": {}, \"id\": 1}'")
+    print()
+
+    await serve(app, hc)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

mcp_proxy_adapter/examples/queue_server_simple.py

@@ -0,0 +1,173 @@
+#!/usr/bin/env python3
+"""
+Simple Queue Server for MCP Proxy Adapter.
+
+This example demonstrates how to run an MCP server with queue integration
+using a minimal configuration.
+
+Author: Vasiliy Zdanovskiy
+email: vasilyvz@gmail.com
+"""
+
+import asyncio
+import uvicorn
+from mcp_proxy_adapter.api.app import create_app
+from mcp_proxy_adapter.commands.command_registry import registry
+from mcp_proxy_adapter.commands.queue_commands import (
+    QueueAddJobCommand,
+    QueueStartJobCommand,
+    QueueStopJobCommand,
+    QueueDeleteJobCommand,
+    QueueGetJobStatusCommand,
+    QueueListJobsCommand,
+    QueueHealthCommand,
+)
+
+
+def setup_queue_commands():
+    """Setup queue management commands."""
+    print("🔧 Setting up queue management commands...")
+    
+    # Register queue commands
+    registry.register_custom(QueueAddJobCommand())
+    registry.register_custom(QueueStartJobCommand())
+    registry.register_custom(QueueStopJobCommand())
+    registry.register_custom(QueueDeleteJobCommand())
+    registry.register_custom(QueueGetJobStatusCommand())
+    registry.register_custom(QueueListJobsCommand())
+    registry.register_custom(QueueHealthCommand())
+    
+    print("✅ Queue commands registered")
+
+
+def create_queue_server_app():
+    """Create MCP server application with queue integration."""
+    # Create minimal config
+    config = {
+        "uuid": "123e4567-e89b-42d3-8a56-426614174000",
+        "server": {
+            "host": "172.28.0.1",
+            "port": 8000,
+            "protocol": "http",
+            "debug": False,
+            "log_level": "INFO"
+        },
+        "logging": {
+            "level": "INFO",
+            "file": None,
+            "log_dir": "./logs",
+            "log_file": "mcp_proxy_adapter.log",
+            "error_log_file": "mcp_proxy_adapter_error.log",
+            "access_log_file": "mcp_proxy_adapter_access.log",
+            "max_file_size": "10MB",
+            "backup_count": 5,
+            "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+            "date_format": "%Y-%m-%d %H:%M:%S",
+            "console_output": True,
+            "file_output": True
+        },
+        "commands": {
+            "auto_discovery": True,
+            "commands_directory": "./commands",
+            "catalog_directory": "./catalog",
+            "plugin_servers": [],
+            "auto_install_dependencies": True,
+            "enabled_commands": ["health", "echo", "list", "help"],
+            "disabled_commands": [],
+            "custom_commands_path": "./commands"
+        },
+        "transport": {
+            "type": "http",
+            "port": 8000
+        },
+        "ssl": {
+            "enabled": False
+        },
+        "proxy_registration": {
+            "enabled": True,
+            "proxy_url": "https://172.28.0.4:3004",
+            "server_id": "mcp_queue_server",
+            "server_name": "MCP Queue Server",
+            "description": "Queue management server with mTLS",
+            "version": "6.9.28",
+            "protocol": "mtls",
+            "ssl": {
+                "enabled": True,
+                "verify_ssl": False,
+                "verify_hostname": False,
+                "verify_mode": "CERT_REQUIRED",
+                "ca_cert": "./mtls_certificates/ca/ca.crt",
+                "cert_file": "./mtls_certificates/client/test-client.crt",
+                "key_file": "./mtls_certificates/client/test-client.key"
+            },
+            "certificate": {
+                "cert_file": "./mtls_certificates/client/test-client.crt",
+                "key_file": "./mtls_certificates/client/test-client.key"
+            },
+            "registration_timeout": 30,
+            "retry_attempts": 3,
+            "retry_delay": 5,
+            "auto_register_on_startup": True,
+            "auto_unregister_on_shutdown": True,
+            "heartbeat": {
+                "enabled": True,
+                "interval": 30,
+                "timeout": 10,
+                "retry_attempts": 3,
+                "retry_delay": 5,
+                "url": "/heartbeat"
+            }
+        },
+        "debug": {
+            "enabled": False,
+            "level": "WARNING"
+        },
+        "security": {
+            "enabled": False
+        },
+        "roles": {
+            "enabled": False
+        }
+    }
+    
+    # Register commands before creating the app
+    setup_queue_commands()
+    
+    app = create_app(app_config=config)
+    
+    @app.on_event("startup")
+    
+    @app.on_event("shutdown")
+    
+    return app
+
+
+async def main():
+    """Main function to run the queue server."""
+    print("🚀 Starting MCP Proxy Adapter Queue Server")
+    print("=" * 50)
+    
+    # Create the app
+    app = create_queue_server_app()
+    
+    # Run the server
+    config = uvicorn.Config(
+        app=app,
+        host="0.0.0.0",
+        port=8000,
+        log_level="info"
+    )
+    server = uvicorn.Server(config)
+    
+    print("✅ MCP Queue Server started at http://localhost:8000")
+    print("📝 Example usage:")
+    print("  curl -X POST http://localhost:8000/api/jsonrpc \\")
+    print("    -H 'Content-Type: application/json' \\")
+    print("    -d '{\"jsonrpc\": \"2.0\", \"method\": \"queue_health\", \"params\": {}, \"id\": 1}'")
+    print()
+    
+    await server.serve()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

mcp_proxy_adapter/examples/required_certificates.py

@@ -0,0 +1,208 @@
+#!/usr/bin/env python3
+"""
+Required Certificates Configuration
+Defines all certificates needed for testing different server configurations.
+
+Author: Vasiliy Zdanovskiy
+email: vasilyvz@gmail.com
+"""
+
+
+# Base paths
+CERTS_DIR = Path("certs")
+KEYS_DIR = Path("keys")
+
+# Required certificates for different server configurations
+REQUIRED_CERTIFICATES = {
+    # CA Certificate (required for all SSL/mTLS configurations)
+    "ca_cert": {
+        "type": "ca",
+        "common_name": "MCP Proxy Adapter Test CA",
+        "organization": "Test Organization",
+        "country": "US",
+        "state": "Test State",
+        "city": "Test City",
+        "validity_days": 3650,  # 10 years
+        "output_cert": CERTS_DIR / "ca_cert.pem",
+        "output_key": KEYS_DIR / "ca_key.pem",
+        "required_for": ["https", "mtls", "proxy_registration"]
+    },
+    
+    # Server Certificate for HTTPS configurations
+    "server_cert": {
+        "type": "server",
+        "common_name": "localhost",
+        "organization": "Test Organization", 
+        "country": "US",
+        "state": "Test State",
+        "city": "Test City",
+        "validity_days": 365,
+        "san": ["localhost", "127.0.0.1", "mcp-proxy-adapter-test.local"],
+        "ca_cert_path": CERTS_DIR / "ca_cert.pem",
+        "ca_key_path": KEYS_DIR / "ca_key.pem",
+        "output_cert": CERTS_DIR / "server_cert.pem",
+        "output_key": KEYS_DIR / "server_key.pem",
+        "required_for": ["https", "mtls"]
+    },
+    
+    # Admin Client Certificate
+    "admin_cert": {
+        "type": "client",
+        "common_name": "admin-client",
+        "organization": "Test Organization",
+        "country": "US", 
+        "state": "Test State",
+        "city": "Test City",
+        "validity_days": 365,
+        "roles": ["admin"],
+        "permissions": ["*"],
+        "ca_cert_path": CERTS_DIR / "ca_cert.pem",
+        "ca_key_path": KEYS_DIR / "ca_key.pem",
+        "output_cert": CERTS_DIR / "admin_cert.pem",
+        "output_key": KEYS_DIR / "admin_key.pem",
+        "required_for": ["mtls", "client_auth"]
+    },
+    
+    # User Client Certificate
+    "user_cert": {
+        "type": "client",
+        "common_name": "user-client",
+        "organization": "Test Organization",
+        "country": "US",
+        "state": "Test State", 
+        "city": "Test City",
+        "validity_days": 365,
+        "roles": ["user"],
+        "permissions": ["read", "write"],
+        "ca_cert_path": CERTS_DIR / "ca_cert.pem",
+        "ca_key_path": KEYS_DIR / "ca_key.pem",
+        "output_cert": CERTS_DIR / "user_cert.pem",
+        "output_key": KEYS_DIR / "user_key.pem",
+        "required_for": ["mtls", "client_auth"]
+    },
+    
+    # Proxy Certificate for proxy registration
+    "proxy_cert": {
+        "type": "server",
+        "common_name": "proxy-server",
+        "organization": "Test Organization",
+        "country": "US",
+        "state": "Test State",
+        "city": "Test City", 
+        "validity_days": 365,
+        "san": ["localhost", "127.0.0.1"],
+        "ca_cert_path": CERTS_DIR / "ca_cert.pem",
+        "ca_key_path": KEYS_DIR / "ca_key.pem",
+        "output_cert": CERTS_DIR / "proxy_cert.pem",
+        "output_key": KEYS_DIR / "proxy_key.pem",
+        "required_for": ["proxy_registration"]
+    }
+}
+
+# Certificate aliases for different configurations
+CERTIFICATE_ALIASES = {
+    # HTTPS configurations
+    "https_server_cert": "server_cert",
+    "https_server_key": "server_cert", 
+    
+    # mTLS configurations
+    "mtls_server_cert": "server_cert",
+    "mtls_server_key": "server_cert",
+    "mtls_ca_cert": "ca_cert",
+    
+    # Proxy registration
+    "proxy_server_cert": "proxy_cert",
+    "proxy_server_key": "proxy_cert",
+    
+    # Legacy names for compatibility
+    "localhost_server_cert": "server_cert",
+    "mcp_proxy_adapter_server_cert": "server_cert",
+    "mcp_proxy_adapter_ca_cert": "ca_cert"
+}
+
+# Configuration file mappings
+CONFIG_CERTIFICATE_MAPPINGS = {
+    "https_simple.json": {
+        "ssl.cert_file": "certs/server_cert.pem",
+        "ssl.key_file": "keys/server_key.pem",
+        "ssl.ca_cert": "certs/ca_cert.pem"
+    },
+    "https_auth.json": {
+        "ssl.cert_file": "certs/server_cert.pem", 
+        "ssl.key_file": "keys/server_key.pem",
+        "ssl.ca_cert": "certs/ca_cert.pem"
+    },
+    "https_token.json": {
+        "ssl.cert_file": "certs/server_cert.pem",
+        "ssl.key_file": "keys/server_key.pem", 
+        "ssl.ca_cert": "certs/ca_cert.pem"
+    },
+    "mtls_simple.json": {
+        "ssl.cert_file": "certs/server_cert.pem",
+        "ssl.key_file": "keys/server_key.pem",
+        "ssl.ca_cert": "certs/ca_cert.pem",
+        "ssl.client_cert_file": "certs/admin_cert.pem",
+        "ssl.client_key_file": "keys/admin_key.pem"
+    },
+    "mtls_no_roles.json": {
+        "ssl.cert_file": "certs/server_cert.pem",
+        "ssl.key_file": "keys/server_key.pem",
+        "ssl.ca_cert": "certs/ca_cert.pem"
+    },
+    "mtls_with_roles.json": {
+        "ssl.cert_file": "certs/server_cert.pem",
+        "ssl.key_file": "keys/server_key.pem",
+        "ssl.ca_cert": "certs/ca_cert.pem",
+        "ssl.client_cert_file": "certs/admin_cert.pem", 
+        "ssl.client_key_file": "keys/admin_key.pem"
+    },
+    "mtls_with_proxy.json": {
+        "ssl.cert_file": "certs/server_cert.pem",
+        "ssl.key_file": "keys/server_key.pem",
+        "ssl.ca_cert": "certs/ca_cert.pem",
+        "ssl.client_cert_file": "certs/admin_cert.pem",
+        "ssl.client_key_file": "keys/admin_key.pem",
+        "proxy_registration.ssl.ca_cert": "certs/ca_cert.pem"
+    }
+}
+
+def get_required_certificates_for_config(config_name: str) -> List[str]:
+    """Get list of required certificates for a specific configuration."""
+    if config_name not in CONFIG_CERTIFICATE_MAPPINGS:
+        return []
+    
+    required = []
+    mappings = CONFIG_CERTIFICATE_MAPPINGS[config_name]
+    
+    for cert_path in mappings.values():
+        if "server_cert.pem" in cert_path:
+            required.append("server_cert")
+        elif "ca_cert.pem" in cert_path:
+            required.append("ca_cert")
+        elif "admin_cert.pem" in cert_path:
+            required.append("admin_cert")
+        elif "proxy_cert.pem" in cert_path:
+            required.append("proxy_cert")
+    
+    return list(set(required))
+
+def get_all_required_certificates() -> List[str]:
+    """Get list of all required certificates."""
+    all_certs = set()
+    for config_name in CONFIG_CERTIFICATE_MAPPINGS.keys():
+        all_certs.update(get_required_certificates_for_config(config_name))
+    return list(all_certs)
+
+if __name__ == "__main__":
+    print("📋 Required Certificates Configuration")
+    print("=" * 50)
+    
+    all_required = get_all_required_certificates()
+    print(f"Total certificates needed: {len(all_required)}")
+    print(f"Certificates: {', '.join(all_required)}")
+    
+    print(f"\n📁 Certificate files to create:")
+    for cert_name in all_required:
+        cert_info = REQUIRED_CERTIFICATES[cert_name]
+        print(f"  {cert_info['output_cert']}")
+        print(f"  {cert_info['output_key']}")

mcp_proxy_adapter/examples/run_example.py

@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+"""
+Example Runner Script
+This script provides a simple way to run the examples.
+Author: Vasiliy Zdanovskiy
+email: vasilyvz@gmail.com
+"""
+import sys
+import subprocess
+import argparse
+from pathlib import Path
+
+
+def run_basic_example(config_name: str, port: int = None):
+    """Run basic framework example."""
+    config_path = (
+        Path(__file__).parent / "basic_framework" / "configs" / f"{config_name}.json"
+    )
+    main_script = Path(__file__).parent / "basic_framework" / "main.py"
+    if not config_path.exists():
+        print(f"❌ Configuration file not found: {config_path}")
+        return False
+    cmd = [sys.executable, str(main_script), "--config", str(config_path)]
+    if port:
+        cmd.extend(["--port", str(port)])
+    print(f"🚀 Running basic framework example with {config_name} configuration...")
+    return subprocess.run(cmd).returncode == 0
+
+
+def run_full_example(config_name: str, port: int = None):
+    """Run full application example."""
+    config_path = (
+        Path(__file__).parent / "full_application" / "configs" / f"{config_name}.json"
+    )
+    main_script = Path(__file__).parent / "full_application" / "main.py"
+    if not config_path.exists():
+        print(f"❌ Configuration file not found: {config_path}")
+        return False
+    cmd = [sys.executable, str(main_script), "--config", str(config_path)]
+    if port:
+        cmd.extend(["--port", str(port)])
+    print(f"🚀 Running full application example with {config_name} configuration...")
+    return subprocess.run(cmd).returncode == 0
+
+
+def main():
+    """Main function."""
+    parser = argparse.ArgumentParser(description="Run MCP Proxy Adapter Examples")
+    parser.add_argument("example", choices=["basic", "full"], help="Example type")
+    parser.add_argument(
+        "config", help="Configuration name (e.g., http_simple, https_auth)"
+    )
+    parser.add_argument("--port", type=int, help="Override port")
+    args = parser.parse_args()
+    # Available configurations
+    configs = [
+        "http_simple",
+        "https_simple",
+        "http_auth",
+        "https_auth",
+        "mtls_no_roles",
+        "mtls_with_roles",
+    ]
+    if args.config not in configs:
+        print(f"❌ Unknown configuration: {args.config}")
+        print(f"Available configurations: {', '.join(configs)}")
+        return 1
+    # Run the appropriate example
+    if args.example == "basic":
+        success = run_basic_example(args.config, args.port)
+    else:
+        success = run_full_example(args.config, args.port)
+    return 0 if success else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())