Mineru98 Mysql MCP Server

🚀 MySQL-MCP Server

The MySQL-MCP Server is a project designed to manage and interact with MySQL databases. It provides various database operation tools and can be run either through Docker or Python.

🚀 Quick Start

📦 Installation

There are two ways to run this project: using Docker or directly using Python.

Using Docker

# Start the database container
docker-compose up -d db

# Build and start the mysql-mcp-server (including reconstruction)
docker-compose up -d --build mysql-mcp-server

Using Python

# Set the environment variable file
cp .env.example .env

# Install dependencies
pip install -r requirements.txt

# Run the server
python mysql_mcp_server/main.py run

💻 Usage Examples

Basic Usage

You can start the project according to the installation steps above. For example, if you choose to use Docker, you can start the database container and the mysql-mcp-server through the provided Docker commands.

📚 Documentation

Project Structure

MCPBoilerPlate/
├── mysql_mcp_server/           # Main application directory
│   ├── executors/              # Database operation executors
│   │   ├── create_table.py     # Table creation tool
│   │   ├── desc_table.py       # Table structure viewing tool
│   │   ├── explain.py          # Query execution plan tool
│   │   ├── insert_query.py     # INSERT query execution tool
│   │   ├── insight_starter.py  # Architecture verification tool for writing reports
│   │   ├── invoke_viz_pro.py   # Visualization chart recommendation tool
│   │   ├── select_query.py     # SELECT query execution tool
│   │   └── show_tables.py      # Table list retrieval tool
│   ├── helper/                 # Utility module
│   │   ├── db_conn_helper.py   # Database connection management tool
│   │   ├── logger_helper.py    # Log recording tool
│   │   └── tool_decorator.py   # Tool decorator
│   └── main.py                 # Application entry point
├── docker-compose.yml          # Docker Compose configuration file
├── Dockerfile                  # Docker image build settings
├── requirements.txt            # Dependency list
└── .env.example                # Environment variable example file

🔧 Technical Details

Security Precautions

⚠️ Important Note

• Manage database credentials using environment variables.
• Use strong passwords in the production environment.
• Consider implementing SSL/TLS encryption for database connections when necessary.