mysql_mcp_server — Claude MCP 必备工具中文教程

Install dependencies

pip install -r requirements.txt

Install development dependencies

pip install -r requirements-dev.txt

Deployment options

• Hosted — Fronteir AI runs the server for you; no local setup required.
• Local — Smithery installs and runs the server on your own machine.

Installation

Manual Installation

pip install mysql-mcp-server

Installing via Smithery

To install MySQL MCP Server for Claude Desktop automatically via Smithery:

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

Installing via Claude Code CLI

claude mcp add --transport stdio designcomputer-mysql_mcp_server uvx mysql_mcp_server

Installing via Autohand Code CLI

autohand mcp add mysql env MYSQL_HOST=localhost MYSQL_PORT=3306 MYSQL_USER=your_username MYSQL_PASSWORD=your_password MYSQL_DATABASE=your_database uvx mysql_mcp_server

Add --scope project after mcp add to keep the registration in the current workspace. See Autohand Code for current CLI details.

Usage

Copy the example config and edit with your credentials

cp .env.example .env

`get_table_sample`

Fetches a representative sample of data. - Arguments: table_name (string), limit (optional integer, max 20) - Use Case: Quickly understand data formats and content without fetching large result sets. - Cross-database: Pass database.table to sample a table outside MYSQL_DATABASE; bare names use the configured database. - Identifier rules: Names must contain only alphanumeric characters, underscores, and $ (dots are allowed as a separator between database and table names).

Configuration

Set the following environment variables: ```bash MYSQL_HOST=localhost # Database host MYSQL_PORT=3306 # Optional: Database port (defaults to 3306 if not specified) MYSQL_USER=your_username MYSQL_PASSWORD=your_password MYSQL_DATABASE=your_database # Optional: Omit for multi-database mode

Advanced Configuration

MYSQL_SSL_MODE=DISABLED # DISABLED, REQUIRED, VERIFY_CA, VERIFY_IDENTITY MYSQL_CONNECT_TIMEOUT=10 # Timeout in seconds

Connection behaviour (Optional)

MYSQL_SQL_MODE=TRADITIONAL # SQL mode applied to the connection (default: TRADITIONAL)

Compatibility (Optional)

MYSQL_CHARSET=utf8mb4 MYSQL_COLLATION=utf8mb4_unicode_ci MYSQL_AUTH_PLUGIN= # e.g., mysql_native_password for older MySQL versions MYSQL_USE_PURE=false # Force the pure-Python connector (default: false) MYSQL_RAISE_ON_WARNINGS=false # Raise on SQL warnings (default: false)

SSE Transport (Optional)

MCP_TRANSPORT=stdio # stdio or sse MCP_SSE_HOST=0.0.0.0 # Listen on all interfaces (required for Docker/hosting) PORT=8000 # HTTP port (fallback for MCP_SSE_PORT) MCP_SSE_ALLOWED_HOSTS= # Comma-separated allowed Host headers (default: localhost:{port},127.0.0.1:{port})

SSH Tunneling (Optional)

MYSQL_SSH_ENABLE=false # Set to true to enable MYSQL_SSH_HOST= # SSH jump host MYSQL_SSH_PORT=22 # SSH port MYSQL_SSH_USER= # SSH username MYSQL_SSH_KEY_PATH= # Path to SSH private key MYSQL_SSH_REMOTE_HOST=localhost # Host from the perspective of the jump host MYSQL_SSH_REMOTE_PORT=3306 MYSQL_LOCAL_PORT=3330 ```

`.env` file loading

On startup the server automatically loads a .env file via python-dotenv, so for local use you can simply:

cp .env.example .env   # then edit with your credentials

The file is read from the process working directory (and parent directories), which works when you run the server yourself from the project folder.

⚠️ Claude Code / Claude Desktop: these hosts launch the server from their own working directory, so the project's .env will not be found and you'll see Missing required database configuration. Put your MYSQL_* values in the env block of the MCP config (shown in the Usage section below) rather than relying on .env.

Create virtual environment

python -m venv venv source venv/bin/activate # or venv\Scripts\activate on Windows

Edit .env with your MySQL connection details