MySQL Database MCP server

This MCP MySQL service allows you to connect to and operate local MySQL databases through a lightweight server. It provides API interfaces that enable tools like Cursor to easily perform database operations without direct database access.

Installation Requirements

• Node.js (v14 or higher)
• MySQL server

Setting Up the Server

Installation Steps

1. Clone the repository to your local machine
2. Install the required dependencies:

   npm install
   

3. Create and configure a .env file in the root directory:

   # Server configuration
   PORT=3000
   NODE_ENV=development
   
   # MySQL database configuration
   DB_HOST=localhost
   DB_PORT=3306
   DB_USER=your_username
   DB_PASSWORD=your_password
   DB_NAME=your_database_name
   
   # API configuration
   API_KEY=your_api_key
   

Starting the Server

To start the server in standard mode:

npm start

For development mode with auto-restart:

npm run dev

Using the API

Database Operations

Get All Databases

GET /api/databases

Get All Tables in a Database

GET /api/databases/:database/tables

Get Table Structure

GET /api/databases/:database/tables/:table/structure

Executing Queries

Run a SQL Query

POST /api/query
Content-Type: application/json

{
  "sql": "SELECT * FROM users WHERE age > ?",
  "params": [18],
  "limit": 10,
  "offset": 0
}

Server-Sent Events (SSE)

To establish an SSE connection:

GET /api/sse?apiKey=your_api_key

Integration with Cursor

SSE Integration Method

{
  "name": "MySQL Database Service",
  "url": "http://localhost:3000/api/sse",
  "type": "sse"
}

Command Integration Method

{
  "name": "MySQL Database Service",
  "command": "node /path/to/mcp_server_mysql/src/app.js",
  "type": "command"
}

Security Notes

• This service is intended for local use only
• API key protection is implemented to prevent unauthorized access
• By default, only SELECT queries are permitted to ensure database safety

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "mysql-database" '{"command":"node","args":["/path/to/mcp_server_mysql/src/app.js"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "mysql-database": {
            "command": "node",
            "args": [
                "/path/to/mcp_server_mysql/src/app.js"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "mysql-database": {
            "command": "node",
            "args": [
                "/path/to/mcp_server_mysql/src/app.js"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect