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

examples/minimal_example/main.py

@@ -1,63 +1,132 @@
 """
-Main application module.
+Минимальный пример приложения MCP Proxy Adapter.
 """
 
 import os
 import sys
 import uvicorn
 import logging
+import json
+from pathlib import Path
 
-from mcp_proxy_adapter.api.app import app
+from mcp_proxy_adapter import create_app, Command, SuccessResult
+from mcp_proxy_adapter.commands.command_registry import registry
+from mcp_proxy_adapter.core.logging import logger
 from mcp_proxy_adapter.config import config
-from mcp_proxy_adapter.core.logging import logger, setup_logging
 
 
-def main():
+class HelloCommand(Command):
+    """Простая команда, возвращающая приветствие."""
+    
+    name = "hello"
+    
+    async def execute(self, name: str = "World") -> SuccessResult:
+        """Выполняет команду с переданным именем."""
+        logger.info(f"Executing hello command with name: {name}")
+        return SuccessResult({"message": f"Hello, {name}!"})
+
+
+def ensure_config():
+    """Проверяет наличие конфигурационного файла и создает его при необходимости."""
+    config_path = Path("config.json")
+    
+    if not config_path.exists():
+        config_data = {
+            "server": {
+                "host": "0.0.0.0",
+                "port": 8000,
+                "debug": True,
+                "log_level": "INFO"
+            },
+            "logging": {
+                "level": "info",
+                "file": "logs/minimal_example.log",
+                "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+            },
+            "debug": True
+        }
+        
+        # Создаем директорию для логов
+        logs_dir = Path("logs")
+        logs_dir.mkdir(exist_ok=True)
+        
+        # Записываем конфигурацию
+        with open(config_path, "w") as f:
+            json.dump(config_data, f, indent=2)
+        
+        logger.info(f"Created default configuration at {config_path}")
+
+
+def setup_application():
     """
-    Main function to run the application.
+    Настраивает и возвращает FastAPI приложение.
     """
-    # Убедимся что логирование настроено
-    logger.info("Initializing logging configuration")
+    # Проверяем наличие конфигурационного файла
+    ensure_config()
+    
+    # Определяем путь к конфигурационному файлу
+    config_path = Path("config.json").absolute()
+    
+    # Загружаем конфигурацию из файла
+    if config_path.exists():
+        config.load_from_file(str(config_path))
+        logger.info(f"Loaded configuration from {config_path}")
     
+    # Создаем приложение
+    app = create_app()
+    
+    # Корректно регистрируем команду
     try:
-        # Получаем настройки логирования
-        log_level = config.get("logging.level", "INFO")
-        log_file = config.get("logging.file")
-        rotation_type = config.get("logging.rotation.type", "size")
+        # Проверяем, есть ли уже команда в реестре
+        if registry.command_exists(HelloCommand.name):
+            # Если команда существует, удаляем ее
+            logger.info(f"Command '{HelloCommand.name}' already exists, re-registering it")
+            registry.unregister(HelloCommand.name)
         
-        # Выводим информацию о настройках логирования
-        logger.info(f"Log level: {log_level}")
-        if log_file:
-            logger.info(f"Log file: {log_file}")
-            logger.info(f"Log rotation type: {rotation_type}")
-            
-            if rotation_type.lower() == "time":
-                when = config.get("logging.rotation.when", "D")
-                interval = config.get("logging.rotation.interval", 1)
-                logger.info(f"Log rotation: every {interval} {when}")
-            else:
-                max_bytes = config.get("logging.rotation.max_bytes", 10 * 1024 * 1024)
-                logger.info(f"Log rotation: when size reaches {max_bytes / (1024*1024):.1f} MB")
-                
-            backup_count = config.get("logging.rotation.backup_count", 5)
-            logger.info(f"Log backups: {backup_count}")
-        else:
-            logger.info("File logging is disabled")
-            
-        # Get server settings
+        # Регистрируем команду
+        registry.register(HelloCommand)
+        logger.info(f"Command '{HelloCommand.name}' successfully registered")
+        
+        # Выводим список всех зарегистрированных команд
+        commands = registry.get_all_commands()
+        logger.info(f"Total registered commands: {len(commands)}")
+    except Exception as e:
+        logger.error(f"Error registering command: {e}")
+    
+    return app
+
+
+def main():
+    """
+    Основная функция для запуска приложения.
+    """
+    try:
+        # Настраиваем приложение
+        app = setup_application()
+        
+        # Получаем настройки сервера из конфигурации
         host = config.get("server.host", "0.0.0.0")
         port = config.get("server.port", 8000)
+        debug = config.get("server.debug", False)
         
-        logger.info(f"Starting server on {host}:{port}")
+        logger.info(f"Starting server on {host}:{port} (debug: {debug})")
         
-        # Run server
-        uvicorn.run(
-            app,
-            host=host,
-            port=port,
-            reload=True if os.environ.get("DEBUG") else False,
-            log_level=log_level.lower()
-        )
+        if debug:
+            # В режиме отладки запускаем с перезагрузкой, используя строку импорта
+            uvicorn.run(
+                "main:setup_application",
+                host=host,
+                port=port,
+                reload=True,
+                factory=True
+            )
+        else:
+            # В обычном режиме запускаем экземпляр приложения
+            uvicorn.run(
+                app,
+                host=host,
+                port=port
+            )
     except Exception as e:
         logger.exception(f"Error during application startup: {e}")
         sys.exit(1)

examples/minimal_example/simple_server.py

@@ -1,15 +1,17 @@
 """
-Минимальный пример использования MCP Microservice.
+Минимальный пример использования MCP Proxy Adapter.
 
 Этот пример демонстрирует минимальную конфигурацию для запуска микросервиса
 с одной простой командой.
 """
 
 import os
-from typing import Dict, Any
+import uvicorn
+from typing import Dict, Any, List
 
-import mcp_proxy_adapter as mcp
-from mcp_proxy_adapter import Command, SuccessResult
+from mcp_proxy_adapter import Command, SuccessResult, create_app, registry
+from mcp_proxy_adapter.core.logging import setup_logging
+from mcp_proxy_adapter.config import config
 
 
 class HelloResult(SuccessResult):
@@ -97,27 +99,64 @@ class HelloCommand(Command):
             },
             "additionalProperties": False
         }
