mcp-proxy-adapter 2.1.2__py3-none-any.whl → 2.1.4__py3-none-any.whl

{examples → mcp_proxy_adapter/examples}/openapi_server.py

@@ -90,7 +90,8 @@ class MockDispatcher:
             "update_item": self.update_item,
             "delete_item": self.delete_item,
             "search_items": self.search_items,
-            "execute": self.execute_command
+            "execute": self.execute_command,
+            "help": self.help_command
         }
         self.commands_info = {
             "get_items": {
@@ -166,14 +167,24 @@ class MockDispatcher:
                         "required": False
                     }
                 }
+            },
+            "help": {
+                "description": "Show information about available commands or a specific command.",
+                "params": {
+                    "command": {
+                        "type": "string",
+                        "description": "Command name for detailed info",
+                        "required": False
+                    }
+                }
             }
         }
     
-    def execute(self, command, **params):
+    def execute(self, command_name, **params):
         """Executes command with specified parameters."""
-        if command not in self.commands:
-            raise KeyError(f"Unknown command: {command}")
-        return self.commands[command](**params)
+        if command_name not in self.commands:
+            raise KeyError(f"Unknown command: {command_name}")
+        return self.commands[command_name](**params)
         
     def execute_command(self, **params):
         """Universal method for executing commands."""
@@ -209,9 +220,9 @@ class MockDispatcher:
         """Returns list of available commands."""
         return list(self.commands.keys())
     
-    def get_command_info(self, command):
+    def get_command_info(self, command_name):
         """Returns information about command."""
-        return self.commands_info.get(command)
+        return self.commands_info.get(command_name)
     
     def get_commands_info(self):
         """Returns information about all commands."""
@@ -265,6 +276,23 @@ class MockDispatcher:
                (item["description"] and keyword in item["description"].lower())
         ]
 
+    def help_command(self, **params):
+        """Return info about all commands or a specific command."""
+        # Если в будущем появится пользовательская команда help, можно реализовать её здесь
+        command = params.get("command")
+        if command:
+            info = self.commands_info.get(command)
+            if info:
+                return {"command": command, "info": info}
+            else:
+                return {"error": f"Command '{command}' not found", "available_commands": list(self.commands_info.keys())}
+        # Если параметр command не указан, возвращаем краткую информацию обо всех
+        return {
+            "commands": {cmd: {"description": info["description"], "params": info["params"]} for cmd, info in self.commands_info.items()},
+            "total": len(self.commands_info),
+            "note": "Use the 'command' parameter to get detailed information about a specific command"
+        }
+
 class CustomMockRegistry(MockRegistry):
     """Custom command registry for example."""
     

{mcp_proxy_adapter-2.1.2.dist-info → mcp_proxy_adapter-2.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-proxy-adapter
-Version: 2.1.2
+Version: 2.1.4
 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
@@ -303,4 +303,100 @@ See [docs/](docs/) for detailed guides, architecture, and examples.
 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) 
+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.4.dist-info/RECORD

@@ -0,0 +1,28 @@
+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/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=ffu1M32E1AdC7IB44mlbV2L56eJQMsp-7fYi_r4rmHc,6331
+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=wUtZRnAktnpfAc9vAvqSxUquHEr5ewaPDPyc6BoCqdQ,2637
+mcp_proxy_adapter/examples/help_usage.py,sha256=UOd3HJeYlQpQkAyceGNm66jXX_h-T05pjIGD-b7-Pfg,2568
+mcp_proxy_adapter/examples/mcp_proxy_client.py,sha256=z4IzFlGigVTQSb8TpcrQ_a0migsmC58LnNwc8wZmTfw,3811
+mcp_proxy_adapter/examples/openapi_server.py,sha256=xAt-aUEz5vusvz7fd1vFIybi4EpwlnGPXLsce3j3YZw,14024
+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.4.dist-info/licenses/LICENSE,sha256=OkApFEwdgMCt_mbvUI-eIwKMSTe38K3XnU2DT5ub-wI,1072
+mcp_proxy_adapter-2.1.4.dist-info/METADATA,sha256=u8AFozMDHraUrudOrA6D62VLkHL3s9LC36O2U29yR9g,12578
+mcp_proxy_adapter-2.1.4.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+mcp_proxy_adapter-2.1.4.dist-info/top_level.txt,sha256=JZT7vPLBYrtroX-ij68JBhJYbjDdghcV-DFySRy-Nnw,18
+mcp_proxy_adapter-2.1.4.dist-info/RECORD,,

mcp_proxy_adapter-2.1.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+mcp_proxy_adapter

docs/README.md

