Mysqlreader

🚀 MySQLReader Usage Guide

MySQLReader is a Python-based MCP service designed to read data from MySQL databases. This tool supports multiple authentication methods (environment variables, files, encrypted files) for database connections. It also provides a script named RSA_key_generator.py to encrypt sensitive information.

🚀 Quick Start

📦 Installation

1. Create a virtual environment and install dependencies:

   python -m venv .venv && source .venv/bin/activate  # For Linux/Mac
   uv init && uv sync  # Use UV to manage Python environment
   

💻 Usage Examples

Basic Parameter Explanation

• --directory: Specify the running directory for mounting configuration files and dependencies.
• run: Execute commands.

Authentication Methods

1. Environment Variable Authentication (Default)

Provide database credentials directly in the environment:

mysql_reader --db-host your_database_host --db-name your_database_name

2. File Authentication

Read credentials from a configuration file:

mysql_reader --db-host your_database_host --db-name your_database_name --auth-method file --file-path your_config_file.json

3. Encrypted File Authentication

Decrypt using an encrypted credential file and a private key:

mysql_reader --db-host your_database_host --db-name your_database_name --auth-method efile --file-path your_encrypted_file.enc --private-key private_key.pem

RSA Key Generation Script

Function Overview

Generate an RSA key pair and encrypt sensitive information.

Parameter Explanation

• username: The username to be encrypted.
• password: The password to be encrypted.
• --use-new-key: A boolean value to control whether to use a new key, default is true.
• --public_key_file_name: The file name of the public key, default is public_key.pem.
• --private_key_file_name: The file name of the private key, default is private_key.pem.
• --encrypted_file_name: The file name of the encryption result, default is config.enc.

Example Operations

1. Generate a new key pair:

   python RSA_key_generator.py your_username your_password ^
       --public_key_file_name your_public_key_file_name ^
       --private_key_file_name your_private_key_file_name ^
       --encrypted_file_name your_encrypted_file_name
   

   Output: your_public_key_file_name.pem, your_private_key_file_name.pem, and your_encrypted_file_name.enc.

2. Encrypt using an existing key pair:

   python RSA_key_generator.py your_username your_password ^
       --use-new-key false ^
       --public_key_file_name your_public_key_file_name ^
       --encrypted_file_name your_encrypted_file_name
   

   Output: your_encrypted_file_name.enc.

⚠️ Important Note

• Ensure the security of the private key file to avoid leakage.
• It is recommended to use encrypted authentication methods in a production environment to enhance security.