mcp-proxy-adapter 4.1.0__tar.gz → 4.1.1__tar.gz

{mcp_proxy_adapter-4.1.0/mcp_proxy_adapter.egg-info → mcp_proxy_adapter-4.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-proxy-adapter
-Version: 4.1.0
+Version: 4.1.1
 Summary: Reliable microservice with unified JSON-RPC endpoint
 Home-page: https://github.com/maverikod/mcp-proxy-adapter
 Author: Vasiliy Zdanovskiy

mcp_proxy_adapter-4.1.1/docs/EN/user/configuration.md

@@ -0,0 +1,128 @@
+# Configuration
+
+This guide describes how to configure the MCP Proxy service.
+
+## Configuration File
+
+The MCP Proxy service is configured using a JSON configuration file. By default, it looks for a file named `config.json` in the current directory.
+
+You can specify a different configuration file using the `--config` command-line option:
+
+```bash
+mcp-proxy --config /path/to/config.json
+```
+
+## Configuration Options
+
+The configuration is organized into sections. Here are the available options:
+
+### Server Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| server.host | string | "0.0.0.0" | The host to bind the service to |
+| server.port | number | 8000 | The port to listen on |
+| server.debug | boolean | false | Enable debug mode |
+| server.log_level | string | "INFO" | The logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
+
+### Logging Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| logging.level | string | "INFO" | The logging level |
+| logging.log_dir | string | "./logs" | Directory for log files |
+| logging.log_file | string | "mcp_proxy_adapter.log" | Main log file name |
+| logging.error_log_file | string | "mcp_proxy_adapter_error.log" | Error log file name |
+| logging.access_log_file | string | "mcp_proxy_adapter_access.log" | Access log file name |
+| logging.max_file_size | string | "10MB" | Maximum log file size |
+| logging.backup_count | number | 5 | Number of backup log files |
+| logging.console_output | boolean | true | Enable console logging |
+| logging.file_output | boolean | true | Enable file logging |
+
+### Commands Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| commands.auto_discovery | boolean | true | Enable automatic command discovery |
+| commands.discovery_path | string | "mcp_proxy_adapter.commands" | **Path to package with commands** |
+| commands.custom_commands_path | string | null | Path to custom commands (deprecated) |
+
+**Important**: The `commands.discovery_path` parameter specifies the Python package path where your commands are located. For example:
+- `"mcp_proxy_adapter.commands"` - built-in commands
+- `"myproject.commands"` - your project's commands
+- `"custom_commands.commands"` - custom commands package
+
+## Example Configuration
+
+Here's an example configuration file:
+
+```json
+{
+  "server": {
+    "host": "0.0.0.0",
+    "port": 8000,
+    "debug": false,
+    "log_level": "INFO"
+  },
+  "logging": {
+    "level": "INFO",
+    "log_dir": "./logs",
+    "log_file": "mcp_proxy_adapter.log",
+    "error_log_file": "mcp_proxy_adapter_error.log",
+    "access_log_file": "mcp_proxy_adapter_access.log",
+    "max_file_size": "10MB",
+    "backup_count": 5,
+    "console_output": true,
+    "file_output": true
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "mcp_proxy_adapter.commands",
+    "custom_commands_path": null
+  }
+}
+```
+
+### Example with Custom Commands
+
+If you have your own commands in a package called `myproject.commands`:
+
+```json
+{
+  "server": {
+    "host": "127.0.0.1",
+    "port": 8001,
+    "debug": true,
+    "log_level": "DEBUG"
+  },
+  "logging": {
+    "level": "DEBUG",
+    "log_dir": "./logs",
+    "log_file": "myproject.log"
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "myproject.commands"
+  }
+}
+```
+
+## Environment Variables
+
+You can also configure the service using environment variables. Environment variables take precedence over the configuration file.
+
+The environment variable format is `MCP_UPPERCASE_OPTION_NAME`. For example, to set the port:
+
+```bash
+export MCP_PORT=8000
+```
+
+## Testing the Configuration
+
+To verify your configuration, you can run the service with the `--validate-config` option:
+
+```bash
+mcp-proxy --config /path/to/config.json --validate-config
+```
+
+This will validate the configuration file and exit without starting the service. 

mcp_proxy_adapter-4.1.1/docs/RU/user/configuration.md

@@ -0,0 +1,128 @@
+# Конфигурация
+
+Это руководство описывает, как настроить сервис MCP Proxy.
+
+## Файл конфигурации
+
+Сервис MCP Proxy настраивается с помощью JSON-файла конфигурации. По умолчанию он ищет файл с именем `config.json` в текущей директории.
+
+Вы можете указать другой файл конфигурации с помощью опции командной строки `--config`:
+
+```bash
+mcp-proxy --config /path/to/config.json
+```
+
+## Параметры конфигурации
+
+Конфигурация организована в секции. Вот доступные параметры:
+
+### Конфигурация сервера
+
+| Параметр | Тип | По умолчанию | Описание |
+|----------|-----|--------------|----------|
+| server.host | string | "0.0.0.0" | Хост для привязки сервиса |
+| server.port | number | 8000 | Порт для прослушивания |
+| server.debug | boolean | false | Включить режим отладки |
+| server.log_level | string | "INFO" | Уровень логирования (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
+
+### Конфигурация логирования
+
+| Параметр | Тип | По умолчанию | Описание |
+|----------|-----|--------------|----------|
+| logging.level | string | "INFO" | Уровень логирования |
+| logging.log_dir | string | "./logs" | Директория для файлов логов |
+| logging.log_file | string | "mcp_proxy_adapter.log" | Имя основного файла логов |
+| logging.error_log_file | string | "mcp_proxy_adapter_error.log" | Имя файла логов ошибок |
+| logging.access_log_file | string | "mcp_proxy_adapter_access.log" | Имя файла логов доступа |
+| logging.max_file_size | string | "10MB" | Максимальный размер файла логов |
+| logging.backup_count | number | 5 | Количество резервных файлов логов |
+| logging.console_output | boolean | true | Включить логирование в консоль |
+| logging.file_output | boolean | true | Включить логирование в файл |
+
+### Конфигурация команд
+
+| Параметр | Тип | По умолчанию | Описание |
+|----------|-----|--------------|----------|
+| commands.auto_discovery | boolean | true | Включить автоматическое обнаружение команд |
+| commands.discovery_path | string | "mcp_proxy_adapter.commands" | **Путь к пакету с командами** |
+| commands.custom_commands_path | string | null | Путь к пользовательским командам (устарел) |
+
+**Важно**: Параметр `commands.discovery_path` указывает путь к Python пакету, где находятся ваши команды. Например:
+- `"mcp_proxy_adapter.commands"` - встроенные команды
+- `"myproject.commands"` - команды вашего проекта
+- `"custom_commands.commands"` - пакет пользовательских команд
+
+## Пример конфигурации
+
+Вот пример файла конфигурации:
+
+```json
+{
+  "server": {
+    "host": "0.0.0.0",
+    "port": 8000,
+    "debug": false,
+    "log_level": "INFO"
+  },
+  "logging": {
+    "level": "INFO",
+    "log_dir": "./logs",
+    "log_file": "mcp_proxy_adapter.log",
+    "error_log_file": "mcp_proxy_adapter_error.log",
+    "access_log_file": "mcp_proxy_adapter_access.log",
+    "max_file_size": "10MB",
+    "backup_count": 5,
+    "console_output": true,
+    "file_output": true
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "mcp_proxy_adapter.commands",
+    "custom_commands_path": null
+  }
+}
+```
+
+### Пример с пользовательскими командами
+
+Если у вас есть свои команды в пакете `myproject.commands`:
+
+```json
+{
+  "server": {
+    "host": "127.0.0.1",
+    "port": 8001,
+    "debug": true,
+    "log_level": "DEBUG"
+  },
+  "logging": {
+    "level": "DEBUG",
+    "log_dir": "./logs",
+    "log_file": "myproject.log"
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "myproject.commands"
+  }
+}
+```
+
+## Переменные окружения
+
+Вы также можете настроить сервис с помощью переменных окружения. Переменные окружения имеют приоритет над файлом конфигурации.
+
+Формат переменной окружения: `MCP_UPPERCASE_OPTION_NAME`. Например, чтобы установить порт:
+
+```bash
+export MCP_PORT=8000
+```
+
+## Тестирование конфигурации
+
+Для проверки конфигурации вы можете запустить сервис с опцией `--validate-config`:
+
+```bash
+mcp-proxy --config /path/to/config.json --validate-config
+```
+
+Это проверит файл конфигурации и завершит работу без запуска сервиса. 

mcp_proxy_adapter-4.1.1/examples/custom_project_example/README.md

@@ -0,0 +1,103 @@
+# Пример пользовательского проекта с командами
+
+Этот пример показывает, как создать свой проект с командами и настроить `discovery_path` для их автоматического обнаружения.
+
+## Структура проекта
+
+```
+myproject/
+├── config.json
+├── main.py
+├── myproject/
+│   ├── __init__.py
+│   └── commands/
+│       ├── __init__.py
+│       ├── echo_command.py
+│       └── info_command.py
+└── README.md
+```
+
+## Конфигурация
+
+В файле `config.json` указываем путь к нашим командам:
+
+```json
+{
+  "server": {
+    "host": "127.0.0.1",
+    "port": 8001,
+    "debug": true,
+    "log_level": "DEBUG"
+  },
+  "logging": {
+    "level": "DEBUG",
+    "log_dir": "./logs",
+    "log_file": "myproject.log"
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "myproject.commands"
+  }
+}
+```
+
+## Команды
+
+### echo_command.py
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import CommandResult
+
+class EchoCommand(Command):
+    """Echo command that returns the input text."""
+    
+    name = "echo"
+    
+    def execute(self, text: str) -> CommandResult:
+        return CommandResult(success=True, data={"echo": text})
+    
+    @classmethod
+    def get_param_info(cls) -> dict:
+        return {
+            "text": {
+                "type": "string",
+                "description": "Text to echo",
+                "required": True
+            }
+        }
+```
+
+### info_command.py
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import CommandResult
+
+class InfoCommand(Command):
+    """Info command that returns project information."""
+    
+    name = "info"
+    
+    def execute(self) -> CommandResult:
+        return CommandResult(
+            success=True, 
+            data={
+                "project": "myproject",
+                "version": "1.0.0",
+                "description": "Example project with custom commands"
+            }
+        )
+    
+    @classmethod
+    def get_param_info(cls) -> dict:
+        return {}
+```
+
+## Запуск
+
+```bash
+python main.py
+```
+
+При запуске сервис автоматически обнаружит команды из пакета `myproject.commands` благодаря настройке `discovery_path` в конфигурации. 

mcp_proxy_adapter-4.1.1/examples/custom_project_example/README_EN.md

@@ -0,0 +1,103 @@
+# Custom Project Example with Commands
+
+This example shows how to create your own project with commands and configure `discovery_path` for their automatic discovery.
+
+## Project Structure
+
+```
+myproject/
+├── config.json
+├── main.py
+├── myproject/
+│   ├── __init__.py
+│   └── commands/
+│       ├── __init__.py
+│       ├── echo_command.py
+│       └── info_command.py
+└── README.md
+```
+
+## Configuration
+
+In the `config.json` file, specify the path to our commands:
+
+```json
+{
+  "server": {
+    "host": "127.0.0.1",
+    "port": 8001,
+    "debug": true,
+    "log_level": "DEBUG"
+  },
+  "logging": {
+    "level": "DEBUG",
+    "log_dir": "./logs",
+    "log_file": "myproject.log"
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "myproject.commands"
+  }
+}
+```
+
+## Commands
+
+### echo_command.py
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import CommandResult
+
+class EchoCommand(Command):
+    """Echo command that returns the input text."""
+    
+    name = "echo"
+    
+    def execute(self, text: str) -> CommandResult:
+        return CommandResult(success=True, data={"echo": text})
+    
+    @classmethod
+    def get_param_info(cls) -> dict:
+        return {
+            "text": {
+                "type": "string",
+                "description": "Text to echo",
+                "required": True
+            }
+        }
+```
+
+### info_command.py
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import CommandResult
+
+class InfoCommand(Command):
+    """Info command that returns project information."""
+    
+    name = "info"
+    
+    def execute(self) -> CommandResult:
+        return CommandResult(
+            success=True, 
+            data={
+                "project": "myproject",
+                "version": "1.0.0",
+                "description": "Example project with custom commands"
+            }
+        )
+    
+    @classmethod
+    def get_param_info(cls) -> dict:
+        return {}
+```
+
+## Running
+
+```bash
+python main.py
+```
+
+When starting, the service will automatically discover commands from the `myproject.commands` package thanks to the `discovery_path` configuration setting. 

mcp_proxy_adapter-4.1.1/examples/simple_custom_commands/README.md

@@ -0,0 +1,149 @@
+# Простой пример с пользовательскими командами
+
+Этот пример показывает, как настроить `discovery_path` в конфигурации для автоматического обнаружения команд из вашего проекта.
+
+## Структура проекта
+
+```
+simple_custom_commands/
+├── config.json          # Конфигурация с discovery_path
+├── main.py              # Точка входа
+├── my_commands/         # Пакет с командами
+│   ├── __init__.py
+│   ├── hello_command.py
+│   └── calc_command.py
+└── README.md
+```
+
+## Конфигурация (config.json)
+
+```json
+{
+  "server": {
+    "host": "127.0.0.1",
+    "port": 8001,
+    "debug": true,
+    "log_level": "DEBUG"
+  },
+  "logging": {
+    "level": "DEBUG",
+    "log_dir": "./logs",
+    "log_file": "simple_commands.log"
+  },
+  "commands": {
+    "auto_discovery": true,
+    "discovery_path": "my_commands"
+  }
+}
+```
+
+**Ключевой момент**: В `discovery_path` указан путь `"my_commands"` - это пакет, где находятся команды.
+
+## Команды
+
+### hello_command.py
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import CommandResult
+
+class HelloCommand(Command):
+    """Простая команда приветствия."""
+    
+    name = "hello"
+    
+    def execute(self, name: str = "World") -> CommandResult:
+        return CommandResult(
+            success=True, 
+            data={"message": f"Hello, {name}!"}
+        )
+    
+    @classmethod
+    def get_param_info(cls) -> dict:
+        return {
+            "name": {
+                "type": "string",
+                "description": "Имя для приветствия",
+                "required": False,
+                "default": "World"
+            }
+        }
+```
+
+### calc_command.py
+
+```python
+from mcp_proxy_adapter.commands.base import Command
+from mcp_proxy_adapter.commands.result import CommandResult
+
+class CalcCommand(Command):
+    """Простая команда калькулятора."""
+    
+    name = "calc"
+    
+    def execute(self, a: float, b: float, operation: str = "add") -> CommandResult:
+        if operation == "add":
+            result = a + b
+        elif operation == "sub":
+            result = a - b
+        elif operation == "mul":
+            result = a * b
+        elif operation == "div":
+            if b == 0:
+                return CommandResult(success=False, error="Division by zero")
+            result = a / b
+        else:
+            return CommandResult(success=False, error=f"Unknown operation: {operation}")
+        
+        return CommandResult(
+            success=True, 
+            data={"result": result, "operation": operation}
+        )
+    
+    @classmethod
+    def get_param_info(cls) -> dict:
+        return {
+            "a": {
+                "type": "number",
+                "description": "Первое число",
+                "required": True
+            },
+            "b": {
+                "type": "number", 
+                "description": "Второе число",
+                "required": True
+            },
+            "operation": {
+                "type": "string",
+                "description": "Операция (add, sub, mul, div)",
+                "required": False,
+                "default": "add"
+            }
+        }
+```
+
+## Запуск
+
+```bash
+python main.py
+```
+
+При запуске сервис автоматически обнаружит команды из пакета `my_commands` благодаря настройке `discovery_path` в конфигурации.
+
+## Тестирование
+
+```bash
+# Приветствие
+curl -X POST http://127.0.0.1:8001/cmd \
+  -H "Content-Type: application/json" \
+  -d '{"command": "hello", "params": {"name": "Alice"}}'
+
+# Калькулятор
+curl -X POST http://127.0.0.1:8001/cmd \
+  -H "Content-Type: application/json" \
+  -d '{"command": "calc", "params": {"a": 10, "b": 5, "operation": "add"}}'
+```
+
+## Результат
+
+Сервис автоматически обнаружит и зарегистрирует команды `hello` и `calc` из пакета `my_commands`, указанного в `discovery_path`.