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

mcp_proxy_adapter/core/utils.py

@@ -0,0 +1,138 @@
+"""
+Module with utility functions for the microservice.
+"""
+
+import hashlib
+import json
+import os
+import sys
+import time
+import uuid
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+from mcp_proxy_adapter.core.logging import logger
+
+
+def generate_id() -> str:
+    """
+    Generates a unique identifier.
+
+    Returns:
+        String with unique identifier.
+    """
+    return str(uuid.uuid4())
+
+
+def get_timestamp() -> int:
+    """
+    Returns current timestamp in milliseconds.
+
+    Returns:
+        Integer - timestamp in milliseconds.
+    """
+    return int(time.time() * 1000)
+
+
+def format_datetime(dt: Optional[datetime] = None, format_str: str = "%Y-%m-%dT%H:%M:%S.%fZ") -> str:
+    """
+    Formats date and time as string.
+
+    Args:
+        dt: Datetime object to format. If None, current time is used.
+        format_str: Format string for output.
+
+    Returns:
+        Formatted date/time string.
+    """
+    dt = dt or datetime.utcnow()
+    return dt.strftime(format_str)
+
+
+def parse_datetime(dt_str: str, format_str: str = "%Y-%m-%dT%H:%M:%S.%fZ") -> datetime:
+    """
+    Parses date/time string into datetime object.
+
+    Args:
+        dt_str: Date/time string.
+        format_str: Date/time string format.
+
+    Returns:
+        Datetime object.
+    """
+    return datetime.strptime(dt_str, format_str)
+
+
+def safe_json_loads(s: str, default: Any = None) -> Any:
+    """
+    Safe JSON string loading.
+
+    Args:
+        s: JSON string to load.
+        default: Default value on parsing error.
+
+    Returns:
+        Loaded object or default value on error.
+    """
+    try:
+        return json.loads(s)
+    except Exception as e:
+        logger.error(f"Error parsing JSON: {e}")
+        return default
+
+
+def safe_json_dumps(obj: Any, default: str = "{}", indent: Optional[int] = None) -> str:
+    """
+    Safe object conversion to JSON string.
+
+    Args:
+        obj: Object to convert.
+        default: Default string on serialization error.
+        indent: Indentation for JSON formatting.
+
+    Returns:
+        JSON string or default string on error.
+    """
+    try:
+        return json.dumps(obj, ensure_ascii=False, indent=indent)
+    except Exception as e:
+        logger.error(f"Error serializing to JSON: {e}")
+        return default
+
+
+def calculate_hash(data: Union[str, bytes], algorithm: str = "sha256") -> str:
+    """
+    Calculates hash for data.
+
+    Args:
+        data: Data to hash (string or bytes).
+        algorithm: Hashing algorithm (md5, sha1, sha256, etc.).
+
+    Returns:
+        String with hash in hexadecimal format.
+    """
+    if isinstance(data, str):
+        data = data.encode("utf-8")
+    
+    hash_obj = hashlib.new(algorithm)
+    hash_obj.update(data)
+    return hash_obj.hexdigest()
+
+
+def ensure_directory(path: str) -> bool:
+    """
+    Checks directory existence and creates it if necessary.
+
+    Args:
+        path: Path to directory.
+
+    Returns:
+        True if directory exists or was successfully created, otherwise False.
+    """
+    try:
+        if not os.path.exists(path):
+            os.makedirs(path, exist_ok=True)
+        return True
+    except Exception as e:
+        logger.error(f"Error creating directory {path}: {e}")
+        return False

mcp_proxy_adapter/custom_openapi.py

@@ -18,8 +18,16 @@ class CustomOpenAPIGenerator:
     """
     Custom OpenAPI schema generator for compatibility with MCP-Proxy.
     
+    EN:
     This generator creates an OpenAPI schema that matches the format expected by MCP-Proxy,
     enabling dynamic command loading and proper tool representation in AI models.
+    Allows overriding title, description, and version for schema customization.
+
+    RU:
+    Кастомный генератор схемы OpenAPI для совместимости с MCP-Proxy.
+    Позволяет создавать схему OpenAPI в формате, ожидаемом MCP-Proxy,
+    с возможностью динамической подгрузки команд и корректного отображения инструментов для AI-моделей.
+    Поддерживает переопределение title, description и version для кастомизации схемы.
     """
     
     def __init__(self):
@@ -88,38 +96,67 @@ class CustomOpenAPIGenerator:
         
         return cmd_schema
         
