Mysql MCP C3l

🚀 MySQL MCP Server

The MCP service that provides MySQL database connection and query capabilities for Cursor

🚀 Quick Start

The MySQL MCP service is an API service developed based on Node.js, which provides Cursor AI with the ability to directly access MySQL databases. This service adheres to the MCP (Model Control Platform) protocol specification, enabling AI to execute SQL queries, obtain table structure information, and perform data operations through a standardized interface.

✨ Features

• SQL Query Execution: Supports the execution of various SQL statements (SELECT, INSERT, UPDATE, DELETE, etc.).
• Table Structure Query: Retrieves detailed structure information of database tables.
• Real - time Data Access: Provides AI with real - time database access capabilities.
• Secure Connection: Supports configuring database connection parameters via environment variables.
• Cross - origin Support: Built - in CORS support for easy integration with front - end applications.
• Standardized Response: A unified API response format simplifies integration and usage.
• MCP Protocol Support: Fully implements the MCP protocol for convenient integration with Cursor AI.

🔧 Technical Details

• Runtime Environment: Node.js
• Main Framework: Express.js
• Database Driver: mysql2
• Environment Variables: dotenv
• Cross - origin Support: cors

📦 Installation

Prerequisites

• Node.js 14.x or higher
• A connectable MySQL database
• Git (optional, for cloning the code)

Installation Steps

1. Clone the code repository

git clone https://github.com/lichuanrong7/mysql-mcp-server.git
cd mysql-mcp-server

2. Install dependencies

npm install

3. Configure environment variables Edit the .env file and fill in your MySQL database information:

DB_HOST=Your database host address
DB_PORT=Your database port number
DB_USER=Your database username
DB_PASSWORD=Your database password
DB_NAME=Your database name

4. Start the server

npm start

📚 Documentation

You can further configure the service as needed, for example:

• Modify the config.json file to adjust other settings.
• Add custom middleware or routes.

⚠️ Important Note

• Ensure that the MySQL database is correctly configured and running.
• Ensure that all environment variables are correctly filled in.
• Avoid exposing sensitive information from the development environment in the production environment.

The complete API documentation can be found in docs/api.md, including all available endpoints and request formats.

🛠️ Tools

To better manage and deploy this service, it is recommended to use the following tools:

• Docker: For containerized deployment.
• PM2: For process management in the production environment.
• Nginx: As a reverse proxy server.

📝 Issues and Contributions

You are welcome to report any issues or submit improvement suggestions. Please visit the GitHub repository for more detailed information and to participate in discussions.

We very much welcome your contributions to this project! Please follow these steps:

1. Fork this repository.
2. Create a feature branch in your fork (e.g., feature/new-feature).
3. Commit your changes.
4. Push to GitHub.
5. Create a Pull Request.

📄 License

This project uses the MIT license - see the LICENSE file for details.