Mysql Database Explorer

🚀 MySQL MCP Server Documentation

This is a comprehensive documentation for the MCP (MySQL Connection Pool) server, which is used to connect to and manage MySQL databases. The server supports various functions, including read - only access, connection pool configuration, and advanced testing tools.

🚀 Quick Start

✨ Features

• Connect to and manage MySQL databases.
• Support read - only access.
• Provide connection pool configuration.
• Offer advanced testing tools.

📦 Installation

Install via NPM

You can install it using the following command:

npm install mysql-mcp-server

Build from Source

1. Clone the code repository:

git clone https://github.com/username/mysql-mcp-server.git
cd mysql-mcp-server

2. Install dependencies:

npm install

📚 Documentation

Configure Environment Variables

Set the following environment variables in the config.json file:

{
  "MYSQL_HOST": "localhost",    // MySQL server address
  "MYSQL_PORT": 3306,          // MySQL port
  "MYSQL_USER": "root",        // Username
  "MYSQL_PASSWORD": "password"  // Password
}

MCP Configuration Example

Add the following configuration to the mcp-config.json file:

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["mysql-mcp-server"],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "password",
        "MYSQL_DATABASE": "testDB"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Available Tools

List Databases

{
  "server_name": "mysql",
  "tool_name": "list_databases",
  "arguments": {}
}

List Tables

{
  "server_name": "mysql",
  "tool_name": "list_tables",
  "arguments": {
    "database": "testDB"
  }
}

Describe Table

{
  "server_name": "mysql",
  "tool_name": "describe_table",
  "arguments": {
    "database": "testDB",
    "table": "users"
  }
}

Execute Query

{
  "server_name": "mysql",
  "tool_name": "execute_query",
  "arguments": {
    "database": "testDB",
    "query": "SELECT * FROM users LIMIT 10"
  }
}

Advanced Connection Pool Configuration

Add the following advanced parameters to the config.json file:

{
  "MYSQL_CONNECTION_LIMIT": 10,       // Maximum capacity of the connection pool, default is 10
  "MYSQL_QUEUE_LIMIT": 0,             // Maximum number of the waiting queue, default is 0 (unlimited)
  "MYSQL_CONNECT_TIMEOUT": 10000,      // Connection timeout in milliseconds, default is 10 seconds
  "MYSQL_IDLE_TIMEOUT": 60000,        // Idle connection timeout in milliseconds, default is 60 seconds
  "MYSQL_MAX_IDLE": 10               // Maximum number of idle connections, default is 10
}

Testing Steps

Set Up the Test Database

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password

npm run test:setup

Test MCP Tools

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password
export MYSQL_DATABASE=testDB

npm run test:tools

Run All Tests

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USER=root
export MYSQL_PASSWORD=password

npm test

Troubleshooting

1. Check the server logs for error information.
2. Confirm that the MySQL credentials and connection settings are correct.
3. Ensure that the MySQL user has appropriate permissions.
4. Make sure the query is read - only and in the correct format.

📄 License

This software is licensed under the MIT license. Please refer to the LICENSE file for the specific license content.