-    def generate(self) -> Dict[str, Any]:
+    def generate(self, title: Optional[str] = None, description: Optional[str] = None, version: Optional[str] = None) -> Dict[str, Any]:
         """
+        EN:
         Generate the complete OpenAPI schema compatible with MCP-Proxy.
+        Optionally override title, description, and version.
+
+        RU:
+        Генерирует полную схему OpenAPI, совместимую с MCP-Proxy.
+        Позволяет опционально переопределить title, description и version.
+        
+        Args:
+            title: Custom title for the schema / Кастомный заголовок схемы
+            description: Custom description for the schema / Кастомное описание схемы
+            version: Custom version for the schema / Кастомная версия схемы
         
         Returns:
-            Dict containing the complete OpenAPI schema.
+            Dict containing the complete OpenAPI schema / Словарь с полной схемой OpenAPI
         """
         # Deep copy the base schema to avoid modifying it
         schema = deepcopy(self.base_schema)
-        
+
+        # Optionally override info fields
+        if title:
+            schema["info"]["title"] = title
+        if description:
+            schema["info"]["description"] = description
+        if version:
+            schema["info"]["version"] = version
+
         # Add commands to schema
         self._add_commands_to_schema(schema)
-        
+
         logger.info(f"Generated OpenAPI schema with {len(registry.get_all_commands())} commands")
-        
+
         return schema
 
 
 def custom_openapi(app: FastAPI) -> Dict[str, Any]:
     """
+    EN:
     Create a custom OpenAPI schema for the FastAPI application.
+    Passes app's title, description, and version to the generator.
+
+    RU:
+    Создаёт кастомную OpenAPI-схему для FastAPI-приложения.
+    Передаёт параметры title, description и version из приложения в генератор схемы.
     
     Args:
-        app: The FastAPI application.
+        app: The FastAPI application / FastAPI-приложение
         
     Returns:
-        Dict containing the custom OpenAPI schema.
+        Dict containing the custom OpenAPI schema / Словарь с кастомной OpenAPI-схемой
     """
     generator = CustomOpenAPIGenerator()
-    openapi_schema = generator.generate()
-    
+    openapi_schema = generator.generate(
+        title=getattr(app, 'title', None),
+        description=getattr(app, 'description', None),
+        version=getattr(app, 'version', None)
+    )
+
     # Cache the schema
     app.openapi_schema = openapi_schema
-    
+
     return openapi_schema 

mcp_proxy_adapter/schemas/base_schema.json

@@ -0,0 +1,114 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Base Schema",
+  "description": "Basic schema for validating commands and results",
+  "definitions": {
+    "command": {
+      "type": "object",
+      "properties": {
+        "jsonrpc": {
+          "type": "string",
+          "enum": ["2.0"],
+          "description": "JSON-RPC version"
+        },
+        "method": {
+          "type": "string",
+          "description": "Command name"
+        },
+        "params": {
+          "type": "object",
+          "description": "Command parameters"
+        },
+        "id": {
+          "oneOf": [
+            {"type": "string"},
+            {"type": "integer"},
+            {"type": "null"}
+          ],
+          "description": "Request ID"
+        }
+      },
+      "required": ["jsonrpc", "method"]
+    },
+    "success_response": {
+      "type": "object",
+      "properties": {
+        "jsonrpc": {
+          "type": "string",
+          "enum": ["2.0"],
+          "description": "JSON-RPC version"
+        },
+        "result": {
+          "type": "object",
+          "properties": {
+            "success": {
+              "type": "boolean",
+              "enum": [true],
+              "description": "Success flag"
+            },
+            "data": {
+              "type": "object",
+              "description": "Response data"
+            },
+            "message": {
+              "type": "string",
+              "description": "Response message"
+            }
+          },
+          "required": ["success"]
+        },
+        "id": {
+          "oneOf": [
+            {"type": "string"},
+            {"type": "integer"},
+            {"type": "null"}
+          ],
+          "description": "Request ID"
+        }
+      },
+      "required": ["jsonrpc", "result"]
+    },
+    "error_response": {
+      "type": "object",
+      "properties": {
+        "jsonrpc": {
+          "type": "string",
+          "enum": ["2.0"],
+          "description": "JSON-RPC version"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "integer",
+              "description": "Error code"
+            },
+            "message": {
+              "type": "string",
+              "description": "Error message"
+            },
+            "details": {
+              "type": "object",
+              "description": "Detailed error information"
+            }
+          },
+          "required": ["code", "message"]
+        },
+        "id": {
+          "oneOf": [
+            {"type": "string"},
+            {"type": "integer"},
+            {"type": "null"}
+          ],
+          "description": "Request ID"
+        }
+      },
+      "required": ["jsonrpc", "error"]
+    }
+  },
+  "oneOf": [
+    {"$ref": "#/definitions/command"},
+    {"$ref": "#/definitions/success_response"},
+    {"$ref": "#/definitions/error_response"}
+  ]
+} 

