Mysql Server 5ac

🚀 MySQL Template Boilerplate Project README (English Version)

This project is a MySQL template boilerplate project, which provides a structured and modularized framework for MySQL - related operations. It simplifies the development process by offering pre - configured components and clear architecture design.

📚 Table of Contents

• Execution Steps
• Directory Structure
• Architectural Design
• Scalability and Maintenance
• Deployment and Execution
• Security Considerations

🚀 Execution Steps

Local Execution

# Configure the environment
cp .env.example .env

# Modify the .env file to meet your requirements

# Install dependencies
pip install -r requirements.txt

# Start the server
python mysql_mcp_server/main.py run

📁 Directory Structure

The following is the project's directory structure:

MCPBoilerPlate/
├── mysql_mcp_server/           # Main application directory
│   ├── executors/              # Database operation executors
│   │   ├── create_table.py     # Tool for creating tables
│   │   ├── desc_table.py       # Tool for viewing table structures
│   │   ├── explain.py          # Tool for providing query execution plans
│   │   ├── insert_query.py     # Tool for executing INSERT queries
│   │   ├── insight_starter.py  # Architecture verification tool for writing reports
│   │   ├── invoke_viz_pro.py   # Visualization chart recommendation tool
│   │   ├── select_query.py     # Tool for executing SELECT queries
│   │   └── show_tables.py      # Tool for getting the table list
│   ├── helper/                 # Utility module
│   │   ├── db_conn_helper.py   # Manages database connections
│   │   ├── logger_helper.py    # Logging utility
│   │   └── tool_decorator.py   # Tool decorator
│   └── main.py                 # Application entry point
├── docker-compose.yml          # Docker Compose configuration
├── Dockerfile                  # Docker image build settings
├── requirements.txt            # List of dependency packages
└── .env.example                # Example environment variable file

🏗️ Architectural Design

Layered Structure

1. Interface Layer: MCP Server (FastMCP)
2. Business Logic Layer: Processors and executors
3. Data Access Layer: Database connections and query execution

Key Classes and Modules

• MySQLMCPServer: The main server class responsible for initializing and running the MCP server
• DatabaseManager: A singleton - pattern database connection manager
• Executors: A collection of database operation tools
  • execute_create_table: Create a table
  • execute_desc_table: Check the table structure
  • execute_explain: Provide a query execution plan
  • execute_insert_query: Execute an INSERT query
  • execute_select_query: Execute a SELECT query
  • execute_show_tables: Get the table list

Communication Flow

1. The AI model requests a list of available tools from the MCP server.
2. The server returns the list of available tools.
3. The AI model requests to execute a specific tool.
4. The server calls the corresponding executor for database operations.
5. The execution result is returned to the AI model.

🔧 Scalability and Maintenance

Adding Tools

Implement new tools in the executors directory and register them in __init__.py.

Environment Variable Management

Use environment variables to manage credentials and configurations, ensuring that sensitive information is not hard - coded.

🚢 Deployment and Execution

Running with Docker

# Build the image
docker build -t mysql-mcp .

# Start the container
docker run --name mysql-mcp-container -p 5000:5000 mysql-mcp

🔒 Security Considerations

• Credential Management: Store database credentials using environment variables or a secret management system.
• Strong Password Policy: Configure a secure password policy to avoid weak passwords.
• Network Access Control: Limit access to the database ports and only allow necessary IP addresses to connect.
• SSL/TLS Encryption: Enable SSL/TLS encryption to ensure secure data transmission.

By following these best practices, the security of the system can be significantly improved.