Mysql Query MCP Server

🚀 MySQL Query MCP Server

The MySQL Query MCP Server is a project that adheres to the MCP protocol, aiming to enable interaction between AI assistants and MySQL databases. This tool supports executing read - only SQL queries, retrieving database information, and listing configured environments.

🚀 Quick Start

The MySQL Query MCP Server allows AI assistants to interact with MySQL databases. It supports read - only SQL queries, getting database information, and listing configured environments.

✨ Features

• Adheres to the MCP protocol.
• Enables interaction between AI assistants and MySQL databases.
• Supports read - only SQL queries, database information retrieval, and environment listing.

📦 Installation

Quick Installation

1. Clone the repository:

git clone git@github.com:devakone/mysql-query-mcp-server.git
cd mysql-query-mcp-server

2. Install dependencies:

npm install

3. Start the server:

node index.js

Detailed Installation Steps

Prerequisites

• Node.js (version 16.x or higher)
• npm (version 5.x or higher)

Install Dependencies

Run the following command to install all the dependencies required for the project:

npm install

Start the Server

Start the MySQL Query MCP Server:

node index.js

📚 Documentation

Configuration Guide

Create a Configuration File

Create a config.json file in the project root directory and add the following content:

{
  "environments": {
    "local": {
      "host": "localhost",
      "port": 3306,
      "user": "root",
      "password": "password"
    },
    "development": {
      "host": "127.0.0.1",
      "port": 3306,
      "user": "dev",
      "password": "devpass"
    },
    "staging": {
      "host": "mysql-staging.example.com",
      "port": 3306,
      "user": "staging",
      "password": "stagepass"
    },
    "production": {
      "host": "mysql-production.example.com",
      "port": 3306,
      "user": "prod",
      "password": "prodpass"
    }
  }
}

Configuration Options

• environments: Defines different database environments.
• Each environment contains the following attributes:
  • host: The database host address.
  • port: The database port.
  • user: The username for the connection.
  • password: The user password.

Usage Guide

Environment Variables

Create a .env file in the project root directory and add the following content:

DEBUG=true

Setting it to true enables the debug mode and outputs more log information.

Command - Line Tools

Tool Overview

The MySQL Query MCP Server provides three main command - line tools:

1. query

Execute read - only SQL queries:

-- Example query: Run the following query using the query tool
SELECT * FROM customers WHERE signup_date > '2023-01-01' LIMIT 10;

Supported query types (strictly limited):

• SELECT statements
• SHOW commands
• DESCRIBE/DESC tables

2. info

Get detailed database information:

• Server version
• Connection status
• Database variables
• Process list
• Available databases

3. environments

List all the configured environments:

Use the environments tool to show which database environments are available.

Security Considerations

• ✅ Only read - only queries (SELECT, SHOW, DESCRIBE) are allowed.
• ✅ Each environment has its own isolated connection pool.
• ✅ Supports SSL connections in the production environment.
• ✅ Query timeouts are in place to prevent long - running operations.
• ⚠️ Consider using a dedicated network and authentication to protect the database.

Project Contribution

Contributions are welcome! If you have any questions or suggestions, please submit them in Issues.

Development Guide

How to Run Tests

1. Install dependencies:

npm install

2. Run tests:

npm test

How to Add New Features

1. Define a new environment in config.json.
2. Modify the code to support new database types or features.

📄 License

This project is licensed under the MIT License.