mcp-proxy-adapter 2.1.16__py3-none-any.whl → 3.0.0__py3-none-any.whl

mcp_proxy_adapter/examples/analyze_config.py

@@ -1,141 +0,0 @@
-"""
-Analysis of MCP Proxy configuration generated by the adapter.
-
-This script loads and analyzes the MCP Proxy configuration file
-that was created by MCPProxyAdapter, and outputs structured
-information about routes and tools.
-
-Usage:
-    python examples/analyze_config.py
-"""
-import os
-import json
-import sys
-from typing import Dict, Any, List
-
-
-def load_config_file(config_path: str) -> Dict[str, Any]:
-    """
-    Loads MCP Proxy configuration file.
-    
-    Args:
-        config_path (str): Path to configuration file
-        
-    Returns:
-        Dict[str, Any]: Loaded configuration
-        
-    Raises:
-        FileNotFoundError: If file is not found
-        json.JSONDecodeError: If file is not valid JSON
-    """
-    try:
-        with open(config_path, 'r', encoding='utf-8') as f:
-            return json.load(f)
-    except FileNotFoundError:
-        print(f"Error: Configuration file not found: {config_path}")
-        sys.exit(1)
-    except json.JSONDecodeError as e:
-        print(f"Error: File is not valid JSON: {e}")
-        sys.exit(1)
-
-
-def print_routes(config: Dict[str, Any]) -> None:
-    """
-    Prints route information from configuration.
-    
-    Args:
-        config (Dict[str, Any]): MCP Proxy configuration
-    """
-    if "routes" not in config:
-        print("No routes in configuration")
-        return
-    
-    routes = config["routes"]
-    print(f"=== Routes ({len(routes)}) ===")
-    
-    for i, route in enumerate(routes, 1):
-        print(f"\n{i}. Route:")
-        print(f"   Endpoint: {route.get('endpoint', 'Not specified')}")
-        print(f"   Method: {route.get('method', 'Not specified')}")
-        
-        if "json_rpc" in route:
-            print("   Type: JSON-RPC")
-            if "params" in route["json_rpc"]:
-                print(f"   Parameters: {route['json_rpc'].get('params', 'Not specified')}")
-        else:
-            print("   Type: Regular HTTP")
-
-
-def print_tools(config: Dict[str, Any]) -> None:
-    """
-    Prints tool information from configuration.
-    
-    Args:
-        config (Dict[str, Any]): MCP Proxy configuration
-    """
-    if "tools" not in config:
-        print("No tools in configuration")
-        return
-    
-    tools = config["tools"]
-    print(f"\n=== Tools ({len(tools)}) ===")
-    
-    for i, tool in enumerate(tools, 1):
-        print(f"\n{i}. Tool:")
-        print(f"   Name: {tool.get('name', 'Not specified')}")
-        print(f"   Description: {tool.get('description', 'Not specified')}")
-        
-        if "parameters" in tool:
-            params = tool["parameters"]
-            required_params = params.get("required", [])
-            properties = params.get("properties", {})
-            
-            print(f"   Parameters ({len(properties)}):") 
-            for param_name, param_info in properties.items():
-                required = "Required" if param_name in required_params else "Optional"
-                param_type = param_info.get("type", "Not specified")
-                description = param_info.get("description", "Not specified")
-                
-                print(f"     - {param_name} ({param_type}, {required}):")
-                print(f"       {description}")
-
-
-def analyze_config(config_path: str) -> None:
-    """
-    Analyzes MCP Proxy configuration.
-    
-    Args:
-        config_path (str): Path to configuration file
-    """
-    config = load_config_file(config_path)
-    
-    print("\n=== MCP Proxy Configuration Analysis ===")
-    print(f"File: {config_path}")
-    print(f"Version: {config.get('version', 'Not specified')}")
-    
-    print_routes(config)
-    print_tools(config)
-    
-    print("\n=== Summary ===")
-    num_routes = len(config.get("routes", []))
-    num_tools = len(config.get("tools", []))
-    
-    print(f"Configuration contains {num_routes} routes and {num_tools} tools.")
-    
-    if num_tools > 0 and num_routes > 0:
-        print("MCP Proxy is configured correctly and ready to use.")
-    else:
-        print("WARNING: Configuration may be incomplete or incorrect.")
-
-
-def main():
-    """Main script function."""
-    # Define path to configuration file
-    config_path = os.path.join(os.path.dirname(__file__), "mcp_proxy_config.json")
-    
-    # Analyze configuration
-    analyze_config(config_path)
-
-
-if __name__ == "__main__":
-    main() 

mcp_proxy_adapter/examples/basic_integration.py

