Mangooer Mysql MCP Server Sse

🚀 MySQL Query Server

This is a MySQL query server built on the MCP (Model-Controller-Provider) framework, offering the functionality to perform MySQL database operations via SSE (Server-Sent Events).

🚀 Quick Start

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

1. Download and install Python (version 3.6 or higher).
2. Install the necessary dependencies:

pip install -r requirements.txt

3. Configure the database connection information by editing the config.ini file.
4. Start the server:

python server.py

✨ Features

• Built on the FastMCP framework.
• Supports SSE (Server-Sent Events) for real-time data transmission.
• Provides MySQL database query interfaces.
• Comes with a complete logging system.
• Automatically manages transactions (commit/rollback).
• Supports environment variable configuration.
• Incorporates an SQL security check mechanism:
  • Controls risk levels.
  • Protects against SQL injection.
  • Blocks dangerous operations.
  • Enforces WHERE clause checks.
  • Automatically returns the number of rows affected by modification operations.

📦 Installation

1. Download and install Python 3.6 or higher.
2. Install the required dependencies:

pip install -r requirements.txt

3. Edit the config.ini file to configure the database connection.
4. Start the server:

python server.py

📚 Documentation

Environment Variable Configuration

The server is configured through environment variables. Here are the commonly used environment variables and their functions:

SQL Security Mechanism

The server has a built - in powerful SQL security mechanism to ensure the security of data queries:

1. Risk Level Control: The system automatically assesses the risk level of each SQL operation and decides whether to allow execution based on the ALLOWED_RISK_LEVELS environment variable.
2. SQL Injection Protection: Uses an ORM (Object Relational Mapping) framework and parameterized queries to prevent SQL injection attacks.
3. Dangerous Operation Interception: Blocks high - risk operations that may lead to data loss (such as TRUNCATE, DELETE, etc.), which require manual authorization to execute.
4. WHERE Clause Mandatory Check: All queries must contain a valid WHERE clause to ensure clear query targets.

Starting the Server

1. Ensure that the environment variables are correctly set:

export MYSQL_HOST=localhost MYSQL_PORT=3306 MYSQL_USER=root MYSQL_PASSWORD=root MYSQL_DB=testdb

2. Start the server:

python server.py

Project Structure

mysql_query_server/
├── server.py                  # Main program entry
├── config.ini                # Database configuration file
├── requirements.txt          # Dependency management
└── README.md                 # Project documentation

Common Problem Solutions

1. Environment variables not taking effect

• Ensure that the load_dotenv() function call in server.py is placed before importing other modules.
• Restart the application to ensure that the environment variables are correctly loaded.

2. Operations rejected by the security mechanism

• Check if the risk level of the operation exceeds the allowed range.
• If you need to perform high - risk operations, adjust the ALLOWED_RISK_LEVELS configuration.

3. Update or delete operations without a WHERE clause

• Add a valid WHERE clause to reduce the risk of the operation.

Logging System

The server integrates a complete logging system that supports console output and file logging. The log level can be adjusted by modifying the configuration in server.py.

Error Handling

The server has a comprehensive error handling mechanism:

• Checks database connections.
• Validates configurations.
• Performs SQL security checks.
• Captures and records runtime errors.
• Automatically rolls back transactions.

Contribution Guidelines

Welcome to contribute to the project by submitting Issues and Pull Requests.

📄 License

This project is licensed under the MIT License: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Copyright Notice

Copyright (c) 2024 MCP MySQL Query Server

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.