Mysql MCP Server Tdc

🚀 MySQL MCP Server

A Model Context Protocol (MCP) server for interacting with MySQL databases. This server allows MCP clients (such as AI assistants) to query and modify data in the configured MySQL database.

🚀 Quick Start

The MySQL MCP Server is designed to facilitate interaction with MySQL databases through the MCP protocol. After proper configuration and installation, it can handle various SQL operations.

✨ Features

• Connect to a MySQL database using standard connection parameters.
• Provide MCP tools to execute SQL queries and statements.
• Support read-only queries (SELECT, SHOW, DESCRIBE).
• Support write operations (INSERT, UPDATE, DELETE) via an environment variable (MYSQL_ALLOW_WRITE_OPS). Set this variable to true to enable these operations, which are disabled by default. Note: Enabling write operations allows MCP clients to modify your database. Use with caution.
• Communicate via standard input/output (stdio).

📦 Installation

# Install as a project dependency (recommended for use in other projects)
npm install

# Or, if you need it as an independent global tool:
# 1. Build the project:
#    npm run build
# 2. Link globally:
#    npm link 
#    (or use `npm install -g .` if it has been published)

📚 Documentation

Configuration

This server requires the following environment variables to be set for database connection:

• MYSQL_HOST: The hostname or IP address of the MySQL server.
• MYSQL_USER: The username used to connect to the database.
• MYSQL_PASSWORD: The password for the specified user.
• MYSQL_DATABASE: The name of the database to connect to.
• MYSQL_PORT: (Optional) The port number of the MySQL server (default is 3306).
• MYSQL_ALLOW_WRITE_OPS: (Optional) Set to true to enable insert, update, and delete tools, default is false (write operations are disabled). Note: Enabling write operations allows MCP clients to modify your database. Use with caution.

These variables need to be available in the environment where the server process runs. How to set them depends on your operating system and the way you run the server (e.g., .env file, system environment variables, shell exports).

Usage

After configuration and building (npm run build), you can run the server:

# If globally linked
mysql-server

# Or run directly with node
node build/index.js 

The server will start and print MySQL MCP Server running on stdio in stderr, then listen for MCP requests on standard input/output. You usually need to configure your MCP client (e.g., AI assistant integration) to connect to this server process.

Available Tools

The server exposes the following tools for MCP clients:

1. query

• Description: Execute read-only SQL queries (SELECT, SHOW, DESCRIBE) against the configured database.
• Input Schema:

{
  "type": "object",
  "properties": {
    "sql": {
      "type": "string",
      "description": "The read-only SQL query (SELECT, SHOW, DESCRIBE) to execute."
    }
  },
  "required": ["sql"]
}

• Output: Return the query results as a JSON string in the content of the MCP response. If the query is not read-only or a database error occurs, an error will be returned.

2. insert

• Description: Execute an INSERT SQL statement. Requires MYSQL_ALLOW_WRITE_OPS to be set to true.
• Input Schema:

{
  "type": "object",
  "properties": {
    "sql": {
      "type": "string",
      "description": "The INSERT SQL statement to execute."
    }
  },
  "required": ["sql"]
}

• Output: Return a message containing the number of inserted records on success, or an error message on failure.

3. update

• Description: Execute an UPDATE SQL statement. Requires MYSQL_ALLOW_WRITE_OPS to be set to true.
• Input Schema:

{
  "type": "object",
  "properties": {
    "sql": {
      "type": "string",
      "description": "The UPDATE SQL statement to execute."
    }
  },
  "required": ["sql"]
}

• Output: Return a message indicating the number of affected rows on success, or an error message on failure.

⚠️ Important Note

Enabling write operations allows MCP clients to modify your database. Please use with caution.