🔧 MySQL MCP Server

A Model Context Protocol (MCP) server for MySQL database operations. Provides 3 powerful tools for database interaction through any MCP-compatible client.

✨ Features

• 🔍 Execute SQL Queries - Run any SELECT, INSERT, UPDATE, DELETE commands
• 📋 List Tables - Show tables in the configured database
• 🏗️ Describe Tables - Get detailed table structure information
• 🔒 Secure - Environment-based configuration, no hardcoded credentials
• ⚡ Fast - Built with TypeScript and connection pooling

🚀 Quick Start

Installation

# Clone the repository
git clone https://gitee.com/morris131/mysql-mcp-server.git
cd mysql-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

Configuration

The server uses environment variables for database configuration:

DB_HOST=localhost        # MySQL host (default: 127.0.0.1)
DB_USER=root            # MySQL username (default: root)
DB_PASSWORD=            # MySQL password (default: empty)
DB_PORT=3306           # MySQL port (default: 3306)
DB_NAME=your_database  # Database name (required)

## 📖 Usage

### With OpenCode

Add to your MCP configuration:

```json
{
  "mcp": {
    "mysql": {
      "type": "local",
      "command": [
        "node",
        "/path/to/mysql-mcp-server/dist/index.js"
      ],
      "environment": {
        "DB_HOST": "your_mysql_host",
        "DB_PORT": "3306",
        "DB_USER": "your_username",
        "DB_PASSWORD": "your_password",
        "DB_NAME": "your_database"
    }
  }
}

Replace the paths and credentials with your actual values.

With Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "mysql": {
      "command": "node",
      "args": ["path/to/mysql-mcp-server/dist/index.js"],
      "env": {
        "DB_HOST": "localhost",
        "DB_USER": "your_username",
        "DB_PASSWORD": "your_password",
        "DB_PORT": "3306",
        "DB_NAME": "your_database"
    }
  }
}

With Cursor IDE

Add to your MCP configuration:

{
  "mcpServers": {
    "mysql": {
      "command": "node",
      "args": ["path/to/mysql-mcp-server/dist/index.js"],
      "env": {
        "DB_HOST": "localhost",
        "DB_USER": "your_username",
        "DB_PASSWORD": "your_password",
        "DB_PORT": "3306",
        "DB_NAME": "your_database"
    }
  }
}

🛠️ Available Tools

1. execute_sql

Execute any MySQL query on the configured database.

Parameters:

• sql (required): SQL query to execute (SELECT, INSERT, UPDATE, DELETE, etc.) Example:

{
  "sql": "SELECT * FROM users WHERE id = ?"
}

### 2. `list_tables`
List all tables in the configured database.
**Parameters:** None required
**Example:** `{}`

### 3. `describe_table`
Get detailed information about a table's structure.
**Parameters:**
- `table` (required): Table name to describe
**Example:**
```json
{
  "table": "users"
}

## 🔧 Development

```bash
# Install dependencies
npm install

# Development mode (watch for changes)
npm run dev

# Build for production
npm run build

# Start the server
npm start

📦 Project Structure

mysql-mcp-server/
├── src/
│   └── index.ts          # Main MCP server implementation
├── dist/                 # Compiled JavaScript (auto-generated)
├── package.json          # Project dependencies and scripts
├── tsconfig.json         # TypeScript configuration
├── .gitignore           # Git ignore rules
└── README.md            # This file

🔒 Security

• No hardcoded credentials - All database connection details come from environment variables
• Connection pooling - Efficient and secure database connections
• Error handling - Proper error messages without exposing sensitive information

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Repository: https://gitee.com/morris131/mysql-mcp-server.git

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with the Model Context Protocol SDK
• Uses mysql2 for MySQL connectivity
• Inspired by the MCP community

📞 Support

If you encounter any issues or have questions:

1. Check the Issues page
2. Create a new issue if your problem isn't already reported
3. Provide as much detail as possible including error messages and configuration

Made with ❤️ for the MCP community