@@ -1,172 +0,0 @@
-# Command Registry
-
-## Overview
-
-Command Registry is a high-level system for centralized command management in applications. It provides a unified mechanism for defining, registering, executing, and documenting commands through various interfaces.
-
-## Key Features
-
-- **Single access point** for application commands
-- **Automatic metadata extraction** from Python docstrings and type hints
-- **Integration with various protocols** (REST, JSON-RPC, WebSockets)
-- **API documentation generation** based on command metadata
-- **Input parameters and output values validation**
-- **Metadata compliance verification** with actual function signatures
-- **Extensibility** through interfaces for dispatchers, adapters, and schema generators
-- **AI model integration** via MCP Proxy Adapter
-
-## Getting Started
-
-### Installation
-
-```bash
-pip install command-registry
-```
-
-For MCP Proxy integration, also install:
-
-```bash
-pip install mcp-proxy-adapter
-```
-
-### Simple Example
-
-```python
-from command_registry import CommandRegistry
-
-# Create a command registry instance
-registry = CommandRegistry()
-
-# Define a command
-def add_numbers(a: int, b: int) -> int:
-    """Adds two numbers.
-    
-    Args:
-        a: First number
-        b: Second number
-        
-    Returns:
-        Sum of numbers a and b
-    """
-    return a + b
-
-# Register the command
-registry.register_command("add", add_numbers)
-
-# Execute the command
-result = registry.execute("add", {"a": 5, "b": 3})  # Returns 8
-```
-
-### FastAPI Export
-
-```python
-from fastapi import FastAPI
-from command_registry.adapters import RESTAdapter
-
-app = FastAPI()
-adapter = RESTAdapter(registry)
-adapter.register_endpoints(app)
-```
-
-### MCP Proxy Integration for AI Models
-
-```python
-from fastapi import FastAPI
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-
-app = FastAPI()
-adapter = MCPProxyAdapter(registry)
-adapter.register_endpoints(app)
-
-# Create configuration for MCP Proxy
-adapter.save_config_to_file("mcp_proxy_config.json")
-```
-
-### Automatic Command Registration from Module
-
-```python
-# Scan module and register all found commands
-registry.scan_module("myapp.commands")
-```
-
-## Documentation
-
-- [Architecture](architecture.md) - detailed component description
-- [Command Development Guide](command_development.md) - best practices
-- [Examples](examples.md) - usage examples for various scenarios
-- [Validation](validation.md) - command validation mechanisms
-- [MCP Proxy Adapter](mcp_proxy_adapter.md) - AI model integration via MCP Proxy
-
-## Project Structure
-
-```
-command_registry/
-  ├── __init__.py            # Main public API
-  ├── core.py                # Core CommandRegistry logic
-  ├── dispatchers/           # Command dispatchers
-  │   ├── __init__.py
-  │   ├── base_dispatcher.py  # Abstract base class
-  │   └── command_dispatcher.py  # Main implementation
-  ├── metadata/              # Metadata extraction
-  │   ├── __init__.py
-  │   ├── docstring_parser.py  # Docstring parser
-  │   └── type_analyzer.py   # Type analyzer
-  ├── validators/            # Validators
-  │   ├── __init__.py
-  │   └── parameter_validator.py  # Parameter validation
-  ├── adapters/              # Protocol adapters
-  │   ├── __init__.py
-  │   ├── rest_adapter.py    # REST API
-  │   └── json_rpc_adapter.py  # JSON-RPC
-  └── schema/                # Schema generators
-      ├── __init__.py
-      ├── openapi_generator.py  # OpenAPI
-      └── json_schema_generator.py  # JSON Schema
-```
-
-## Integration with Existing Systems
-
-Command Registry is designed for easy integration with existing systems and frameworks:
-
-- **FastAPI** - via RESTAdapter
-- **Flask** - via RESTAdapter with modifications
-- **aiohttp** - via WebSockets adapter
-- **Click** - via CLI adapter
-- **GraphQL** - via GraphQL adapter
-- **MCP Proxy** - via MCPProxyAdapter for AI model integration
-
-## Usage Examples
-
-### REST API
-
-```python
-from fastapi import FastAPI
-from command_registry import CommandRegistry
-from command_registry.adapters import RESTAdapter
-
-app = FastAPI()
-registry = CommandRegistry()
-registry.scan_module("myapp.commands")
-
-adapter = RESTAdapter(registry)
-adapter.register_endpoints(app)
-```
-
-### JSON-RPC via MCP Proxy Adapter
-
-```python
-from fastapi import FastAPI
-from command_registry import CommandRegistry
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-
-app = FastAPI()
-registry = CommandRegistry()
-registry.scan_module("myapp.commands")
-
-adapter = MCPProxyAdapter(registry)
-adapter.register_endpoints(app)
-```
-
-## License
-
-MIT 

docs/README_ru.md

