mcp-proxy-adapter 2.1.16__tar.gz → 3.0.0__tar.gz

{mcp_proxy_adapter-2.1.16 → mcp_proxy_adapter-3.0.0}/MANIFEST.in

@@ -4,7 +4,7 @@ include requirements.txt
 include pyproject.toml
 include code_index.yaml
 recursive-include docs *.md
-recursive-include examples *.py *.json
+recursive-include examples *.py *.json *.yaml *.md *.txt *.yml Dockerfile
 recursive-include tests *.py
 global-exclude __pycache__
 global-exclude *.py[cod]

mcp_proxy_adapter-3.0.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: mcp_proxy_adapter
+Version: 3.0.0
+Summary: Reliable microservice with unified JSON-RPC endpoint
+Home-page: https://github.com/yourusername/mcp-proxy-adapter
+Author: MCP Team
+Author-email: Vasiliy Zubarev <vasiliy.zubarev@example.com>
+License: MIT License
+        
+        Copyright (c) 2023-2024 Vasiliy VZ
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE. 
+Project-URL: Documentation, https://github.com/maverikod/vvz-mcp-proxy-adapter/tree/main/docs/RU/README.md
+Project-URL: Source, https://github.com/maverikod/vvz-mcp-proxy-adapter
+Project-URL: Bug Reports, https://github.com/maverikod/vvz-mcp-proxy-adapter/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: FastAPI
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi<1.0.0,>=0.95.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: uvicorn<1.0.0,>=0.22.0
+Requires-Dist: docstring-parser<1.0.0,>=0.15
+Requires-Dist: typing-extensions<5.0.0,>=4.5.0
+Requires-Dist: jsonrpc>=1.2.0
+Requires-Dist: psutil>=5.9.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# MCP Proxy Adapter
+
+**MCP Proxy Adapter** - это фреймворк для создания микросервисов на основе JSON-RPC. Он предоставляет базовую инфраструктуру для создания команд, обработки запросов и возвращения ответов через JSON-RPC API.
+
+**MCP Proxy Adapter** - это фреймворк для создания микросервисов на основе JSON-RPC. Он предоставляет базовую инфраструктуру для создания команд, обработки запросов и возвращения ответов через JSON-RPC API.
+
+## Установка
+
+```bash
+pip install mcp-proxy-adapter
+```
+
+## Использование
+
+1. Создайте свой проект и установите зависимость:
+
+```bash
+pip install mcp-proxy-adapter
+```
+
+2. Создайте свои команды:
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import SuccessResult
+
+class YourCommand(Command):
+    name = "your_command"
+    
+    async def execute(self, param1: str, param2: int = 0) -> SuccessResult:
+        # Ваша логика
+        result_data = {"param1": param1, "param2": param2}
+        return SuccessResult(data=result_data)
+```
+
+3. Запустите сервер:
+
+```python
+import uvicorn
+from mcp_proxy_adapter.api.app import create_app
+
+# Регистрация ваших команд происходит автоматически
+app = create_app()
+
+uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+## Структура проекта
+
+Проект представляет собой фреймворк с базовой инфраструктурой:
+
+* **mcp_proxy_adapter/** - основной модуль фреймворка
+  * **api/** - модуль API
+  * **commands/** - базовые классы команд
+  * **core/** - ядро фреймворка
+  * **schemas/** - JSON-схемы
+* **examples/** - примеры использования фреймворка
+  * **basic_example/** - базовый пример
+  * **minimal_example/** - минимальный пример
+  * **complete_example/** - полный пример с Docker
+
+## Базовые команды
+
+Фреймворк включает следующие базовые команды:
+
+- `help` - получение справки по доступным командам
+- `health` - проверка состояния сервиса
+
+## API
+
+Фреймворк предоставляет следующие эндпоинты:
+
+- `POST /api/jsonrpc` - основной JSON-RPC эндпоинт для выполнения команд
+- `POST /api/command/{command_name}` - REST эндпоинт для выполнения конкретной команды
+- `GET /api/commands` - получение списка доступных команд
+- `GET /api/commands/{command_name}` - получение информации о конкретной команде
+- `GET /health` - проверка состояния сервиса
+
+## Запуск примеров
+
+```bash
+# Базовый пример
+cd examples/basic_example
+python main.py
+
+# Минимальный пример
+cd examples/minimal_example
+python main.py
+
+# Полный пример с Docker
+cd examples/complete_example
+docker-compose up -d
+```
+
+## Создание новой команды
+
+Пример создания новой команды:
+
+```python
+from typing import Dict, Any, ClassVar, Type
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import SuccessResult
+
+class CustomResult(SuccessResult):
+    """
+    Пользовательский класс результата.
+    """
+    
+    def __init__(self, value: str):
+        super().__init__(data={"value": value})
+    
+    @classmethod
+    def get_schema(cls) -> Dict[str, Any]:
+        return {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "type": "object",
+                    "properties": {
+                        "value": {"type": "string"}
+                    },
+                    "required": ["value"]
+                }
+            },
+            "required": ["data"]
+        }
+
+class CustomCommand(Command):
+    """
+    Пользовательская команда.
+    """
+    
+    name: ClassVar[str] = "custom"
+    result_class: ClassVar[Type[SuccessResult]] = CustomResult
+    
+    async def execute(self, input_text: str) -> CustomResult:
+        return CustomResult(value=f"Processed: {input_text}")
+    
+    @classmethod
+    def get_schema(cls) -> Dict[str, Any]:
+        return {
+            "type": "object",
+            "properties": {
+                "input_text": {"type": "string"}
+            },
+            "required": ["input_text"],
+            "additionalProperties": False
+        } 

mcp_proxy_adapter-3.0.0/README.md

@@ -0,0 +1,148 @@
+# MCP Proxy Adapter
+
+**MCP Proxy Adapter** - это фреймворк для создания микросервисов на основе JSON-RPC. Он предоставляет базовую инфраструктуру для создания команд, обработки запросов и возвращения ответов через JSON-RPC API.
+
+**MCP Proxy Adapter** - это фреймворк для создания микросервисов на основе JSON-RPC. Он предоставляет базовую инфраструктуру для создания команд, обработки запросов и возвращения ответов через JSON-RPC API.
+
+## Установка
+
+```bash
+pip install mcp-proxy-adapter
+```
+
+## Использование
+
+1. Создайте свой проект и установите зависимость:
+
+```bash
+pip install mcp-proxy-adapter
+```
+
+2. Создайте свои команды:
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import SuccessResult
+
+class YourCommand(Command):
+    name = "your_command"
+    
+    async def execute(self, param1: str, param2: int = 0) -> SuccessResult:
+        # Ваша логика
+        result_data = {"param1": param1, "param2": param2}
+        return SuccessResult(data=result_data)
+```
+
+3. Запустите сервер:
+
+```python
+import uvicorn
+from mcp_proxy_adapter.api.app import create_app
+
+# Регистрация ваших команд происходит автоматически
+app = create_app()
+
+uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+## Структура проекта
+
+Проект представляет собой фреймворк с базовой инфраструктурой:
+
+* **mcp_proxy_adapter/** - основной модуль фреймворка
+  * **api/** - модуль API
+  * **commands/** - базовые классы команд
+  * **core/** - ядро фреймворка
+  * **schemas/** - JSON-схемы
+* **examples/** - примеры использования фреймворка
+  * **basic_example/** - базовый пример
+  * **minimal_example/** - минимальный пример
+  * **complete_example/** - полный пример с Docker
+
+## Базовые команды
+
+Фреймворк включает следующие базовые команды:
+
+- `help` - получение справки по доступным командам
+- `health` - проверка состояния сервиса
+
+## API
+
+Фреймворк предоставляет следующие эндпоинты:
+
+- `POST /api/jsonrpc` - основной JSON-RPC эндпоинт для выполнения команд
+- `POST /api/command/{command_name}` - REST эндпоинт для выполнения конкретной команды
+- `GET /api/commands` - получение списка доступных команд
+- `GET /api/commands/{command_name}` - получение информации о конкретной команде
+- `GET /health` - проверка состояния сервиса
+
+## Запуск примеров
+
+```bash
+# Базовый пример
+cd examples/basic_example
+python main.py
+
+# Минимальный пример
+cd examples/minimal_example
+python main.py
+
+# Полный пример с Docker
+cd examples/complete_example
+docker-compose up -d
+```
+
+## Создание новой команды
+
+Пример создания новой команды:
+
+```python
+from typing import Dict, Any, ClassVar, Type
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import SuccessResult
+
+class CustomResult(SuccessResult):
+    """
+    Пользовательский класс результата.
+    """
+    
+    def __init__(self, value: str):
+        super().__init__(data={"value": value})
+    
+    @classmethod
+    def get_schema(cls) -> Dict[str, Any]:
+        return {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "type": "object",
+                    "properties": {
+                        "value": {"type": "string"}
+                    },
+                    "required": ["value"]
+                }
+            },
+            "required": ["data"]
+        }
+
+class CustomCommand(Command):
+    """
+    Пользовательская команда.
+    """
+    
+    name: ClassVar[str] = "custom"
+    result_class: ClassVar[Type[SuccessResult]] = CustomResult
+    
+    async def execute(self, input_text: str) -> CustomResult:
+        return CustomResult(value=f"Processed: {input_text}")
+    
+    @classmethod
+    def get_schema(cls) -> Dict[str, Any]:
+        return {
+            "type": "object",
+            "properties": {
+                "input_text": {"type": "string"}
+            },
+            "required": ["input_text"],
+            "additionalProperties": False
+        } 

mcp_proxy_adapter-3.0.0/docs/EN/API_SCHEMA.md

@@ -0,0 +1,183 @@
+# API and Interaction Schema
+
+## Basic Principles
+
+1. **Single Entry Point for Commands**
+   - All commands are executed through a unified mechanism, regardless of the calling method (REST or JSON-RPC)
+   - The intermediate layer (adapter) transforms incoming requests into a unified format
+
+2. **Supported Protocols**
+   - JSON-RPC 2.0 (`/cmd`)
+   - REST API (standard endpoints + `/cmd`)
+
+3. **Response Format**
+   - Always returns HTTP code 200
+   - Response body is always in JSON-RPC 2.0 format
+   - Errors are transmitted in the error field of the JSON-RPC response
+   - HTTP codes 4xx and 5xx are not used
+
+## Request and Response Structure
+
+### JSON-RPC Format
+
+```json
+// Request
+{
+    "jsonrpc": "2.0",
+    "method": "command_name",
+    "params": {
+        "param1": "value1",
+        "param2": "value2"
+    },
+    "id": 1
+}
+
+// Successful response
+{
+    "jsonrpc": "2.0",
+    "result": {
+        "data": "command result"
+    },
+    "id": 1
+}
+
+// Error response
+{
+    "jsonrpc": "2.0",
+    "error": {
+        "code": -32000,
+        "message": "Error description",
+        "data": {
+            "details": "Additional error info"
+        }
+    },
+    "id": 1
+}
+```
+
+### REST Format
+
+```
+GET /api/v1/commands           # List of available commands
+GET /api/v1/commands/{name}    # Command information
+POST /cmd                      # Command execution (similar to JSON-RPC)
+```
+
+The response is always wrapped in JSON-RPC format:
+
+```json
+// GET /api/v1/commands
+{
+    "jsonrpc": "2.0",
+    "result": {
+        "commands": [
+            {
+                "name": "command1",
+                "description": "Command description",
+                "params": {...}
+            }
+        ]
+    },
+    "id": null
+}
+```
+
+## Intermediate Layer (Adapter)
+
+```python
+class CommandAdapter:
+    """
+    Intermediate layer for transforming REST/RPC requests
+    into a unified command format
+    """
+    
+    async def execute_command(self, command: str, params: dict) -> CommandResult:
+        """Single point of command execution"""
+        pass
+
+    def to_jsonrpc_response(self, result: CommandResult) -> dict:
+        """Converting the result to JSON-RPC format"""
+        pass
+```
+
+## OpenAPI Schema
+
+The schema must correspond to the MCP Proxy format (port 8001):
+
+```yaml
+openapi: 3.0.0
+paths:
+  /cmd:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CommandRequest'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JsonRpcResponse'
+components:
+  schemas:
+    CommandRequest:
+      type: object
+      properties:
+        jsonrpc:
+          type: string
+          enum: ['2.0']
+        method:
+          type: string
+        params:
+          type: object
+        id:
+          type: [integer, string, null]
+    JsonRpcResponse:
+      type: object
+      properties:
+        jsonrpc:
+          type: string
+          enum: ['2.0']
+        result:
+          type: object
+        error:
+          type: object
+        id:
+          type: [integer, string, null]
+```
+
+## Error Handling
+
+All errors are returned in JSON-RPC format with HTTP code 200:
+
+| Error Type | code | message |
+|------------|------|---------|
+| Parse error | -32700 | "Parse error" |
+| Invalid Request | -32600 | "Invalid Request" |
+| Method not found | -32601 | "Method not found" |
+| Invalid params | -32602 | "Invalid params" |
+| Internal error | -32603 | "Internal error" |
+| Server error | -32000 to -32099 | "Server error" |
+
+## Usage Examples
+
+### REST Request
+```bash
+curl -X GET http://localhost:8000/api/v1/commands
+```
+
+### JSON-RPC Request
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "jsonrpc": "2.0",
+    "method": "get_status",
+    "params": {},
+    "id": 1
+  }'
+```
+
+Both requests will be processed through a unified mechanism and return a response in JSON-RPC format.