@@ -1,155 +0,0 @@
-"""
-Example of basic MCPProxyAdapter integration with an existing FastAPI application.
-"""
-import logging
-import os
-import sys
-from typing import Dict, Any, List, Optional
-
-# Add parent directory to import path
-current_dir = os.path.dirname(os.path.abspath(__file__))
-parent_dir = os.path.dirname(current_dir)
-if parent_dir not in sys.path:
-    sys.path.insert(0, parent_dir)
-
-from fastapi import FastAPI, HTTPException, APIRouter
-from pydantic import BaseModel
-from mcp_proxy_adapter.adapter import MCPProxyAdapter, configure_logger
-from mcp_proxy_adapter.registry import CommandRegistry
-
-# Configure project logging
-logging.basicConfig(
-    level=logging.INFO,
-    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
-)
-
-# Create project logger
-project_logger = logging.getLogger("my_project")
-project_logger.setLevel(logging.DEBUG)
-
-# Configure adapter logger using project logger
-adapter_logger = configure_logger(project_logger)
-
-# Create FastAPI application
-app = FastAPI(
-    title="My API with MCP Proxy Integration",
-    description="API with Command Registry integration, supporting MCP Proxy",
-    version="1.0.0"
-)
-
-# Define existing endpoints
-router = APIRouter()
-
-class Item(BaseModel):
-    name: str
-    price: float
-    is_active: bool = True
-
-@router.get("/items", response_model=List[Item])
-async def get_items():
-    """Returns list of items."""
-    return [
-        {"name": "Item 1", "price": 10.5, "is_active": True},
-        {"name": "Item 2", "price": 20.0, "is_active": False},
-        {"name": "Item 3", "price": 30.0, "is_active": True},
-    ]
-
-@router.get("/items/{item_id}", response_model=Item)
-async def get_item(item_id: int):
-    """Returns item information by ID."""
-    items = [
-        {"name": "Item 1", "price": 10.5, "is_active": True},
-        {"name": "Item 2", "price": 20.0, "is_active": False},
-        {"name": "Item 3", "price": 30.0, "is_active": True},
-    ]
-    
-    if item_id < 1 or item_id > len(items):
-        raise HTTPException(status_code=404, detail="Item not found")
-    
-    return items[item_id - 1]
-
-# Add existing endpoints to application
-app.include_router(router)
-
-# Define commands for Command Registry
-def list_items() -> List[Dict[str, Any]]:
-    """
-    Returns list of all items.
-    
-    Returns:
-        List[Dict[str, Any]]: List of items
-    """
-    return [
-        {"name": "Item 1", "price": 10.5, "is_active": True},
-        {"name": "Item 2", "price": 20.0, "is_active": False},
-        {"name": "Item 3", "price": 30.0, "is_active": True},
-    ]
-
-def get_item_by_id(item_id: int) -> Dict[str, Any]:
-    """
-    Returns item information by ID.
-    
-    Args:
-        item_id: Item ID
-        
-    Returns:
-        Dict[str, Any]: Item information
-        
-    Raises:
-        ValueError: If item is not found
-    """
-    items = list_items()
-    
-    if item_id < 1 or item_id > len(items):
-        raise ValueError(f"Item with ID {item_id} not found")
-    
-    return items[item_id - 1]
-
-def search_items(query: str, min_price: Optional[float] = None, max_price: Optional[float] = None) -> List[Dict[str, Any]]:
-    """
-    Searches for items by name and price range.
-    
-    Args:
-        query: Search query for name
-        min_price: Minimum price (optional)
-        max_price: Maximum price (optional)
-        
-    Returns:
-        List[Dict[str, Any]]: List of found items
-    """
-    items = list_items()
-    
-    # Filter by name
-    filtered_items = [item for item in items if query.lower() in item["name"].lower()]
-    
-    # Filter by minimum price
-    if min_price is not None:
-        filtered_items = [item for item in filtered_items if item["price"] >= min_price]
-    
-    # Filter by maximum price
-    if max_price is not None:
-        filtered_items = [item for item in filtered_items if item["price"] <= max_price]
-    
-    return filtered_items
-
-# Create CommandRegistry instance
-registry = CommandRegistry()
-
-# Register commands
-registry.register_command("list_items", list_items)
-registry.register_command("get_item", get_item_by_id)
-registry.register_command("search_items", search_items)
-
-# Create MCP Proxy adapter
-adapter = MCPProxyAdapter(registry)
-
-# Register endpoints in existing application
-adapter.register_endpoints(app)
-
-# Save configuration for MCP Proxy
-adapter.save_config_to_file("mcp_proxy_config.json")
-
-# Entry point for running the application
-if __name__ == "__main__":
-    import uvicorn
-    uvicorn.run(app, host="0.0.0.0", port=8000) 

mcp_proxy_adapter/examples/docstring_and_schema_example.py