+    
+    @classmethod
+    def _generate_examples(cls, params: Dict[str, Dict[str, Any]]) -> List[Dict[str, Any]]:
+        """
+        Генерирует примеры использования команды.
+        
+        Args:
+            params: Информация о параметрах команды
+            
+        Returns:
+            Список примеров
+        """
+        return [
+            {
+                "command": "hello",
+                "description": "Приветствие по умолчанию"
+            },
+            {
+                "command": "hello",
+                "params": {"name": "User"},
+                "description": "Приветствие с указанным именем"
+            }
+        ]
 
 
 def main():
     """Запуск микросервиса."""
     # Определяем путь к конфигурационному файлу
     current_dir = os.path.dirname(os.path.abspath(__file__))
-    config_path = os.path.join(current_dir, "config.yaml")
+    config_path = os.path.join(current_dir, "config.json")
     
-    # Создаем микросервис
-    service = mcp.MicroService(
-        title="Minimal Example",
-        description="Минимальный пример использования MCP Microservice",
-        version="1.0.0",
-        config_path=config_path
-    )
+    # Загружаем конфигурацию, если файл существует
+    if os.path.exists(config_path):
+        config.load_from_file(config_path)
+    
+    # Настраиваем логирование
+    setup_logging("INFO")
+    
+    # Создаем приложение FastAPI
+    app = create_app()
+    app.title = "Minimal Example"
+    app.description = "Минимальный пример использования MCP Proxy Adapter"
+    app.version = "1.0.0"
     
     # Регистрируем команду
-    service.register_command(HelloCommand)
+    registry.register(HelloCommand)
+    
+    # Определяем порт из переменной окружения или используем 8000 по умолчанию
+    port = int(os.environ.get("TEST_SERVER_PORT", 8000))
     
     # Запускаем сервер
-    service.run(reload=True)
+    uvicorn.run(
+        app,
+        host="0.0.0.0",
+        port=port,
+        reload=False,  # Отключаем автоперезагрузку для тестов
+        log_level="info"
+    )
 
 
 if __name__ == "__main__":

examples/minimal_example/tests/conftest.py

@@ -49,7 +49,7 @@ class ServerProcess:
     def start(self) -> None:
         """Start the server in a separate process."""
         def run_server():
-            # Mock the configuration to use the test port
+            # Set the test port via environment variable
             os.environ["TEST_SERVER_PORT"] = str(self.port)
             simple_server.main()
             

examples/minimal_example/tests/test_integration.py

@@ -1,5 +1,5 @@
 """
-Integration tests for the minimal example microservice.
+Integration tests for the minimal example of MCP Proxy Adapter.
 
 These tests start a real server instance and test the API endpoints.
 """
@@ -145,9 +145,9 @@ class TestServerIntegration:
         assert "info" in schema
         assert "paths" in schema
         
