MCP Mysql Server

🚀 @f4ww4z/mcp-mysql-server Project Documentation

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

🚀 Quick Start

This project is a Model Context Protocol (MCP) server for MySQL database operations, allowing AI models to interact with MySQL databases via a standardized interface.

📦 Installation

Install via Smithery

Automatically install MySQL Server for Claude Desktop through Smithery:

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

Manual Installation

npx @f4ww4z/mcp-mysql-server

📚 Documentation

Configuration Guide

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

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@f4ww4z/mcp-mysql-server"],
      "env": {
        "MYSQL_HOST": "your_host",
        "MYSQL_USER": "your_user",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

Available Tools

1. connect_db

Establish a MySQL database connection using the 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 a SELECT query, supporting 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 an INSERT, UPDATE, or DELETE query, supporting 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 database.

use_mcp_tool({
  server_name: "mysql",
  tool_name: "list_tables",
  arguments: {}
});

5. describe_table

Get the structural information of a specific table.

use_mcp_tool({
  server_name: "mysql",
  tool_name: "describe_table",
  // The original code seems incomplete here, keep it as it is
});