Mcp Mysql Server

by huangfeng19820712

21 stars
438 downloads
Not rated
GitHub

About

一个提供MySQL数据库操作的模型上下文协议服务器。该服务器使AI模型能够通过标准化接口与MySQL数据库进行交互。支持对数据库的所有操作。

Details

Author
huangfeng19820712
GitHub stars
21
Downloads
438
Categories
Database

- Secure connection handling with automatic cleanup
- Prepared statement support to prevent SQL injection
- Comprehensive error handling and validation
- TypeScript support
- Automatic connection management
- Tools for querying, executing DML, and schema inspection

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Mcp Mysql Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install via Smithery (npx -y @smithery/cli install @fhuang/mcp-mysql-server --client claude) or manually (npx @fhuang/mcp-mysql-server). Configure with a connection string or environment variables (MYSQL_HOST, MYSQL_USER, MYSQL_PASSWORD, MYSQL_DATABASE). Use tools like connect_db, query, execute, list_tables, describe_table, show_statement, and explain.

connect_db

Connect to MySQL database

query

Execute a SELECT query,can not get table structure,use describe_table tool to get table structure

execute

Execute an INSERT, UPDATE, or DELETE query

list_tables

List all tables in the database

describe_table

Get table structure

show_statement

Execute a SHOW statement (e.g., SHOW STATUS, SHOW VARIABLES)

explain

Analyze SQL query performance using EXPLAIN

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "mcp mysql server": {
            "mysql": {
                "command": "npx",
                "args": [
                    "-y",
                    "@fhuang/mcp-mysql-server"
                ],
                "env": {
                    "MYSQL_HOST": "IP",
                    "MYSQL_USER": "USER",
                    "MYSQL_PORT": "PORT",
                    "MYSQL_PASSWORD": "password",
                    "MYSQL_DATABASE": "DATABASE"
                }
            }
        }
    }
}

McpServers

{
    "mysql": {
        "command": "npx",
        "args": [
            "-y",
            "@fhuang/mcp-mysql-server"
        ],
        "env": {
            "MYSQL_HOST": "IP",
            "MYSQL_USER": "USER",
            "MYSQL_PORT": "PORT",
            "MYSQL_PASSWORD": "password",
            "MYSQL_DATABASE": "DATABASE"
        }
    }
}

@fhuang/mcp-mysql-server

English | [中文文档]

---

> For Chinese documentation, please see README.zh-CN.md

---

smithery badge

A Model Context Protocol server that provides MySQL database operations. This server enables AI models to interact with MySQL databases through a standardized interface.

Installation

Installing via Smithery

To install MySQL Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @fhuang/mcp-mysql-server --client claude

Manual Installation

npx @fhuang/mcp-mysql-server

Configuration

The server requires the following environment variables to be set in your MCP settings configuration file:

> recommended use

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@fhuang/mcp-mysql-server", "mysql://user:password@localhost:port/database"],
    }
  }
}
{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@fhuang/mcp-mysql-server"],
      "env": {
        "MYSQL_HOST": "your_host",
        "MYSQL_USER": "your_user",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

Running evals

The evals package loads an mcp client that then runs the index.ts file, so there is no need to rebuild between tests. You can load environment variables by prefixing the npx command. Full documentation can be found here.

OPENAI_API_KEY=your-key  npx mcp-eval src/evals/evals.ts src/index.ts

Available Tools

1. connect_db

Establish connection to MySQL database using provided credentials.
use_mcp_tool({
  server_name: "mysql",
  tool_name: "connect_db",
  arguments: {
    host: "localhost",
    user: "your_user",
    password: "your_password",
    database: "your_database"
  }
});

2. query

Execute SELECT queries with optional prepared statement parameters.
use_mcp_tool({
  server_name: "mysql",
  tool_name: "query",
  arguments: {
    sql: "SELECT  FROM users WHERE id = ?",
    params: [1]
  }
});

3. execute

Execute INSERT, UPDATE, or DELETE queries with optional prepared statement parameters.
use_mcp_tool({
  server_name: "mysql",
  tool_name: "execute",
  arguments: {
    sql: "INSERT INTO users (name, email) VALUES (?, ?)",
    params: ["John Doe", "john@example.com"]
  }
});

4. list_tables

List all tables in the connected database.
use_mcp_tool({
  server_name: "mysql",
  tool_name: "list_tables",
  arguments: {}
});

5. describe_table

Get the structure of a specific table.
use_mcp_tool({
  server_name: "mysql",
  tool_name: "describe_table",
  arguments: {
    table: "users"
  }
});

6. show_statement

执行 SHOW 语句(如 SHOW STATUS, SHOW VARIABLES 等)。
use_mcp_tool({
  server_name: "mysql",
  tool_name: "show_statement",
  arguments: {
    sql: "SHOW VARIABLES"
  }
});

7. explain

Analyze SQL query performance using EXPLAIN. Returns execution plan details including access type, rows examined, and possible optimizations.
use_mcp_tool({
  server_name: "mysql",
  tool_name: "explain",
  arguments: {
    sql: "SELECT  FROM users WHERE id = ?"
  }
});

Features

- Secure connection handling with automatic cleanup
- Prepared statement support for query parameters
- Comprehensive error handling and validation
- TypeScript support
- Automatic connection management

Security

- Uses prepared statements to prevent SQL injection
- Supports secure password handling through environment variables
- Validates queries before execution
- Automatically closes connections when done

Error Handling

The server provides detailed error messages for common issues:
- Connection failures
- Invalid queries
- Missing parameters
- Database errors

Contributing

Contributions are welcome! Please feel free to submit a Pull Request to https://github.com/huangfeng19820712/mcp-mysql-server

License

MIT

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.