@@ -1,69 +0,0 @@
-"""
-Docstring and Schema Example for MCPProxyAdapter
-
-- How to write docstrings for commands
-- How docstrings are used in OpenAPI/schema
-- Best practices for documenting parameters and return values
-
-Run:
-    python examples/docstring_and_schema_example.py
-"""
-import os
-import sys
-import asyncio
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-
-class MyRegistry:
-    def __init__(self):
-        self.dispatcher = self
-        self.commands = {"sum": self.sum_numbers}
-        self.commands_info = {
-            "sum": {
-                "description": self.sum_numbers.__doc__,
-                "params": {
-                    "a": {"type": "integer", "description": "First number", "required": True},
-                    "b": {"type": "integer", "description": "Second number", "required": True}
-                }
-            }
-        }
-    def get_valid_commands(self):
-        return list(self.commands.keys())
-    def get_command_info(self, command):
-        return self.commands_info.get(command)
-    def get_commands_info(self):
-        return self.commands_info
-    def execute(self, command, **params):
-        if command == "sum":
-            return self.sum_numbers(**params)
-        raise KeyError(f"Unknown command: {command}")
-    def add_generator(self, generator):
-        pass
-    def sum_numbers(self, a: int, b: int) -> int:
-        """
-        Returns the sum of two numbers.
-        
-        Args:
-            a (int): First number
-            b (int): Second number
-        
-        Returns:
-            int: The sum of a and b
-        """
-        return a + b
-
-if __name__ == "__main__":
-    registry = MyRegistry()
-    adapter = MCPProxyAdapter(registry)
-    # Print OpenAPI schema (simulated)
-    schema = adapter.generate_mcp_proxy_config()
-    print("=== Tool description from docstring ===")
-    print(schema.tools[0].description)
-
-    # Call sync handler
-    result_sync = registry.execute('sum', a=10, b=1)
-    print(result_sync)  # 11
-
-    # Call sync handler (ещё раз)
-    result_sync2 = registry.execute('sum', a=10, b=10)
-    print(result_sync2)  # 20 

mcp_proxy_adapter/examples/extension_example.py

@@ -1,72 +0,0 @@
-"""
-Extension Example for MCPProxyAdapter
-
-- How to add custom commands
-- How to extend help logic
-- How to customize error handling
-
-Run:
-    python examples/extension_example.py
-"""
-import os
-import sys
-import asyncio
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-
-class MyRegistry:
-    def __init__(self):
-        self.dispatcher = self
-        self.commands = {"ping": self.ping, "help": self.help_command}
-        self.commands_info = {
-            "ping": {"description": "Ping command (returns pong)", "params": {}},
-            "help": {"description": "Show help for commands", "params": {"cmdname": {"type": "string", "description": "Command name", "required": False}}}
-        }
-    def get_valid_commands(self):
-        return list(self.commands.keys())
-    def get_command_info(self, command):
-        return self.commands_info.get(command)
-    def get_commands_info(self):
-        return self.commands_info
-    def execute(self, *args, **params):
-        if args:
-            command = args[0]
-            params = {k: v for k, v in params.items()}
-        else:
-            command = params.pop("cmdname", None)
-        if command == "ping":
-            return self.ping()
-        if command == "help":
-            return self.help_command(**params)
-        raise KeyError(f"Unknown command: {command}")
-    def add_generator(self, generator):
-        pass
-    def ping(self):
-        """Ping command."""
-        return {"result": "pong"}
-    def help_command(self, cmdname: str = None):
-        """Custom help logic: returns info for command or all commands."""
-        if not cmdname:
-            return {"commands": list(self.commands_info.keys())}
-        if cmdname in self.commands_info:
-            return {"command": cmdname, "info": self.commands_info[cmdname]}
-        return {"error": f"Command '{cmdname}' not found"}
-
-if __name__ == "__main__":
-    registry = MyRegistry()
-    adapter = MCPProxyAdapter(registry)
-    # Call sync handler
-    result_sync = registry.execute("ping")
-    print(result_sync)  # Ping
-
-    # Call help (all)
-    result_help_all = registry.execute("help")
-    print("Help (all)", result_help_all)
-
-    # Call help (ping)
-    result_help_ping = registry.execute("help", cmdname="ping")
-    print("Help (ping)", result_help_ping)
-
-    # Call help (notfound)
-    result_help_notfound = registry.execute("help", cmdname="notfound")
-    print("Help (notfound)", result_help_notfound) 

mcp_proxy_adapter/examples/help_best_practices.py

