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

This version

6.7.0

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.7.0.tar.gz (273.3 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.7.0-py3-none-any.whl (345.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mcp_proxy_adapter-6.7.0.tar.gz
Algorithm Hash digest
SHA256 e0227de5c6b23176690ef274f0ecce82ddf79aa34dd5b932b5245cd7ff27d42f
MD5 33e2e68ee2a9d0eb2467eb06800f903b
BLAKE2b-256 d860976348fb74cde02a991d4379ba544caeecb1f651e7f7f0d4f845733254c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_proxy_adapter-6.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f9fb9f8d53755658b8ce18f04934b7aad9cbb975b1ac4676ac3102f220c4bd6
MD5 413f7566ff5fcd970c904b6ba47a65a7
BLAKE2b-256 516312d89237eeb04168a69b3121c98ab33c0a911d627174eaefcef533f004a5

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