MCP MySQL Server Implementation

A MySQL database MCP server based on NodeJS, allowing LLMs to inspect database schemas and execute SQL queries, supporting multi - database mode and fine - grained permission control.

Database Developer tools #MySQL Connection #Database Query #Permission Management #Multi - Database .TypeScript

rating : 2 points

downloads : 20

update time : 2025-04-29

What is the MySQL MCP Server?

The MySQL MCP Server is a tool that allows Large Language Models (LLMs) to access and operate MySQL databases. It provides functions such as database schema viewing, SQL query execution, and data writing (e.g., insert, update, delete).

How to use the MySQL MCP Server?

By configuring environment variables and running commands, you can quickly set up the server and connect it to your database. It supports integration with various development tools and platforms, such as Cursor, Claude Desktop, and Smithery.

Applicable Scenarios

Suitable for developers, data scientists, and enterprise users who need to let AI directly interact with MySQL databases. It supports complex queries, multi - database management, and fine - grained permission control.

Main Features

SQL Query ExecutionSupports complex SQL queries and returns result sets.

Database Schema ViewingAutomatically generates table structures and column information for easy understanding of the database architecture.

Data Writing SupportAllows execution of INSERT, UPDATE, and DELETE operations. Permissions need to be manually enabled.

Multi - Database SupportAllows connection to multiple databases without specifying a specific database.

Advantages and Limitations

Advantages

Simplify the interaction process between AI and the database

Support multiple query security protection mechanisms

Be compatible with mainstream development tools and platforms

Limitations

Have a certain impact on database performance

Require appropriate MySQL permission configuration

How to Use

Install Dependencies

Ensure that Node.js v18 or a higher version is installed.

Configure Environment Variables

Set MySQL connection information, such as host, port, username, and password.

Start the Server

Run the server to connect to the database.

Usage Examples

Example 1: Execute a QueryQuery all records in the user table.

Example 2: Insert a New RecordInsert a new order into the order table.

Frequently Asked Questions

How to enable write operation permissions?

How to solve the problem of connection failure?

How to monitor query performance?

Related Resources

Official Documentation

Comprehensively understand the server functions and configuration methods.

GitHub Repository

Source code address and contribution guidelines.

Tutorial Video

Quick - start video tutorial.

Installation

Copy the following command to your Client for configuration

