Mysql Database Server Nnk

🚀 @enemyrr/mcp-mysql-server

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

📦 Installation

Automatic Installation via Smithery

Automatically install the MySQL database server for Claude Desktop via Smithery:

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

Manual Installation

1. Clone and build the project:

git clone https://github.com/enemyrr/mcp-mysql-server.git
cd mcp-mysql-server
npm install
npm run build

2. Add the server to Cursor IDE settings:
   • Open the command palette (Cmd/Ctrl + Shift + P).
   • Search for "MCP: Add Server".
   • Fill in the following information:
     • Name: mysql
     • Type: command
     • Command: node /absolute/path/to/mcp-mysql-server/build/index.js

⚠️ Important Note

Replace /absolute/path/to/mcp-mysql-server with the actual project path.

Database Configuration

• Using Database URL Environment Variable:

  DATABASE_URL=mysql://username:password@host:port/database_name
  

• Individual Parameter Configuration:

  • Username: via DB_USER or parsed from the URL.
  • Password: via DB_PASS or parsed from the URL.
  • Host: via DB_HOST or parsed from the URL.
  • Port: via DB_PORT or parsed from the URL, default is 3306.
  • Database Name: via DB_NAME or parsed from the URL.

• Direct Connection Tool:

  {
    "driver": "mysql",
    "options": {
      "host": "host_address",
      "port": port_number,
      "database": "database_name",
      "username": "username",
      "password": "password"
    }
  }
  

💻 Usage Examples

Basic Usage

/**
 * @param {string} query SQL query statement
 * @param {any[]} parameters Array of query parameters
 */
async function executeQuery(query, parameters) => Promise<void>

Advanced Usage

/**
 * @param {string} query SQL query statement
 * @param {any[]} parameters Array of query parameters
 */
async function queryResultSet(query, parameters) => Promise<Row[]>

✨ Features

• Support multiple connection methods (URL, workspace, direct).
• Provide secure connection handling and automatic cleanup.
• Support prepared statements to prevent SQL injection.
• Include database table structure management tools.
• Have comprehensive error handling and validation mechanisms.
• Support TypeScript.
• Automatically detect workspaces.

🔒 Security

• Use prepared statements to prevent SQL injection attacks.
• Securely handle passwords through environment variables.
• Validate queries before execution.
• Automatically close connections after execution.

❌ Error Handling

The server provides detailed error information covering the following situations:

• Connection failure.
• Invalid queries or parameters.
• Missing configuration.
• Database errors.
• Schema validation errors.

🤝 Contribution

Contributions from the community are welcome! Please visit the GitHub repository to submit a Pull Request.

📄 License

MIT