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

mcp_proxy_adapter-2.1.17.dist-info/METADATA

@@ -1,376 +0,0 @@
-Metadata-Version: 2.4
-Name: mcp-proxy-adapter
-Version: 2.1.17
-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
-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)
-
-registry.register_command("calculate_total", calculate_total)
-
-# 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()
-
-def get_discounted_price(price: float, discount: float = 0.0) -> float:
-    """
-    Returns the price after applying a discount.
-    """
-    return price * (1 - discount / 100)
-
-registry.register_command("get_discounted_price", get_discounted_price)
-
-# 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
-
-## FAQ
-
-**Q: Почему не удаётся использовать декоратор @registry.command для регистрации команд?**
-A: В последних версиях пакета декоратор @registry.command больше не поддерживается. Теперь команды регистрируются только явно, через вызов метода:
-
-```python
-registry.register_command("имя_команды", функция)
-```
-
-**Q: Почему не удаётся импортировать CommandRegistry напрямую из mcp_proxy_adapter?**
-A: Класс CommandRegistry находится в подмодуле registry. Используйте:
-
-```python
-from mcp_proxy_adapter.registry import CommandRegistry
-```
-
-**Q: Какой способ импорта MCPProxyAdapter и configure_logger?**
-A: Импортируйте их из подмодуля adapter:
-
-```python
-from mcp_proxy_adapter.adapter import MCPProxyAdapter, configure_logger
-```
-
-**Q: Как добавить свою команду?**
-A: Зарегистрируйте функцию через registry.register_command или декоратор (см. примеры выше).
-
-**Q: Как получить OpenAPI-схему?**
-A: После регистрации адаптера вызовите /openapi.json в вашем FastAPI-приложении.
-
-**Q: Какой формат запроса поддерживается?**
-A: JSON-RPC, MCP Proxy и params-only (см. раздел Supported Request Formats).
-
-## HOWTO
-
-**Как интегрировать MCP Proxy Adapter с FastAPI:**
-1. Установите пакет:
-   ```bash
-   pip install mcp-proxy-adapter
-   ```
-2. Импортируйте нужные классы:
-   ```python
-   from mcp_proxy_adapter.registry import CommandRegistry
-   from mcp_proxy_adapter.adapter import MCPProxyAdapter
-   ```
-3. Зарегистрируйте команды и настройте FastAPI:
-   ```python
-   registry = CommandRegistry()
-   registry.register_command("my_command", my_function)
-   app = FastAPI()
-   adapter = MCPProxyAdapter(registry)
-   adapter.register_endpoints(app)
-   ```
-4. (Опционально) Сохраните конфиг для MCP Proxy:
-   ```python
-   adapter.save_config_to_file("mcp_proxy_config.json")
-   ```
-
-**Как добавить поддержку кастомного логгера:**
-```python
-import logging
-from mcp_proxy_adapter.adapter import configure_logger
-logger = logging.getLogger("my_project")
-adapter_logger = configure_logger(logger)
-```
-
-**Как получить список всех команд через API:**
-Вызовите GET `/api/commands` на вашем сервере FastAPI.
-
-## License
-MIT
-
-## Documentation
-See [docs/](docs/) for detailed guides, architecture, and examples.
-
-## CI/CD & PyPI automation
-
-This project uses GitHub Actions for continuous integration and automated publishing to PyPI.
-
-- All tests are run on every push and pull request.
-- On push of a new tag (vX.Y.Z), the package is built and published to PyPI automatically.
-
-See `.github/workflows/publish.yml` for details.
-
-## Встроенная команда help: правила и типовые ошибки
-
-### Как работает
-- Команда `help` всегда встроена в MCPProxyAdapter и не требует реализации или регистрации со стороны пользователя.
-- Для получения справки по конкретной команде используйте параметр `cmdname`:
-  ```json
-  {"jsonrpc": "2.0", "method": "help", "params": {"cmdname": "имя_команды"}, "id": 1}
-  ```
-- Для получения списка всех команд:
-  ```json
-  {"jsonrpc": "2.0", "method": "help", "id": 1}
-  ```
-
-### Типовые ошибки и их решения
-- **Ошибка: передан параметр `command` вместо `cmdname`**
-  - Ответ: 
-    ```json
-    {"error": "Parameter 'command' is not supported. Use 'cmdname' instead.", "hint": "Send params: {\"cmdname\": \"your_command\"}", ...}
-    ```
-  - **Решение:** всегда используйте `cmdname`.
-- **Ошибка сериализации coroutine**
-  - Причина: handler вызывается без await, либо возвращает coroutine.
-  - Ответ:
-    ```json
-    {"error": "Help handler must be awaited. Call as await dispatcher.execute('help', ...) in async context.", ...}
-    ```
-  - **Решение:** всегда await-ить dispatcher.execute в async endpoint.
-
-### Важно для интеграторов и пользователей
-- Не реализуйте свой обработчик help — используйте встроенный.
-- Не используйте параметр `command` — только `cmdname`.
-- Все ошибки help-команды теперь сопровождаются понятной подсказкой и примером корректного запроса.
-
---- 

