Mysql Database Service

🚀 MySQL Database MCP Service

This is a service based on the MCP (Model Context Protocol), which allows interaction with a MySQL database through Cursor, enabling operations such as table creation, querying, modification, and deletion.

🚀 Quick Start

✨ Features

• Create and manage database tables.
• Perform CRUD operations (Create, Read, Update, Delete).
• Execute custom SQL queries.
• Integrate with Cursor via the MCP protocol.

📦 Installation

Prerequisites

• Node.js 18.0.0 or higher.
• A MySQL database server.

Installation Steps

1. Clone or download this repository.
2. Install dependencies:

npm install

3. Configure environment variables:
   • Copy the .env.example file to .env.
   • Edit the .env file and fill in your MySQL database connection information.

# Database configuration
DB_HOST=localhost
DB_PORT=3006
DB_USER=Your database username
DB_PASSWORD=Your database password
DB_NAME=Your database name

# Server configuration
PORT=3001

Start the Service

npm start

The server will start at http://localhost:3001 (or the port you specified in .env).

💻 Usage Examples

Using in Cursor

1. In Cursor, add the MCP service using the following methods:
   • Method 1: Search for "MCP" in the command panel and select to add the service.
   • Method 2: Find the MCP-related configuration in the settings.
   • Method 3: Directly use the command /connect-mcp http://localhost:3001/sse.
2. After successful connection, you can interact with the MySQL database through resources and tools.

Available Features

Resources

1. List all tables:

mysql://tables

2. View table structure:

mysql://schema/table_name

3. View table data:

mysql://data/table_name

Tools

1. Create a table:

create-table tableName="table_name" schema="id INT PRIMARY KEY AUTO_INCREMENT, name VARCHAR(255)"

2. Drop a table:

drop-table tableName="table_name"

3. Insert data:

insert-data tableName="table_name" data="{\"name\": \"张三\", \"age\": 30}"

4. Update data:

update-data tableName="table_name" data="{\"name\": \"李四\"}" condition="{\"id\": 1}"

5. Delete data:

delete-data tableName="table_name" condition="{\"id\": 1}"

6. Query data:

query-data tableName="table_name" condition="{\"id\": 1}" fields=["name", "age"]

7. Execute a custom SQL query:

execute-sql sql="SELECT * FROM table_name"

Example Scenarios

Create a User Table and Insert Data

1. Create a table:

{
  "command": "create-table",
  "tableName": "users",
  "schema": "id INT PRIMARY KEY AUTO_INCREMENT, username VARCHAR(255), email VARCHAR(255)"
}

2. Insert data:

{
  "command": "insert-data",
  "tableName": "users",
  "data": {"username": "张三", "email": "zhangsan@example.com"}
}

📚 Documentation

Project Architecture

MySQL Database MCP Service
├── src/
│   ├── services/
│   │   └── DatabaseService.js
│   ├── controllers/
│   │   └── DatabaseController.js
│   └── routes/
│       └── databaseRoutes.js
└── package.json

🔧 Technical Details

Security Precautions

• Do not store sensitive database credentials in code or environment variables.
• Limit the permissions of MySQL users to only allow necessary operations.

📄 License

MIT