mcp-proxy-adapter 3.1.6__tar.gz → 4.0.0__tar.gz

{mcp_proxy_adapter-3.1.6/mcp_proxy_adapter.egg-info → mcp_proxy_adapter-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-proxy-adapter
-Version: 3.1.6
+Version: 4.0.0
 Summary: Reliable microservice with unified JSON-RPC endpoint
 Home-page: https://github.com/yourusername/mcp-proxy-adapter
 Author: MCP Team

mcp_proxy_adapter-4.0.0/docs/EN/commands/reload_settings_command.md

@@ -0,0 +1,183 @@
+# Reload Settings Command
+
+The `reload_settings` command allows you to reload configuration settings from files and environment variables at runtime.
+
+## Description
+
+The reload settings command provides the ability to:
+- Reload configuration from JSON files
+- Reload environment variables
+- Update custom settings
+- Get current custom settings after reload
+
+## Command Information
+
+- **Name**: `reload_settings`
+- **Description**: Reload configuration settings from files and environment variables
+- **Category**: Configuration Management
+
+## Parameters
+
+This command does not accept any parameters.
+
+## Response Format
+
+### Success Response
+
+```json
+{
+  "result": {
+    "success": true,
+    "message": "Settings reloaded successfully from configuration files and environment variables",
+    "custom_settings": {
+      "application": {
+        "name": "Extended MCP Proxy Server with Custom Settings",
+        "version": "2.1.0",
+        "environment": "development"
+      },
+      "features": {
+        "advanced_hooks": true,
+        "custom_commands": true,
+        "data_transformation": true
+      },
+      "security": {
+        "enable_authentication": false,
+        "max_request_size": "15MB"
+      }
+    }
+  }
+}
+```
+
+### Error Response
+
+```json
+{
+  "result": {
+    "success": false,
+    "message": "Failed to reload settings",
+    "custom_settings": {},
+    "error_message": "Failed to reload settings: Configuration file not found"
+  }
+}
+```
+
+## Usage Examples
+
+### Basic Usage
+
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "command": "reload_settings",
+    "params": {}
+  }'
+```
+
+### Python Example
+
+```python
+import requests
+
+response = requests.post(
+    "http://localhost:8000/cmd",
+    json={
+        "command": "reload_settings",
+        "params": {}
+    }
+)
+
+result = response.json()
+if result["result"]["success"]:
+    print("✅ Settings reloaded successfully")
+    print(f"📋 Custom settings: {result['result']['custom_settings']}")
+else:
+    print(f"❌ Failed to reload settings: {result['result']['error_message']}")
+```
+
+## What Gets Reloaded
+
+When you execute the `reload_settings` command, the following happens:
+
+1. **Configuration Files**: Reloads settings from `config.json` and other configuration files
+2. **Environment Variables**: Reloads settings from environment variables with `SERVICE_` prefix
+3. **Custom Settings**: Updates custom settings that were added via `add_custom_settings()`
+4. **Framework Settings**: Updates server, logging, and commands settings
+
+## Integration with Custom Settings
+
+The command works seamlessly with the custom settings system:
+
+```python
+from mcp_proxy_adapter.core.settings import add_custom_settings, reload_settings
+
+# Add custom settings
+add_custom_settings({
+    "application": {
+        "name": "My Custom App",
+        "version": "1.0.0"
+    }
+})
+
+# Reload all settings (including custom ones)
+reload_settings()
+```
+
+## Error Handling
+
+The command provides comprehensive error handling:
+
+- **File Not Found**: Gracefully handles missing configuration files
+- **Invalid JSON**: Reports JSON parsing errors
+- **Permission Errors**: Handles file access permission issues
+- **Environment Variables**: Safely handles missing or invalid environment variables
+
+## Best Practices
+
+1. **Use After Configuration Changes**: Call this command after modifying configuration files
+2. **Monitor Response**: Always check the `success` field in the response
+3. **Handle Errors**: Implement proper error handling for failed reloads
+4. **Validate Settings**: Use the returned custom settings to verify the reload was successful
+5. **Log Operations**: Log reload operations for debugging and monitoring
+
+## Related Commands
+
+- **`settings`**: Get, set, and manage individual settings
+- **`config`**: Access framework configuration
+- **`reload`**: Reload commands and configuration (more comprehensive)
+
+## Use Cases
+
+### Development Environment
+
+```bash
+# After modifying config.json
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{"command": "reload_settings", "params": {}}'
+```
+
+### Production Environment
+
+```bash
+# After updating environment variables
+export SERVICE_SERVER_PORT=8080
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{"command": "reload_settings", "params": {}}'
+```
+
+### Custom Settings Management
+
+```python
+# After adding custom settings programmatically
+from mcp_proxy_adapter.core.settings import add_custom_settings
+
+add_custom_settings({"feature_enabled": True})
+
+# Reload to ensure all settings are up to date
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{"command": "reload_settings", "params": {}}'
+``` 

mcp_proxy_adapter-4.0.0/docs/EN/commands/settings_command.md

@@ -0,0 +1,298 @@
+# Settings Command
+
+The `settings` command provides comprehensive configuration management capabilities for the MCP Proxy Adapter framework.
+
+## Description
+
+The settings command allows you to:
+- View all configuration settings
+- Get specific configuration values
+- Set configuration values dynamically
+- Reload configuration from files
+
+## Command Information
+
+- **Name**: `settings`
+- **Description**: Manage framework settings and configuration
+- **Category**: Configuration Management
+
+## Parameters
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `operation` | string | Yes | `"get_all"` | Operation to perform: `get`, `set`, `get_all`, `reload` |
+| `key` | string | No | - | Configuration key in dot notation (e.g., `server.host`, `custom.feature_enabled`) |
+| `value` | any | No | - | Configuration value to set (for `set` operation) |
+
+### Operations
+
+#### `get_all`
+Retrieves all configuration settings.
+
+**Parameters**: None required
+
+**Example**:
+```json
+{
+  "command": "settings",
+  "params": {
+    "operation": "get_all"
+  }
+}
+```
+
+#### `get`
+Retrieves a specific configuration value.
+
+**Parameters**:
+- `key` (required): Configuration key in dot notation
+
+**Example**:
+```json
+{
+  "command": "settings",
+  "params": {
+    "operation": "get",
+    "key": "server.host"
+  }
+}
+```
+
+#### `set`
+Sets a configuration value dynamically.
+
+**Parameters**:
+- `key` (required): Configuration key in dot notation
+- `value` (required): Value to set
+
+**Example**:
+```json
+{
+  "command": "settings",
+  "params": {
+    "operation": "set",
+    "key": "custom.feature_enabled",
+    "value": true
+  }
+}
+```
+
+#### `reload`
+Reloads configuration from files and environment variables.
+
+**Parameters**: None required
+
+**Example**:
+```json
+{
+  "command": "settings",
+  "params": {
+    "operation": "reload"
+  }
+}
+```
+
+## Response Format
+
+### Success Response
+
+```json
+{
+  "result": {
+    "success": true,
+    "operation": "get_all",
+    "all_settings": {
+      "server": {
+        "host": "127.0.0.1",
+        "port": 8000,
+        "debug": true,
+        "log_level": "DEBUG"
+      },
+      "logging": {
+        "level": "DEBUG",
+        "log_dir": "./logs",
+        "log_file": "app.log"
+      },
+      "commands": {
+        "auto_discovery": true,
+        "discovery_path": "mcp_proxy_adapter.commands"
+      },
+      "custom": {
+        "feature_enabled": true
+      }
+    }
+  }
+}
+```
+
+### Get Operation Response
+
+```json
+{
+  "result": {
+    "success": true,
+    "operation": "get",
+    "key": "server.host",
+    "value": "127.0.0.1"
+  }
+}
+```
+
+### Set Operation Response
+
+```json
+{
+  "result": {
+    "success": true,
+    "operation": "set",
+    "key": "custom.feature_enabled",
+    "value": true
+  }
+}
+```
+
+### Error Response
+
+```json
+{
+  "result": {
+    "success": false,
+    "operation": "get",
+    "error_message": "Key is required for 'get' operation"
+  }
+}
+```
+
+## Usage Examples
+
+### Get All Settings
+
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "command": "settings",
+    "params": {
+      "operation": "get_all"
+    }
+  }'
+```
+
+### Get Server Host
+
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "command": "settings",
+    "params": {
+      "operation": "get",
+      "key": "server.host"
+    }
+  }'
+```
+
+### Get Custom Setting
+
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "command": "settings",
+    "params": {
+      "operation": "get",
+      "key": "custom.features.hooks_enabled"
+    }
+  }'
+```
+
+### Set Custom Setting
+
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "command": "settings",
+    "params": {
+      "operation": "set",
+      "key": "custom.debug_mode",
+      "value": true
+    }
+  }'
+```
+
+### Reload Configuration
+
+```bash
+curl -X POST http://localhost:8000/cmd \
+  -H "Content-Type: application/json" \
+  -d '{
+    "command": "settings",
+    "params": {
+      "operation": "reload"
+    }
+  }'
+```
+
+## Configuration Keys
+
+### Server Settings
+
+- `server.host` - Server host address
+- `server.port` - Server port number
+- `server.debug` - Debug mode flag
+- `server.log_level` - Server log level
+
+### Logging Settings
+
+- `logging.level` - Logging level
+- `logging.log_dir` - Log directory path
+- `logging.log_file` - Main log file name
+- `logging.error_log_file` - Error log file name
+- `logging.access_log_file` - Access log file name
+- `logging.max_file_size` - Maximum log file size
+- `logging.backup_count` - Number of backup files
+- `logging.format` - Log message format
+- `logging.date_format` - Date format
+- `logging.console_output` - Console output flag
+- `logging.file_output` - File output flag
+
+### Commands Settings
+
+- `commands.auto_discovery` - Auto discovery flag
+- `commands.discovery_path` - Command discovery path
+- `commands.custom_commands_path` - Custom commands path
+
+### Custom Settings
+
+Any settings under the `custom` section can be accessed using dot notation:
+
+- `custom.feature_enabled`
+- `custom.api_version`
+- `custom.features.hooks_enabled`
+- `custom.nested.setting`
+
+## Error Handling
+
+The command provides comprehensive error handling:
+
+- **Missing Key**: Returns error when key is required but not provided
+- **Invalid Operation**: Returns error for unsupported operations
+- **Configuration Errors**: Handles configuration loading errors gracefully
+
+## Integration
+
+The settings command integrates with:
+
+- **Configuration System**: Uses the framework's configuration management
+- **Logging System**: Respects logging configuration
+- **Command Registry**: Available through the command registry
+- **API Endpoints**: Accessible via `/cmd` and `/api/commands` endpoints
+
+## Best Practices
+
+1. **Use Dot Notation**: Access nested settings using dot notation (e.g., `custom.features.enabled`)
+2. **Provide Defaults**: Always handle cases where settings might not exist
+3. **Validate Values**: Validate configuration values before using them
+4. **Reload Carefully**: Use reload operation carefully as it overwrites dynamic changes
+5. **Error Handling**: Always check the `success` field in responses