-        # Check hello command paths
-        assert "/api/command/hello" in schema["paths"]
-        assert "/api/jsonrpc" in schema["paths"]
+        # Проверяем наличие основных эндпоинтов
+        assert "/api/jsonrpc" in schema["paths"] or "/cmd" in schema["paths"]
+        assert "/api/commands" in schema["paths"]
         
     def test_docs_endpoint(self, server: ServerProcess, api_url: str):
         """Test the Swagger UI endpoint."""
@@ -170,14 +170,12 @@ class TestServerIntegration:
         
         # Check data structure
         assert "commands" in data
-        assert isinstance(data["commands"], list)
+        assert isinstance(data["commands"], dict)  # Теперь commands это словарь, а не список
         
         # Check if hello command is in the list
-        hello_commands = [cmd for cmd in data["commands"] if cmd["name"] == "hello"]
-        assert len(hello_commands) == 1
+        assert "hello" in data["commands"]
         
         # Check hello command details
-        hello_cmd = hello_commands[0]
+        hello_cmd = data["commands"]["hello"]
         assert "name" in hello_cmd
-        assert "description" in hello_cmd
-        assert "parameters" in hello_cmd 
+        assert hello_cmd["name"] == "hello" 

examples/simple_server.py

@@ -3,24 +3,21 @@
 Простой пример запуска сервера JSON-RPC с использованием MCP Proxy Adapter.
 
 Этот скрипт демонстрирует минимальную конфигурацию для запуска сервера JSON-RPC.
-Он создаёт экземпляр MicroService, регистрирует несколько команд и запускает сервер.
+Он создаёт экземпляр приложения FastAPI с MCP Proxy Adapter и регистрирует пользовательские команды.
 """
 
 import os
 import argparse
 import sys
 from pathlib import Path
+import uvicorn
 
 # Добавляем родительскую директорию в PYTHONPATH для импорта mcp_proxy_adapter
 sys.path.insert(0, str(Path(__file__).parent.parent))
 
-import mcp_proxy_adapter as mcp
-from mcp_proxy_adapter.framework import MicroService
-from examples.commands.echo_command import EchoCommand
-from examples.commands.get_date_command import GetDateCommand
-from examples.commands.new_uuid4_command import NewUuid4Command
+from mcp_proxy_adapter import Command, SuccessResult, create_app
+from mcp_proxy_adapter.commands.command_registry import registry
 from typing import Dict, Any, Optional
-from mcp_proxy_adapter import Command, SuccessResult
 
 
 class HelloResult(SuccessResult):
@@ -104,25 +101,19 @@ def main():
     parser.add_argument("--host", default="0.0.0.0", help="Host to bind server")
     parser.add_argument("--port", type=int, default=8000, help="Port to bind server")
     parser.add_argument("--reload", action="store_true", help="Enable auto-reload")
-    parser.add_argument("--config", help="Path to config file")
     
     args = parser.parse_args()
     
-    # Создаем экземпляр микросервиса
-    service = MicroService(
-        title="Simple Example Service",
-        description="Example microservice demonstrating basic functionality",
-        version="1.0.0",
-        config_path=args.config
-    )
+    # Регистрируем только свою пользовательскую команду
+    # встроенные команды и примеры регистрируются автоматически
+    registry.register(HelloCommand)
     
-    # Регистрируем команды
-    service.register_command(EchoCommand)
-    service.register_command(GetDateCommand)
-    service.register_command(NewUuid4Command)
+    # Создаем приложение FastAPI
+    app = create_app()
     
     # Запускаем сервер
-    service.run(
+    uvicorn.run(
+        app,
         host=args.host,
         port=args.port,
         reload=args.reload
@@ -133,5 +124,5 @@ if __name__ == "__main__":
     # Run the simple server example
     # To test, open http://localhost:8000/docs in your browser
     # or use curl:
-    # curl -X POST http://localhost:8000/api/jsonrpc -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"hello","params":{"name":"PyPI"},"id":1}'
+    # curl -X POST http://localhost:8000/api/cmd -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"hello","params":{"name":"PyPI"},"id":1}'
     main() 

examples/test_server.py

@@ -7,15 +7,16 @@
 import os
 import argparse
 import sys
+import uvicorn
 from pathlib import Path
 from typing import Dict, Any, Optional
 
 # Добавляем родительскую директорию в PYTHONPATH для импорта mcp_proxy_adapter
 sys.path.insert(0, str(Path(__file__).parent.parent))
 
-from mcp_proxy_adapter.framework import MicroService
-from mcp_proxy_adapter.commands.base import Command
-from mcp_proxy_adapter.commands.result import SuccessResult
+from mcp_proxy_adapter import Command, SuccessResult, create_app, registry
+from mcp_proxy_adapter.core.logging import setup_logging
+from mcp_proxy_adapter.config import config
 
 
 class HelloResult(SuccessResult):
@@ -96,29 +97,36 @@ def main():
     Основная функция для запуска сервера.
     """
     parser = argparse.ArgumentParser(description="Test JSON-RPC Microservice Server")
