Mysql MCP Server Sse

🚀 MySQL Query Server

The MySQL Query Server is an application built on Python and MySQL database. It offers a comprehensive set of tools and services for executing various MySQL queries, including basic queries, metadata retrieval, database information acquisition, and advanced table structure operations.

🚀 Quick Start

To get started with the MySQL Query Server, follow these steps:

1. Clone the project repository to your local machine.
2. Install the dependencies (refer to requirements.txt).
3. Configure the environment variables using .env.example as a template.
4. Start the server.

python src/server.py

The server will run at http://127.0.0.1:3000/sse by default.

✨ Features

• High Performance: Optimized MySQL connection pool and query execution efficiency, supporting high - concurrency access.
• Security: Built - in SQL interceptor and security check mechanism to prevent malicious attacks and unauthorized operations.
• Scalability: Modular design, facilitating the addition of new query types and functional plugins.
• Ease of Use: Clear documentation and a user - friendly interface to simplify database operations.

📦 Installation

1. Clone the project repository:

   git clone <repository_url>
   

2. Install the dependencies:

   pip install -r requirements.txt
   

3. Configure the environment variables using .env.example as a template.
4. Start the server:

   python src/server.py
   

📚 Documentation

Project Structure

.
├── src/                     # Source code directory
│   ├── server.py           # Main server file
│   ├── db/                 # Database - related code
│   │   └── mysql_operations.py # MySQL operation implementation
│   ├── security/           # SQL security - related code
│   │   ├── interceptor.py   # SQL interceptor
│   │   ├── query_limiter.py # SQL security checker
│   │   └── sql_analyzer.py  # SQL analyzer
│   └── tools/              # Utility class code
│       ├── mysql_tool.py           # Basic query tool
│       ├── mysql_metadata_tool.py  # Metadata query tool
│       ├── mysql_info_tool.py      # Database information query tool
│       ├── mysql_schema_tool.py    # Advanced table structure query tool
│       └── metadata_base_tool.py   # Metadata tool base class
├── tests/                  # Test code directory
├── .env.example            # Example environment variable file
└── requirements.txt        # Project dependency file

Configuration Requirements

• Python Version: 3.8 or higher
• MySQL Connector: A supported MySQL connector library
• Environment Variables: Configure database connection information and security parameters.

Security Mechanisms

• Risk Level Control: Limit the allowed operation risk levels through the ALLOWED_RISK_LEVELS environment variable.
• Sensitive Information Protection: Sensitive data is hidden by default in the production environment. You can enable ALLOW_SENSITIVE_INFO in the development environment to display sensitive information.

Common Problem Solutions

DELETE Operation Not Executed Successfully

1. Check if the DELETE statement contains a WHERE clause.
2. Ensure that the risk level of the operation is within the allowed range (adjust the environment variables if you need to perform high - risk operations).
3. Check the number of affected rows to confirm if the operation is effective.

Environment Variables Not Taking Effect

• Ensure that the load_dotenv() call is placed before importing other modules.
• Restart the application to load the new configuration.

Logging System

The system supports multiple log recording formats and levels, facilitating debugging and monitoring. Logs are output to the console and files by default.

🔧 Technical Details

The MySQL Query Server is designed with a modular architecture. The src directory contains the main source code, including the main server file, database operation code, security - related code, and utility classes. The tests directory is used for unit and integration testing. The security mechanisms are implemented through environment variables and SQL interceptors to ensure the security of database operations.

📄 License

This project is licensed under the MIT License. Copyright © [Your Name] or company name. Terms of Use: You are allowed to freely copy, modify, and distribute the code, but you must retain the copyright notice.

For further information, please refer to the project documentation or contact the maintainers.