mcp_proxy_adapter/schemas/openapi_schema.json

@@ -0,0 +1,314 @@
+{
+  "openapi": "3.0.2",
+  "info": {
+    "title": "MCP Microservice API",
+    "description": "API для выполнения команд микросервиса",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/cmd": {
+      "post": {
+        "summary": "Execute Command",
+        "description": "Executes a command via JSON-RPC protocol.",
+        "operationId": "execute_command",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "oneOf": [
+                  { "$ref": "#/components/schemas/CommandRequest" },
+                  { "$ref": "#/components/schemas/JsonRpcRequest" }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    { "$ref": "#/components/schemas/CommandResponse" },
+                    { "$ref": "#/components/schemas/JsonRpcResponse" }
+                  ]
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/health": {
+      "get": {
+        "summary": "Проверить работоспособность сервиса",
+        "description": "Возвращает информацию о состоянии сервиса",
+        "operationId": "health_check",
+        "responses": {
+          "200": {
+            "description": "Информация о состоянии сервиса",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/openapi.json": {
+      "get": {
+        "summary": "Get Openapi Schema",
+        "description": "Returns OpenAPI schema.",
+        "operationId": "get_openapi_schema_openapi_json_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {}
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/commands": {
+      "get": {
+        "summary": "Get Commands",
+        "description": "Returns list of available commands with their descriptions.",
+        "operationId": "get_commands_api_commands_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {}
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "CommandRequest": {
+        "title": "CommandRequest",
+        "description": "Запрос на выполнение команды",
+        "type": "object",
+        "required": [
+          "command"
+        ],
+        "properties": {
+          "command": {
+            "title": "Command",
+            "description": "Команда для выполнения",
+            "type": "string"
+          },
+          "params": {
+            "title": "Parameters",
+            "description": "Параметры команды, зависят от типа команды",
+            "type": "object",
+            "additionalProperties": true
+          }
+        }
+      },
+      "CommandResponse": {
+        "title": "CommandResponse",
+        "description": "Ответ на выполнение команды",
+        "type": "object",
+        "required": [
+          "result"
+        ],
+        "properties": {
+          "result": {
+            "title": "Result",
+            "description": "Результат выполнения команды"
+          }
+        }
+      },
+      "JsonRpcRequest": {
+        "properties": {
+          "jsonrpc": {
+            "type": "string",
+            "title": "Jsonrpc",
+            "description": "JSON-RPC version",
+            "default": "2.0"
+          },
+          "method": {
+            "type": "string",
+            "title": "Method",
+            "description": "Method name to call"
+          },
+          "params": {
+            "additionalProperties": true,
+            "type": "object",
+            "title": "Params",
+            "description": "Method parameters",
+            "default": {}
+          },
+          "id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "integer"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Id",
+            "description": "Request identifier"
+          }
+        },
+        "type": "object",
+        "required": [
+          "method"
+        ],
+        "title": "JsonRpcRequest",
+        "description": "Base model for JSON-RPC requests."
+      },
+      "JsonRpcResponse": {
+        "properties": {
+          "jsonrpc": {
+            "type": "string",
+            "title": "Jsonrpc",
+            "description": "JSON-RPC version",
+            "default": "2.0"
+          },
+          "result": {
+            "anyOf": [
+              {},
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Result",
+            "description": "Method execution result"
+          },
+          "error": {
+            "anyOf": [
+              {
+                "additionalProperties": true,
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Error",
+            "description": "Error information"
+          },
+          "id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "integer"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Id",
+            "description": "Request identifier"
+          }
+        },
+        "type": "object",
+        "title": "JsonRpcResponse",
+        "description": "Base model for JSON-RPC responses."
+      },
+      "HealthResponse": {
+        "title": "HealthResponse",
+        "description": "Информация о состоянии сервиса",
+        "type": "object",
+        "required": [
+          "status",
+          "model",
+          "version"
+        ],
+        "properties": {
+          "status": {
+            "title": "Status",
+            "description": "Статус сервиса (ok/error)",
+            "type": "string"
+          },
+          "model": {
+            "title": "Model",
+            "description": "Текущая активная модель",
+            "type": "string"
+          },
+          "version": {
+            "title": "Version",
+            "description": "Версия сервиса",
+            "type": "string"
+          }
+        }
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": {
+            "type": "string",
+            "title": "Message"
+          },
+          "type": {
+            "type": "string",
+            "title": "Error Type"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loc",
+          "msg",
+          "type"
+        ],
+        "title": "ValidationError"
+      }
+    }
+  }
+} 

mcp_proxy_adapter/tests/api/__init__.py

@@ -0,0 +1,3 @@
+"""
+API tests package.
+"""