polardb-mysql-mcp-server 0.4.0

mcp server for polardb mysql

PolarDB MySQL MCP Server

PolarDB MySQL MCP Server serves as a universal interface between AI Agents and PolarDB MySQL databases. It enables seamless communication between AI Agents and PolarDB MySQL, helping AI Agents retrieve PolarDB MySQL database metadata and execute SQL operations.

Environment Variables

The following environment variables are required to connect to PolarDB MySQL database,environment Variables can be set in .env file or set in command line

• POLARDB_MYSQL_HOST: Database host address
• POLARDB_MYSQL_PORT: Database port
• POLARDB_MYSQL_USER: Database user
• POLARDB_MYSQL_PASSWORD: Database password
• POLARDB_MYSQL_DATABASE: Database name
• POLARDB_MYSQL_ENABLE_UPDATE: Enable update operation(default:false)
• POLARDB_MYSQL_ENABLE_WRITE: Enable write operation(default:false)
• POLARDB_MYSQL_ENABLE_INSER: Enable insert operation(default:false)
• POLARDB_MYSQL_ENABLE_DDL: Enable ddl operation(default:false)
• SSE_BIND_HOST: The host address to bind for SSE mode
• SSE_BIND_PORT: The port to bind for SSE mode
• RUN_MODE: The run mode(sse|stdio),(default:sse)

Components

Tools

• execute_sql: execute sql

Resources

• polardb-mysql://tables: List all tables for PolarDB MySQL in the current database
• polardb-mysql://{table}/field: get the name,type and comment of the field in the table
• polardb-mysql://{table}/data: get data from the table,default limit 50 rows

Usage

Cursor

1. config for mcp.json

{
  "mcpServers": {
    "polardb-mysql-mcp-server": {
      "command": "uvx",
      "args": [
        "--from",
        "polardb-mysql-mcp-server",
        "run_polardb_mysql_mcp_server"
      ],
      "env": {
        "POLARDB_MYSQL_HOST": "127.0.0.1",
        "POLARDB_MYSQL_PORT": "15001",
        "POLARDB_MYSQL_USER": "xxxx",
        "POLARDB_MYSQL_PASSWORD": "xxx",
        "POLARDB_MYSQL_DATABASE": "xxx",
        "RUN_MODE": "stdio",
        "POLARDB_MYSQL_ENABLE_UPDATE": "false",
        "POLARDB_MYSQL_ENABLE_UPDATE": "false",
        "POLARDB_MYSQL_ENABLE_INSER": "false",
        "POLARDB_MYSQL_ENABLE_DDL": "false"
      }
    }
  }
}