{
  "mcpServers": {
    "MySQL": {
      "command": "npx",
      "args": [
        "mcprunner",
        "MYSQL_HOST=127.0.0.1",
        "MYSQL_PORT=3306",
        "MYSQL_USER=root",
        "MYSQL_PASS=root",
        "MYSQL_DB=demostore",
        "ALLOW_INSERT_OPERATION=true",
        "ALLOW_UPDATE_OPERATION=true",
        "ALLOW_DELETE_OPERATION=false",
        "--",
        "npx",
        "-y",
        "@benborla29/mcp-server-mysql"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp_server_mysql": {
      "command": "/path/to/npx/binary/npx",
      "args": [
        "-y",
        "@benborla29/mcp-server-mysql"
      ],
      "env": {
        // Basic connection settings
        "MYSQL_HOST": "127.0.0.1",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "root",
        "MYSQL_PASS": "",
        "MYSQL_DB": "db_name",
        "PATH": "/path/to/node/bin:/usr/bin:/bin",
        
        // Performance settings
        "MYSQL_POOL_SIZE": "10",
        "MYSQL_QUERY_TIMEOUT": "30000",
        "MYSQL_CACHE_TTL": "60000",
        
        // Security settings
        "MYSQL_RATE_LIMIT": "100",
        "MYSQL_MAX_QUERY_COMPLEXITY": "1000",
        "MYSQL_SSL": "true",
        
        // Monitoring settings
        "MYSQL_ENABLE_LOGGING": "true",
        "MYSQL_LOG_LEVEL": "info",
        "MYSQL_METRICS_ENABLED": "true",
        
        // Write operation flags
        "ALLOW_INSERT_OPERATION": "false",
        "ALLOW_UPDATE_OPERATION": "false",
        "ALLOW_DELETE_OPERATION": "false"
      }
    }
  }
}

{
       "mcpServers": {
         "mcp_server_mysql": {
           "command": "/full/path/to/node",
           "args": [
             "/full/path/to/mcp-server-mysql/dist/index.js"
           ],
           "env": {
             "MYSQL_HOST": "127.0.0.1",
             "MYSQL_PORT": "3306",
             "MYSQL_USER": "root",
             "MYSQL_PASS": "your_password",
             "MYSQL_DB": "your_database"
           }
         }
       }
     }

Note: Your key is sensitive information, do not share it with anyone.

🚀 MCP Server MySQL

This project provides a MySQL-based MCP server solution, facilitating database operations and server deployment.

🚀 Quick Start

The following steps guide you through the installation, configuration, and running of the MCP Server MySQL.

📦 Installation

Windows Installation Guide

Download Node.js
Visit the Node.js official website to download and install Node.js. Make sure to choose the LTS version for better compatibility and stability.
Verify the Installation
Open the Command Prompt and enter the following commands to check if the installation was successful:
```
node -v  # Check the Node.js version
npm -v    # Check the npm version
```
Install pnpm Globally
Use npm to install pnpm:
```
npm install -g pnpm
```
Clone the Repository
Open the Command Prompt and run the following command to clone the MCP Server MySQL repository:
```
git clone https://github.com/benborla/mcp-server-mysql.git
cd mcp-server-mysql
```
Install Dependencies
In the repository directory, run the following command to install all dependencies:
```
pnpm install
```
Build the Project
After the installation is complete, run the following command to build the project:
```
pnpm run build
```
Start the MCP Server
After the build is complete, run the following command to start the MCP Server:
```
pnpm start
```

macOS Installation Guide

Download Node.js
Visit the Node.js official website to download and install Node.js. Make sure to choose the LTS version for better compatibility and stability.
Verify the Installation
Open the Terminal and enter the following commands to check if the installation was successful:
```
node -v  # Check the Node.js version
npm -v    # Check the npm version
```
Install pnpm Globally
Use npm to install pnpm:
```
npm install -g pnpm
```
Clone the Repository
Open the Terminal and run the following command to clone the MCP Server MySQL repository:
```
git clone https://github.com/benborla/mcp-server-mysql.git
cd mcp-server-mysql
```
Install Dependencies
In the repository directory, run the following command to install all dependencies:
```
pnpm install
```
Build the Project
After the installation is complete, run the following command to build the project:
```
pnpm run build
```
Start the MCP Server
After the build is complete, run the following command to start the MCP Server:
```
pnpm start
```

📚 Documentation

Configuration Guide

Install Dependencies

In the repository directory, run the following command to install all dependencies:

pnpm install

Run the MCP Server

To run the MCP Server, ensure that the project has been built. Then, run the following command in the Terminal or Command Prompt:

pnpm start

Configuration Parameters

The MCP Server MySQL supports the following configuration parameters:

port: Specify the port on which the server listens (default value is 3000).
host: Specify the host address to which the server binds (default value is localhost).

Example:

# Configuration file path
config:
  port: 3001
  host: 127.0.0.1

Frequently Asked Questions

Question: How to solve SSL configuration issues?

Answer:

Ensure that the MySQL server has SSL support enabled.
Check if the SSL certificate and key files are correctly configured.
Specify the ssl property in the connection string.

Example:

# Configuration file path
config:
  ssl: true
  cert: /path/to/cert.pem
  key: /path/to/key.pem

Question: How to solve user permission issues?

Answer:

Ensure that the MySQL user has sufficient permissions.
Check if the user is allowed to connect from the specified IP address.

Example:

# Configuration file path
config:
  user: root
  password: yourpassword
  database: yourdatabase

Contribution Guide

Submit Code

In the repository directory, create a new branch:
```
git checkout -b feature/your-feature-name
```

Commit your changes:

git add .
git commit -m "Your commit message"

Push to the remote repository and initiate a pull request:
```
git push origin feature/your-feature-name
```

Issue Reporting

Submit an Issue

Create a new issue in the GitHub repository.
Provide detailed error logs and context information.

Example:

# Error log path
error.log:
Error: Cannot connect to MySQL server

Welcome Contributions!

We welcome any improvements or fixes. Please refer to the CONTRIBUTING.md file to learn how to contribute to the project.

Thank you for using the MCP Server MySQL! If you have any questions, please feel free to submit feedback.

Featured MCP Services

Markdownify MCP

Markdownify is a multi-functional file conversion service that supports converting multiple formats such as PDFs, images, audio, and web page content into Markdown format.

TypeScript

1.7K

5 points

Duckduckgo MCP Server

Certified

The DuckDuckGo Search MCP Server provides web search and content scraping services for LLMs such as Claude.

The GitLab MCP server is a project based on the Model Context Protocol that provides a comprehensive toolset for interacting with GitLab accounts, including code review, merge request management, CI/CD configuration, and other functions.

A Python-based MCP Server that provides advanced to-do list management and content organization functions through the Notion API, enabling seamless integration between AI models and Notion.

UnityMCP is a Unity editor plugin that implements the Model Context Protocol (MCP), providing seamless integration between Unity and AI assistants, including real - time state monitoring, remote command execution, and log functions.

554

5 points

Figma Context MCP

Framelink Figma MCP Server is a server that provides access to Figma design data for AI programming tools (such as Cursor). By simplifying the Figma API response, it helps AI more accurately achieve one - click conversion from design to code.

Context7 MCP is a service that provides real-time, version-specific documentation and code examples for AI programming assistants. It is directly integrated into prompts through the Model Context Protocol to solve the problem of LLMs using outdated information.

The MiniMax Model Context Protocol (MCP) is an official server that supports interaction with powerful text-to-speech, video/image generation APIs, and is suitable for various client tools such as Claude Desktop and Cursor.

Python

745

4.8 points

Zhiqi Future, Your AI Solution Think Tank

English 简体中文繁體中文にほんご