-    parser.add_argument("--host", default="localhost", help="Host to bind server")
+    parser.add_argument("--host", default="0.0.0.0", help="Host to bind server")
     parser.add_argument("--port", type=int, default=8000, help="Port to bind server")
     parser.add_argument("--reload", action="store_true", help="Enable auto-reload")
     parser.add_argument("--config", help="Path to config file")
     
     args = parser.parse_args()
     
-    # Создаем экземпляр микросервиса
-    service = MicroService(
-        title="Test Microservice",
-        description="Test microservice for package installation verification",
-        version="1.0.0",
-        config_path=args.config
-    )
+    # Инициализируем конфигурацию
+    if args.config and os.path.exists(args.config):
+        config.load_from_file(args.config)
+    
+    # Настраиваем логирование
+    setup_logging("INFO")
+    
+    # Создаем приложение FastAPI
+    app = create_app()
+    app.title = "Test Microservice"
+    app.description = "Test microservice for package installation verification"
+    app.version = "1.0.0"
     
     # Регистрируем только одну команду для тестирования
-    service.register_command(HelloCommand)
+    registry.register(HelloCommand)
     
     # Запускаем сервер
-    service.run(
+    uvicorn.run(
+        app,
         host=args.host,
         port=args.port,
-        reload=args.reload
+        reload=args.reload,
+        log_level="info"
     )
 
 

examples/tool_description_example.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+"""
+Example of using the API tool description functionality.
+
+This script demonstrates how to use the API tool description functionality
+to generate rich and informative descriptions for API tools.
+"""
+
+import json
+import asyncio
+import sys
+from pathlib import Path
+
+# Add the project root to the Python path
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from mcp_proxy_adapter.commands.command_registry import registry
+from mcp_proxy_adapter.api.schemas import APIToolDescription
+from mcp_proxy_adapter.api.tools import get_tool_description, TSTCommandExecutor
+from mcp_proxy_adapter.commands.help_command import HelpCommand
+
+
+async def main():
+    """Main function to demonstrate API tool description functionality."""
+    
+    # Register the help command so we have at least one command registered
+    if not registry.command_exists("help"):
+        registry.register(HelpCommand)
+    
+    # Generate description using the APIToolDescription class directly
+    print("Generating tool description using APIToolDescription:")
+    description = APIToolDescription.generate_tool_description("tst_execute_command", registry)
+    print(json.dumps(description, indent=2, ensure_ascii=False))
+    print("\n" + "-" * 80 + "\n")
+    
+    # Generate text description using the APIToolDescription class
+    print("Generating tool description text using APIToolDescription:")
+    description_text = APIToolDescription.generate_tool_description_text("tst_execute_command", registry)
+    print(description_text)
+    print("\n" + "-" * 80 + "\n")
+    
+    # Get tool description using the tools module
+    print("Getting tool description using the tools module:")
+    tool_description = get_tool_description("tst_execute_command")
+    print(json.dumps(tool_description, indent=2, ensure_ascii=False))
+    print("\n" + "-" * 80 + "\n")
+    
+    # Get tool description in markdown format using the tools module
+    print("Getting tool description in markdown format using the tools module:")
+    tool_description_md = get_tool_description("tst_execute_command", "markdown")
+    print(tool_description_md)
+    print("\n" + "-" * 80 + "\n")
+    
+    # Get tool schema directly from the tool class
+    print("Getting tool schema directly from the tool class:")
+    tool_schema = TSTCommandExecutor.get_schema()
+    print(json.dumps(tool_schema, indent=2, ensure_ascii=False))
+    print("\n" + "-" * 80 + "\n")
+    
+    # Get tool description directly from the tool class
+    print("Getting tool description directly from the tool class:")
+    tool_desc = TSTCommandExecutor.get_description("json")
+    print(json.dumps(tool_desc, indent=2, ensure_ascii=False))
+    print("\n" + "-" * 80 + "\n")
+    
+    # Show how this can be used to create informative command-line help
+    print("Example command-line help based on tool description:")
+    help_text = f"""
+    {TSTCommandExecutor.name} - {TSTCommandExecutor.description}
+    
+    Available commands:
+    """
+    
+    for cmd_name in tool_schema["parameters"]["properties"]["command"]["enum"]:
+        cmd_info = description["supported_commands"].get(cmd_name, {})
+        help_text += f"  {cmd_name} - {cmd_info.get('summary', '')}\n"
+    
+    print(help_text)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())