mcp-proxy-adapter 2.1.11__py3-none-any.whl → 2.1.13__py3-none-any.whl

mcp_proxy_adapter/validators/docstring_validator.py

@@ -1,75 +0,0 @@
-"""
-Validator for checking the correspondence between docstrings and function signatures.
-"""
-import inspect
-from typing import Dict, Any, Optional, Callable, List, Tuple, get_type_hints
-import docstring_parser
-
-class DocstringValidator:
-    """
-    Validator for checking the correspondence between docstrings and handler functions.
-    
-    This class verifies that function docstrings match their signatures,
-    contain all necessary sections, and describe all parameters.
-    """
-    
-    def validate(self, handler: Callable, command_name: str, metadata: Dict[str, Any]) -> Tuple[bool, List[str]]:
-        """
-        Validates the function's docstring against its formal parameters.
-        
-        Args:
-            handler: Command handler function
-            command_name: Command name
-            metadata: Command metadata
-            
-        Returns:
-            Tuple[bool, List[str]]: Validity flag and list of errors
-        """
-        errors = []
-        
-        # Get formal parameters of the function
-        sig = inspect.signature(handler)
-        formal_params = list(sig.parameters.keys())
-        
-        # Skip self parameter for methods
-        if formal_params and formal_params[0] == 'self':
-            formal_params = formal_params[1:]
-            
-        # Parse docstring
-        docstring = handler.__doc__ or ""
-        parsed_doc = docstring_parser.parse(docstring)
-        
-        # Check for function description
-        if not parsed_doc.short_description and not parsed_doc.long_description:
-            errors.append(f"Missing function description")
-        
-        # Get parameters from docstring
-        doc_params = {param.arg_name: param for param in parsed_doc.params}
-        
-        # Check that all formal parameters are described in the docstring
-        for param in formal_params:
-            # Skip special parameters
-            if param in ('params', 'kwargs'):
-                continue
-                
-            if param not in doc_params:
-                errors.append(f"Parameter '{param}' is not described in the function docstring")
-        
-        # Check for returns in docstring
-        if not parsed_doc.returns and not any(t.type_name == 'Returns' for t in parsed_doc.meta):
-            errors.append(f"Missing return value description in the function docstring")
-        
-        # Check for type annotations
-        try:
-            type_hints = get_type_hints(handler)
-            for param in formal_params:
-                # Skip special parameters
-                if param in ('params', 'kwargs'):
-                    continue
-                    
-                if param not in type_hints:
-                    errors.append(f"Missing type annotation for parameter '{param}' in function {command_name}")
-        except Exception as e:
-            errors.append(f"Error getting type hints: {str(e)}")
-        
-        return len(errors) == 0, errors 

mcp_proxy_adapter/validators/metadata_validator.py

@@ -1,76 +0,0 @@
-"""
-Validator for checking command metadata against function signatures.
-"""
-import inspect
-from typing import Dict, Any, Optional, Callable, List, Tuple
-
-class MetadataValidator:
-    """
-    Validator for checking handler function metadata.
-    
-    This class verifies that command metadata matches function signatures,
-    and all parameters are correctly described.
-    """
-    
-    def validate(self, handler: Callable, command_name: str, metadata: Dict[str, Any]) -> Tuple[bool, List[str]]:
-        """
-        Checks if metadata matches function's formal parameters.
-        
-        Args:
-            handler: Command handler function
-            command_name: Command name
-            metadata: Command metadata
-            
-        Returns:
-            Tuple[bool, List[str]]: Validity flag and list of errors
-        """
-        errors = []
-        
-        # Check presence of main fields in metadata
-        if not metadata.get('description'):
-            errors.append(f"Missing description for command '{command_name}'")
-            
-        # Get function's formal parameters
-        sig = inspect.signature(handler)
-        formal_params = list(sig.parameters.keys())
-        
-        # Skip self parameter for methods
-        if formal_params and formal_params[0] == 'self':
-            formal_params = formal_params[1:]
-            
-        # Check presence of parameters in metadata
-        if 'parameters' not in metadata or not isinstance(metadata['parameters'], dict):
-            errors.append(f"Parameters are missing or incorrectly defined in metadata for command '{command_name}'")
-            return False, errors
-            
-        meta_params = metadata['parameters']
-        
-        # Check that all formal parameters are in metadata
-        for param in formal_params:
-            # Skip special parameters
-            if param in ('params', 'kwargs'):
-                continue
-                
-            if param not in meta_params:
-                errors.append(f"Parameter '{param}' is not described in metadata for command '{command_name}'")
-                continue
-                
-            param_info = meta_params[param]
-            
-            # Check presence of required fields for parameter
-            if not isinstance(param_info, dict):
-                errors.append(f"Incorrect format for parameter '{param}' description in metadata for command '{command_name}'")
-                continue
-                
-            if 'type' not in param_info:
-                errors.append(f"Type is not specified for parameter '{param}' in metadata for command '{command_name}'")
-                
-            if 'description' not in param_info:
-                errors.append(f"Description is not specified for parameter '{param}' in metadata for command '{command_name}'")
-        
-        # Check that there are no extra parameters in metadata
-        for param in meta_params:
-            if param not in formal_params and param not in ('params', 'kwargs'):
-                errors.append(f"Extra parameter '{param}' in metadata for command '{command_name}'")
-        
-        return len(errors) == 0, errors 

