Skip to main content

Powerful JSON-RPC microservices framework with built-in security, authentication, and proxy registration

Project description

MCP Proxy Adapter

Author: Vasiliy Zdanovskiy
Email: vasilyvz@gmail.com

Overview

MCP Proxy Adapter is a comprehensive framework for building JSON-RPC API servers with built-in security, SSL/TLS support, and proxy registration capabilities. It provides a unified interface for command execution, protocol management, and security enforcement.

Features

  • JSON-RPC API: Full JSON-RPC 2.0 support with built-in commands
  • Security Framework: Integrated authentication, authorization, and SSL/TLS
  • Protocol Management: HTTP, HTTPS, and mTLS protocol support
  • Proxy Registration: Automatic registration with proxy servers
  • Command System: Extensible command registry with built-in commands
  • Configuration Management: Comprehensive configuration with environment variable overrides

Quick Start

  1. Installation:

    pip install mcp-proxy-adapter
    
  2. Basic Configuration:

    # Use the comprehensive config with all options disabled by default
    python -m mcp_proxy_adapter --config config.json
    
  3. Access the API:

    • Health check: GET http://localhost:8000/health
    • JSON-RPC: POST http://localhost:8000/api/jsonrpc
    • REST API: POST http://localhost:8000/cmd
    • Documentation: http://localhost:8000/docs

Configuration

The adapter uses a comprehensive JSON configuration file (config.json) that includes all available options with sensible defaults. All features are disabled by default and can be enabled as needed:

  • Server settings: Host, port, debug mode
  • Security: Authentication methods, SSL/TLS, permissions
  • Protocols: HTTP/HTTPS/mTLS configuration
  • Proxy registration: Automatic server registration
  • Logging: Comprehensive logging configuration
  • Commands: Built-in and custom command management

See docs/EN/configuration.md for complete configuration documentation.

Built-in Commands

  • health - Server health check
  • echo - Echo test command
  • config - Configuration management
  • help - Command help and documentation
  • reload - Configuration reload
  • settings - Settings management
  • load/unload - Command loading/unloading
  • plugins - Plugin management
  • proxy_registration - Proxy registration control
  • transport_management - Transport protocol management
  • role_test - Role-based access testing

Security Features

  • Authentication: API keys, JWT tokens, certificate-based auth
  • Authorization: Role-based permissions with wildcard support
  • SSL/TLS: Full SSL/TLS and mTLS support
  • Rate Limiting: Configurable request rate limiting
  • Security Headers: Automatic security header injection

Examples

The mcp_proxy_adapter/examples/ directory contains comprehensive examples for different use cases:

  • Basic Framework: Simple HTTP server setup
  • Full Application: Complete application with custom commands and hooks
  • Security Testing: Comprehensive security test suite
  • Certificate Generation: SSL/TLS certificate management

Test Environment Setup

The framework includes a comprehensive test environment setup that automatically creates configurations, generates certificates, and runs tests:

# Create a complete test environment with all configurations and certificates
python -m mcp_proxy_adapter.examples.setup_test_environment

# Create test environment in a specific directory
python -m mcp_proxy_adapter.examples.setup_test_environment /path/to/test/dir

# Skip certificate generation (use existing certificates)
python -m mcp_proxy_adapter.examples.setup_test_environment --skip-certs

# Skip running tests (setup only)
python -m mcp_proxy_adapter.examples.setup_test_environment --skip-tests

Configuration Generation

Generate test configurations from a comprehensive template:

# Generate all test configurations
python -m mcp_proxy_adapter.examples.create_test_configs

# Generate from specific comprehensive config
python -m mcp_proxy_adapter.examples.create_test_configs --comprehensive-config config.json

# Generate specific configuration types
python -m mcp_proxy_adapter.examples.create_test_configs --types http,https,mtls

Certificate Generation

Generate SSL/TLS certificates for testing:

# Generate all certificates using mcp_security_framework
python -m mcp_proxy_adapter.examples.generate_all_certificates

# Generate certificates with custom configuration
python -m mcp_proxy_adapter.examples.generate_certificates_framework --config cert_config.json

Security Testing

Run comprehensive security tests:

# Run all security tests
python -m mcp_proxy_adapter.examples.run_security_tests_fixed

# Run full test suite (includes setup, config generation, certificate generation, and testing)
python -m mcp_proxy_adapter.examples.run_full_test_suite

Complete Workflow Example

# 1. Install the package
pip install mcp-proxy-adapter

# 2. Create test environment (automatically runs tests)
python -m mcp_proxy_adapter.examples.setup_test_environment

# 3. Or run individual steps:
# Generate certificates
python -m mcp_proxy_adapter.examples.generate_all_certificates

# Generate configurations
python -m mcp_proxy_adapter.examples.create_test_configs

# Run security tests
python -m mcp_proxy_adapter.examples.run_security_tests_fixed

# 4. Start server with generated configuration
python -m mcp_proxy_adapter --config configs/http_simple.json

Development

The project follows a modular architecture:

  • mcp_proxy_adapter/api/ - FastAPI application and handlers
  • mcp_proxy_adapter/commands/ - Command system and built-in commands
  • mcp_proxy_adapter/core/ - Core functionality and utilities
  • mcp_proxy_adapter/config.py - Configuration management

License

This project is licensed under the MIT License.

Support

For issues and questions, please contact vasilyvz@gmail.com.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_proxy_adapter-6.4.46.tar.gz (259.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_proxy_adapter-6.4.46-py3-none-any.whl (336.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_proxy_adapter-6.4.46.tar.gz.

File metadata

  • Download URL: mcp_proxy_adapter-6.4.46.tar.gz
  • Upload date:
  • Size: 259.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for mcp_proxy_adapter-6.4.46.tar.gz
Algorithm Hash digest
SHA256 26384c1e8ae6ddce07b5cd233ecff979b244cd0e1d38203ec25b387875aaf152
MD5 8c068a616147d9ad01bfe6424fd01770
BLAKE2b-256 b0ce7806d6281b212e1b17bb2c6dd6b20c0409f693ca213177195ef071804d7f

See more details on using hashes here.

File details

Details for the file mcp_proxy_adapter-6.4.46-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_proxy_adapter-6.4.46-py3-none-any.whl
Algorithm Hash digest
SHA256 cd55b1fd05f79401211509c80adb2cc94de1b22902b6d103444513cfef8cea71
MD5 eacf4dadbccc996aad97bfb32c811166
BLAKE2b-256 fa651d51d0c09e656da3cce0179ac617a3ba17932b0319618702fcd73d25b50a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page