@@ -1,67 +0,0 @@
-"""
-Best Practices: Integrating and Testing 'help' Command in MCPProxyAdapter
-
-This example demonstrates:
-- How to robustly integrate a project-level 'help' command
-- How to extend help with custom logic
-- How to test help scenarios (including fallback and error cases)
-- How to avoid common mistakes
-
-Run:
-    python examples/help_best_practices.py
-"""
-import os
-import sys
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../..')))
-from typing import Any, Dict
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-from mcp_proxy_adapter.testing_utils import MockRegistry
-
-# --- Setup registry and adapter ---
-registry = MockRegistry()
-adapter = MCPProxyAdapter(registry)
-
-def robust_help(cmdname: str = None) -> Dict[str, Any]:
-    """
-    Best practice: always check for project help, handle errors, fallback to adapter help.
-    """
-    dispatcher = registry.dispatcher
-    if "help" in dispatcher.get_valid_commands():
-        try:
-            if cmdname:
-                return dispatcher.help_command(cmdname=cmdname)
-            return dispatcher.help_command()
-        except Exception as e:
-            # Log error, fallback to adapter help
-            print(f"[WARN] Project help failed: {e}. Fallback to adapter help.")
-            return fallback_adapter_help(cmdname)
-    else:
-        return fallback_adapter_help(cmdname)
-
-def fallback_adapter_help(cmdname: str = None) -> Dict[str, Any]:
-    """
-    Fallback: call adapter's help (simulate REST/JSON-RPC call).
-    """
-    dispatcher = registry.dispatcher
-    if not cmdname:
-        return {"source": "adapter", "commands": dispatcher.get_valid_commands()}
-    if cmdname in dispatcher.get_valid_commands():
-        return {"source": "adapter", "command": cmdname, "info": {"description": "Adapter help for command"}}
-    return {"source": "adapter", "error": f"Command '{cmdname}' not found (adapter)", "available_commands": dispatcher.get_valid_commands()}
-
-# --- Example test cases ---
-def test_help():
-    """Test all help scenarios."""
-    print("[TEST] Project help (no param):", robust_help())
-    print("[TEST] Project help (existing command):", robust_help("success"))
-    print("[TEST] Project help (nonexistent command, triggers fallback):", robust_help("not_a_command"))
-    # Simulate registry without help
-    registry_no_help = MockRegistry()
-    if "help" in registry_no_help.dispatcher.commands:
-        del registry_no_help.dispatcher.commands["help"]
-    global registry
-    registry = registry_no_help
-    print("[TEST] Adapter help (no project help present):", robust_help("success"))
-
-if __name__ == "__main__":
-    test_help() 

mcp_proxy_adapter/examples/help_usage.py

@@ -1,64 +0,0 @@
-"""
-Example: Using 'help' command with MCPProxyAdapter
-
-This script demonstrates how to:
-- Call the 'help' command (if present in the project)
-- Call 'help' with a parameter (for a specific command)
-- Handle errors and fallback to adapter help
-- Best practices for integrating and extending help
-
-Run:
-    python examples/help_usage.py
-"""
-import os
-import sys
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../..')))
-from typing import Any, Dict
-
-# Assume MCPProxyAdapter and MockRegistry are available from src and tests
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-from mcp_proxy_adapter.testing_utils import MockRegistry
-
-# --- Setup registry and adapter ---
-registry = MockRegistry()
-adapter = MCPProxyAdapter(registry)
-
-# --- Best practice: always check if 'help' is in commands ---
-def call_help(cmdname: str = None) -> Dict[str, Any]:
-    """Call help command with or without parameter."""
-    dispatcher = registry.dispatcher
-    if "help" in dispatcher.get_valid_commands():
-        if cmdname:
-            try:
-                return dispatcher.help_command(cmdname=cmdname)
-            except Exception as e:
-                print(f"Project help failed: {e}. Fallback to adapter help.")
-                return adapter_help(cmdname)
-        else:
-            return dispatcher.help_command()
-    else:
-        return adapter_help(cmdname)
-
-def adapter_help(cmdname: str = None) -> Dict[str, Any]:
-    """Fallback: call adapter's help (simulate)."""
-    dispatcher = registry.dispatcher
-    if not cmdname:
-        return {"source": "adapter", "commands": dispatcher.get_valid_commands()}
-    if cmdname in dispatcher.get_valid_commands():
-        return {"source": "adapter", "command": cmdname, "info": {"description": "Adapter help for command"}}
-    return {"source": "adapter", "error": f"Command '{cmdname}' not found (adapter)", "available_commands": dispatcher.get_valid_commands()}
-
-if __name__ == "__main__":
-    print("=== Project help (no param) ===")
-    print(call_help())
-    print("\n=== Project help (existing command) ===")
-    print(call_help("success"))
-    print("\n=== Project help (nonexistent command, triggers fallback) ===")
-    print(call_help("not_a_command"))
-    print("\n=== Adapter help (no project help present) ===")
-    # Simulate registry without help
-    registry_no_help = MockRegistry()
-    if "help" in registry_no_help.dispatcher.commands:
-        del registry_no_help.dispatcher.commands["help"]
-    adapter_no_help = MCPProxyAdapter(registry_no_help)
-    print(adapter_help("success"))