mcp_proxy_adapter-2.1.11.dist-info/METADATA

@@ -1,402 +0,0 @@
-Metadata-Version: 2.4
-Name: mcp-proxy-adapter
-Version: 2.1.11
-Summary: Adapter for exposing Command Registry commands as tools for AI models via MCP Proxy.
-Home-page: https://github.com/vasilyvz/mcp-proxy-adapter
-Author: Vasiliy VZ
-Author-email: Vasiliy VZ <vasilyvz@example.com>
-License: MIT
-Project-URL: Homepage, https://github.com/vasilyvz/mcp-proxy-adapter
-Project-URL: Bug Tracker, https://github.com/vasilyvz/mcp-proxy-adapter/issues
-Project-URL: Documentation, https://github.com/vasilyvz/mcp-proxy-adapter/tree/main/docs
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9, <4
-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
-Dynamic: author
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-python
-
-# MCP Proxy Adapter
-
-Adapter for integrating [Command Registry](docs/README.md) with MCP Proxy, allowing you to use commands as tools for AI models.
-
-## Overview
-
-MCP Proxy Adapter transforms commands registered in the Command Registry into a format compatible with MCP Proxy. This enables:
-
-1. Using existing commands as tools for AI models
-2. Creating a hybrid REST/JSON-RPC API for command execution
-3. Automatic generation of OpenAPI schemas optimized for MCP Proxy
-4. Managing tool metadata for better AI system integration
-
-## Installation
-
-```bash
-pip install mcp-proxy-adapter
-```
-
-## Quick Start
-
-```python
-from mcp_proxy_adapter import MCPProxyAdapter, CommandRegistry
-from fastapi import FastAPI
-
-# Create a command registry instance
-registry = CommandRegistry()
-
-# Register commands
-@registry.command
-def calculate_total(prices: list[float], discount: float = 0.0) -> float:
-    """
-    Calculates the total price with discount.
-    Args:
-        prices: List of item prices
-        discount: Discount percentage (0-100)
-    Returns:
-        Total price with discount
-    """
-    subtotal = sum(prices)
-    return subtotal * (1 - discount / 100)
-
-# Create FastAPI app
-app = FastAPI()
-
-# Create and configure MCP Proxy adapter
-adapter = MCPProxyAdapter(registry)
-
-# Register endpoints in FastAPI app
-adapter.register_endpoints(app)
-
-# Generate and save MCP Proxy config
-adapter.save_config_to_file("mcp_proxy_config.json")
-```
-
-## Supported Request Formats
-
-The adapter supports three request formats for command execution:
-
-### 1. JSON-RPC format
-
-```json
-{
-  "jsonrpc": "2.0",
-  "method": "command_name",
-  "params": {
-    "param1": "value1",
-    "param2": "value2"
-  },
-  "id": 1
-}
-```
-
-Example request to `/cmd` endpoint:
-
-```bash
-curl -X POST -H "Content-Type: application/json" -d '{
-  "jsonrpc": "2.0",
-  "method": "calculate_total",
-  "params": {
-    "prices": [100, 200, 300],
-    "discount": 10
-  },
-  "id": 1
-}' http://localhost:8000/cmd
-```
-
-Response:
-
-```json
-{
-  "jsonrpc": "2.0",
-  "result": 540.0,
-  "id": 1
-}
-```
-
-### 2. MCP Proxy format
-
-```json
-{
-  "command": "command_name",
-  "params": {
-    "param1": "value1",
-    "param2": "value2"
-  }
-}
-```
-
-Example request:
-
-```bash
-curl -X POST -H "Content-Type: application/json" -d '{
-  "command": "calculate_total",
-  "params": {
-    "prices": [100, 200, 300],
-    "discount": 10
-  }
-}' http://localhost:8000/cmd
-```
-
-Response:
-
-```json
-{
-  "result": 540.0
-}
-```
-
-### 3. Params-only format
-
-```json
-{
-  "params": {
-    "command": "command_name",
-    "param1": "value1",
-    "param2": "value2"
-  }
-}
-```
-
-or
-
-```json
-{
-  "params": {
-    "query": "command_name",
-    "param1": "value1",
-    "param2": "value2"
-  }
-}
-```
-
-Example request:
-
-```bash
-curl -X POST -H "Content-Type: application/json" -d '{
-  "params": {
-    "command": "calculate_total",
-    "prices": [100, 200, 300],
-    "discount": 10
-  }
-}' http://localhost:8000/cmd
-```
-
-Response:
-
-```json
-{
-  "result": 540.0
-}
-```
-
-## Full Example: Integration with FastAPI
-
-```python
-import logging
-from fastapi import FastAPI, APIRouter
-from mcp_proxy_adapter import CommandRegistry, MCPProxyAdapter, configure_logger
-
-# Configure logging
-logging.basicConfig(level=logging.INFO)
-project_logger = logging.getLogger("my_project")
-
-# Create FastAPI app
-app = FastAPI(title="My API with MCP Proxy Integration")
-
-# Create existing API router
-router = APIRouter()
-
-@router.get("/items")
-async def get_items():
-    """Returns a list of items."""
-    return [
-        {"id": 1, "name": "Smartphone X", "price": 999.99},
-        {"id": 2, "name": "Laptop Y", "price": 1499.99},
-    ]
-
-app.include_router(router)
-
-# Register commands
-registry = CommandRegistry()
-
-@registry.command
-def get_discounted_price(price: float, discount: float = 0.0) -> float:
-    """
-    Returns the price after applying a discount.
-    """
-    return price * (1 - discount / 100)
-
-# Create and register MCP Proxy adapter
-adapter = MCPProxyAdapter(registry)
-adapter.register_endpoints(app)
-
-# Save MCP Proxy config
-adapter.save_config_to_file("mcp_proxy_config.json")
-```
-
-## Features
-- Universal JSON-RPC endpoint for command execution
-- Automatic OpenAPI schema generation and optimization for MCP Proxy
-- Tool metadata for AI models
-- Customizable endpoints and logging
-- Full test coverage and examples
-
-## License
-MIT
-
-## Documentation
-See [docs/](docs/) for detailed guides, architecture, and examples.
-
-## 📦 Примеры (examples/)
-
-- `help_usage.py` — базовое использование help-команды
-- `help_best_practices.py` — best practices для help
-- `project_structure_example.py` — структура проекта с MCPProxyAdapter
-- `docstring_and_schema_example.py` — как документировать команды для схемы
-- `testing_example.py` — как тестировать команды и интеграцию
-- `extension_example.py` — как расширять и кастомизировать команды и help
-
-## ✅ Чеклист для добавления новой команды
-
-1. **Реализовать функцию-команду** с подробным docstring (EN)
-2. **Добавить описание параметров** (type, description, required)
-3. **Добавить описание возврата** (docstring, тип)
-4. **Зарегистрировать команду** в registry/dispatcher
-5. **Добавить описание в get_commands_info** (использовать docstring)
-6. **Покрыть тестами** (unit/integration, edge-cases, ошибки)
-7. **Добавить пример использования** в examples/
-8. **Проверить интеграцию с help** (и с параметром, и без)
-9. **Проверить генерацию схемы/OpenAPI**
-10. **Документировать в README.md** (EN/RU)
-
-## 📦 Examples (EN)
-
-- `help_usage.py` — basic help command usage
-- `help_best_practices.py` — best practices for help
-- `project_structure_example.py` — project structure with MCPProxyAdapter
-- `docstring_and_schema_example.py` — how to document commands for schema
-- `testing_example.py` — how to test commands and integration
-- `extension_example.py` — how to extend/customize commands and help
-
-## ✅ Checklist for adding a new command
-
-1. **Implement the command function** with detailed docstring (EN)
-2. **Describe parameters** (type, description, required)
-3. **Describe return value** (docstring, type)
-4. **Register the command** in registry/dispatcher
-5. **Add description to get_commands_info** (use docstring)
-6. **Cover with tests** (unit/integration, edge-cases, errors)
-7. **Add usage example** to examples/
-8. **Check help integration** (with/without param)
-9. **Check schema/OpenAPI generation**
-10. **Document in README.md** (EN/RU)
-
-## ❓ FAQ
-
-### Ошибка: got multiple values for argument 'command' при вызове команды help
-
-**Проблема:**
-
-Если в JSON-RPC запросе к endpoint `/cmd` используется команда `help` с параметром `command`, может возникнуть ошибка:
-
-```
-TypeError: help_command() got multiple values for argument 'command'
-```
-
-**Причина:**
-
-В Python, если метод `execute(self, command, **params)` получает параметр `command` и в `params` также есть ключ `command`, возникает конфликт имён.
-
-**Решение:**
-
-Переименуйте первый аргумент метода `execute` в классе `MockDispatcher` (и аналогичных) с `command` на `command_name`:
-
-```python
-def execute(self, command_name, **params):
-    if command_name not in self.commands:
-        raise KeyError(f"Unknown command: {command_name}")
-    return self.commands[command_name](**params)
-```
-
-Это устранит конфликт и позволит корректно вызывать команду help с параметром `command` через JSON-RPC. 
-
-## 🚀 Deployment & Packaging FAQ
-
-### Как собрать, проверить и опубликовать пакет (wheel/sdist) с примерами и документацией
-
-1. **Перенесите каталоги `examples` и `docs` внутрь основного пакета** (например, `mcp_proxy_adapter/examples`, `mcp_proxy_adapter/docs`).
-2. **Обновите `setup.py`:**
-    - Укажите `include_package_data=True`.
-    - В `package_data` добавьте:
-      ```python
-      package_data={
-          'mcp_proxy_adapter': ['examples/*.py', 'examples/*.json', 'docs/*.md', '../README.md'],
-      },
-      ```
-3. **Обновите `MANIFEST.in`:**
-    - Убедитесь, что включены нужные файлы:
-      ```
-      include README.md
-      include LICENSE
-      include requirements.txt
-      include pyproject.toml
-      include code_index.yaml
-      recursive-include mcp_proxy_adapter/examples *.py *.json
-      recursive-include mcp_proxy_adapter/docs *.md
-      ```
-4. **Соберите пакет:**
-    ```bash
-    rm -rf dist build mcp_proxy_adapter.egg-info
-    python3 -m build
-    ```
-5. **Создайте новое виртуальное окружение и установите пакет:**
-    ```bash
-    python3 -m venv ../mcp_proxy_adapter_test_env
-    source ../mcp_proxy_adapter_test_env/bin/activate
-    pip install --upgrade pip
-    pip install dist/mcp_proxy_adapter-*.whl
-    ```
-6. **Проверьте, что примеры и документация попали в пакет:**
-    ```bash
-    ls -l ../mcp_proxy_adapter_test_env/lib/python*/site-packages/mcp_proxy_adapter/examples
-    ls -l ../mcp_proxy_adapter_test_env/lib/python*/site-packages/mcp_proxy_adapter/docs
-    ```
-7. **Запустите пример сервера:**
-    ```bash
-    python ../mcp_proxy_adapter_test_env/lib/python*/site-packages/mcp_proxy_adapter/examples/openapi_server.py
-    ```
-8. **Проверьте работоспособность через curl:**
-    ```bash
-    curl http://localhost:8000/openapi.json | jq .
-    ```
-9. **Публикация на PyPI:**
-    - Проверьте, что у вас настроен `~/.pypirc` и установлен twine:
-      ```bash
-      pip install twine
-      twine upload dist/*
-      ```
-
-### Типовые проблемы и решения
-- **Примеры или документация не попадают в пакет:**
-  - Убедитесь, что они находятся внутри основного пакета и правильно указаны в `package_data` и `MANIFEST.in`.
-- **Каталог docs не виден в wheel:**
-  - Проверьте расширения файлов и шаблоны в `package_data`/`MANIFEST.in`.
-- **Проверяйте установку только через wheel, а не через sdist!**
-
-**Best practice:**
-- Для публикации документации используйте GitHub и PyPI project page (README.md).
-- Для примеров — всегда размещайте их внутри пакета, если хотите распространять с wheel. 