mcp_proxy_adapter-2.1.17.dist-info/RECORD

@@ -1,30 +0,0 @@
-mcp_proxy_adapter/__init__.py,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
-mcp_proxy_adapter/adapter.py,sha256=x5pT-t4uT12O3GzLurrKBSQ_hwVpjhCRx5oZ5AdZnpY,28856
-mcp_proxy_adapter/models.py,sha256=8zVWU6ly18pWozOnKQ2gsGpmTgL37-fFE_Fr1SDW-Nk,2530
-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=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
-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=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
-mcp_proxy_adapter/dispatchers/base_dispatcher.py,sha256=S5_Xri058jAmOWeit1tedB_GMZQ9RLcNcYabA83ZF6k,2288
-mcp_proxy_adapter/dispatchers/json_rpc_dispatcher.py,sha256=DBhO8DKPBKKBsARlq6IesnOFvl4GU6XVDP8gB6hZMpk,9885
-mcp_proxy_adapter/examples/analyze_config.py,sha256=vog7TNHDw5ZoYhQLbAvZvEoufmQwH54KJzQBJrSq5w4,4283
-mcp_proxy_adapter/examples/basic_integration.py,sha256=mtRval4VSUgTb_C2p8U_DPPSEKA08dZYKZk-bOrE4H4,4470
-mcp_proxy_adapter/examples/docstring_and_schema_example.py,sha256=wFg3Cf2Jgve0J5kFzApvFSII8JOsOGaych64hIC7FqQ,2183
-mcp_proxy_adapter/examples/extension_example.py,sha256=W5fcvPHjpDSPQnmhAWDJqZtLoUfY7h58ZzFoFXDF3Fc,2525
-mcp_proxy_adapter/examples/help_best_practices.py,sha256=ByHMDiBT9V-cHoSMr2q0PmbteKELY8mTGeJrvAxOWpY,2646
-mcp_proxy_adapter/examples/help_usage.py,sha256=pEwb8-QhiWuBPCK9cbHW-oMKxk4WMo345SHIAl-dosg,2577
-mcp_proxy_adapter/examples/mcp_proxy_client.py,sha256=z4IzFlGigVTQSb8TpcrQ_a0migsmC58LnNwc8wZmTfw,3811
-mcp_proxy_adapter/examples/openapi_server.py,sha256=HUcnv_XEEur1kLuAotHuwwAhykApVXgVj4miOgk8DYA,13229
-mcp_proxy_adapter/examples/project_structure_example.py,sha256=sswTo6FZb1F5juHa0FYG3cgvrh3wfgGfJu2bBy5tCm4,1460
-mcp_proxy_adapter/examples/testing_example.py,sha256=OxFUhGP9OXiu9eWjSpytpQ5MzoR9uww3M4jYb0_v7dc,2004
-mcp_proxy_adapter/validators/__init__.py,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
-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.17.dist-info/licenses/LICENSE,sha256=OkApFEwdgMCt_mbvUI-eIwKMSTe38K3XnU2DT5ub-wI,1072
-mcp_proxy_adapter-2.1.17.dist-info/METADATA,sha256=Ru_MBUNRwbAxzhofC-0M8JD-NmnzmI2-h9wbgned1Z4,10822
-mcp_proxy_adapter-2.1.17.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-mcp_proxy_adapter-2.1.17.dist-info/top_level.txt,sha256=JZT7vPLBYrtroX-ij68JBhJYbjDdghcV-DFySRy-Nnw,18
-mcp_proxy_adapter-2.1.17.dist-info/RECORD,,