@@ -1,172 +0,0 @@
-# Command Registry
-
-## Обзор
-
-Command Registry - это высокоуровневая система для централизованного управления командами в приложении. Она предоставляет унифицированный механизм определения, регистрации, выполнения и документирования команд через различные интерфейсы.
-
-## Основные возможности
-
-- **Единая точка доступа** к командам приложения
-- **Автоматическое извлечение метаданных** из докстрингов и типизации Python
-- **Интеграция с различными протоколами** (REST, JSON-RPC, WebSockets)
-- **Генерация документации API** на основе метаданных команд
-- **Валидация входных параметров** и выходных значений
-- **Проверка соответствия метаданных** фактической сигнатуре функций
-- **Расширяемость** через интерфейсы для диспетчеров, адаптеров и генераторов схем
-- **Интеграция с моделями ИИ** через MCP Proxy Adapter
-
-## Начало работы
-
-### Установка
-
-```bash
-pip install command-registry
-```
-
-Для работы с MCP Proxy также установите:
-
-```bash
-pip install mcp-proxy-adapter
-```
-
-### Простой пример
-
-```python
-from command_registry import CommandRegistry
-
-# Создание экземпляра реестра команд
-registry = CommandRegistry()
-
-# Определение команды
-def add_numbers(a: int, b: int) -> int:
-    """Складывает два числа.
-    
-    Args:
-        a: Первое число
-        b: Второе число
-        
-    Returns:
-        Сумма чисел a и b
-    """
-    return a + b
-
-# Регистрация команды
-registry.register_command("add", add_numbers)
-
-# Выполнение команды
-result = registry.execute("add", {"a": 5, "b": 3})  # Вернёт 8
-```
-
-### Экспорт через FastAPI
-
-```python
-from fastapi import FastAPI
-from command_registry.adapters import RESTAdapter
-
-app = FastAPI()
-adapter = RESTAdapter(registry)
-adapter.register_endpoints(app)
-```
-
-### Интеграция с MCP Proxy для моделей ИИ
-
-```python
-from fastapi import FastAPI
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-
-app = FastAPI()
-adapter = MCPProxyAdapter(registry)
-adapter.register_endpoints(app)
-
-# Создание конфигурации для MCP Proxy
-adapter.save_config_to_file("mcp_proxy_config.json")
-```
-
-### Автоматическая регистрация команд из модуля
-
-```python
-# Сканирование модуля и регистрация всех найденных команд
-registry.scan_module("myapp.commands")
-```
-
-## Документация
-
-- [Архитектура](architecture.md) - подробное описание компонентов
-- [Руководство по разработке команд](command_development.md) - лучшие практики
-- [Примеры](examples.md) - примеры использования для различных сценариев
-- [Валидация](validation.md) - механизмы проверки команд
-- [MCP Proxy Adapter](mcp_proxy_adapter.md) - интеграция с моделями ИИ через MCP Proxy
-
-## Структура проекта
-
-```
-command_registry/
-  ├── __init__.py            # Основные публичные API
-  ├── core.py                # Основная логика CommandRegistry
-  ├── dispatchers/           # Диспетчеры команд
-  │   ├── __init__.py
-  │   ├── base_dispatcher.py  # Абстрактный базовый класс
-  │   └── command_dispatcher.py  # Основная реализация
-  ├── metadata/              # Извлечение метаданных
-  │   ├── __init__.py
-  │   ├── docstring_parser.py  # Парсер докстрингов
-  │   └── type_analyzer.py   # Анализатор типов
-  ├── validators/            # Валидаторы
-  │   ├── __init__.py
-  │   └── parameter_validator.py  # Валидация параметров
-  ├── adapters/              # Адаптеры протоколов
-  │   ├── __init__.py
-  │   ├── rest_adapter.py    # REST API
-  │   └── json_rpc_adapter.py  # JSON-RPC
-  └── schema/                # Генераторы схем
-      ├── __init__.py
-      ├── openapi_generator.py  # OpenAPI
-      └── json_schema_generator.py  # JSON Schema
-```
-
-## Интеграция с существующими системами
-
-Command Registry спроектирован для легкой интеграции с существующими системами и фреймворками:
-
-- **FastAPI** - через RESTAdapter
-- **Flask** - через RESTAdapter с модификациями
-- **aiohttp** - через адаптер для WebSockets
-- **Click** - через CLI адаптер
-- **GraphQL** - через GraphQL адаптер
-- **MCP Proxy** - через MCPProxyAdapter для интеграции с моделями ИИ
-
-## Примеры использования
-
-### REST API
-
-```python
-from fastapi import FastAPI
-from command_registry import CommandRegistry
-from command_registry.adapters import RESTAdapter
-
-app = FastAPI()
-registry = CommandRegistry()
-registry.scan_module("myapp.commands")
-
-adapter = RESTAdapter(registry)
-adapter.register_endpoints(app)
-```
-
-### JSON-RPC через MCP Proxy Adapter
-
-```python
-from fastapi import FastAPI
-from command_registry import CommandRegistry
-from mcp_proxy_adapter.adapter import MCPProxyAdapter
-
-app = FastAPI()
-registry = CommandRegistry()
-registry.scan_module("myapp.commands")
-
-adapter = MCPProxyAdapter(registry)
-adapter.register_endpoints(app)
-```
-
-## Лицензия
-
-MIT