mcp_proxy_adapter-2.1.11.dist-info/RECORD

@@ -1,29 +0,0 @@
-mcp_proxy_adapter/__init__.py,sha256=_6D-TfANWp9zc550M5LUeGPvioFqG1bAl3tZj-gNmJU,463
-mcp_proxy_adapter/adapter.py,sha256=76dkVeDuqLsJ5AhuftzLlwy2M6yr_PfNbmNfo9dXVhc,28844
-mcp_proxy_adapter/models.py,sha256=acqVQBYAojHXeJ1MJyvpMyT6-J6aMxWuZMszn_-RsOU,2338
-mcp_proxy_adapter/registry.py,sha256=jgC4TKaPbMbAsoxvGp2ToaOE4drD-VfZug7WJbm4IW4,15853
-mcp_proxy_adapter/schema.py,sha256=HZM0TTQTSi8ha1TEeVevdCyGZOUPoT1soB7Nex0hV50,10947
-mcp_proxy_adapter/testing_utils.py,sha256=RWjQFNSUtVkeP0qNzp6_jrT6_tub3w_052DrRmvxVk0,4243
-mcp_proxy_adapter/analyzers/__init__.py,sha256=2rcYZDP-bXq078MQpxP32lAwYYyRhOwAQGBcefBfBzY,368
-mcp_proxy_adapter/analyzers/docstring_analyzer.py,sha256=T3FLJEo_uChShfiEKRl8GpVoHvh5HiudZkxnj4KixfA,7541
-mcp_proxy_adapter/analyzers/type_analyzer.py,sha256=6Wac7osKwF03waFSwQ8ZM0Wqn_zAP2D-I4WMEpR0hQM,5230
-mcp_proxy_adapter/dispatchers/__init__.py,sha256=FWgimgInGphIjCEnvA3-ZExiapUzYAVis2H9C5IWivU,365
-mcp_proxy_adapter/dispatchers/base_dispatcher.py,sha256=S5_Xri058jAmOWeit1tedB_GMZQ9RLcNcYabA83ZF6k,2288
-mcp_proxy_adapter/dispatchers/json_rpc_dispatcher.py,sha256=S98qSj0p3glfiPcRirqCZaoiD9PrVVM3t7Lrgd6S8kM,6461
-mcp_proxy_adapter/examples/analyze_config.py,sha256=vog7TNHDw5ZoYhQLbAvZvEoufmQwH54KJzQBJrSq5w4,4283
-mcp_proxy_adapter/examples/basic_integration.py,sha256=w_oA777YiQt36gzI113KPQ6k45caXbMCqW9hD8sy8zo,4657
-mcp_proxy_adapter/examples/docstring_and_schema_example.py,sha256=c96L4KF_7yWzffmvd4hyeQuXSdYyYkv7Uvuy0QxgMcQ,1929
-mcp_proxy_adapter/examples/extension_example.py,sha256=vnatnFdNTapMpPcQ79Ugitk92ZiUfpLTs7Dvsodf1og,2277
-mcp_proxy_adapter/examples/help_best_practices.py,sha256=Bit9Ywl9vGvM_kuV8DJ6pIDK4mY4mF2Gia9rLc56RpI,2646
-mcp_proxy_adapter/examples/help_usage.py,sha256=9-65TyECtQYqPJLG3tlOWctI1zoCh6dEewh_i8mCdus,2577
-mcp_proxy_adapter/examples/mcp_proxy_client.py,sha256=z4IzFlGigVTQSb8TpcrQ_a0migsmC58LnNwc8wZmTfw,3811
-mcp_proxy_adapter/examples/openapi_server.py,sha256=KjUkXnGMnCxiRd71b1NFoHf40y9REXFqnmaxAgK4FB8,13229
-mcp_proxy_adapter/examples/project_structure_example.py,sha256=sswTo6FZb1F5juHa0FYG3cgvrh3wfgGfJu2bBy5tCm4,1460
-mcp_proxy_adapter/examples/testing_example.py,sha256=AB13c4C1bjs1145O-yriwyreeVXtMOlQLzs2BCGmprk,1719
-mcp_proxy_adapter/validators/docstring_validator.py,sha256=Onpq2iNJ1qF4ejkJJIlBkLROuSNIVALHVmXIgkCpaFI,2934
-mcp_proxy_adapter/validators/metadata_validator.py,sha256=uCrn38-VYYn89l6f5CC_GoTAHAweaOW2Z6Esro1rtGw,3155
-mcp_proxy_adapter-2.1.11.dist-info/licenses/LICENSE,sha256=OkApFEwdgMCt_mbvUI-eIwKMSTe38K3XnU2DT5ub-wI,1072
-mcp_proxy_adapter-2.1.11.dist-info/METADATA,sha256=2Z-WGz0AwAtHoUkUDhvQ1B_3enFmOj7epWGpm4C7UZo,12579
-mcp_proxy_adapter-2.1.11.dist-info/WHEEL,sha256=GHB6lJx2juba1wDgXDNlMTyM13ckjBMKf-OnwgKOCtA,91
-mcp_proxy_adapter-2.1.11.dist-info/top_level.txt,sha256=JZT7vPLBYrtroX-ij68JBhJYbjDdghcV-DFySRy-Nnw,18
-mcp_proxy_adapter-2.1.11.dist-info/RECORD,,