Mysql MCP Server L7j

🚀 MySQL MCP Server

A Model Context Protocol (MCP) server that provides read-only access to MySQL databases. This server enables Large Language Models (LLMs) to view database schemas and execute read-only queries.

🚀 Quick Start

The MySQL MCP Server allows LLMs to access MySQL databases in a read - only manner. It supports authentication via database URLs and provides tools and resources for querying and retrieving schema information.

✨ Features

• Read - Only Access: Ensures data security by allowing only read - only operations.
• MySQL Authentication: Supports authentication through database URLs.
• Schema Information: Provides JSON schema information for each table in the database.
• Easy Integration: Can be easily integrated with Cursor for seamless use.

📦 Installation

1. Clone the repository:

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

2. Prepare and install dependencies:

npm run prepare
npm install

3. Create a global link:

npm link

Now, you can use the mysql-mcp-server command anywhere in the terminal:

mysql-mcp-server mysql://user:password@localhost:3306/mydb

💻 Usage Examples

Usage with Cursor

Configure MCP in Cursor

1. Open Cursor's settings:
   • Click the gear icon (⚙️) at the bottom - left corner.
   • Or press Shift + Cmd + J on macOS.
2. Configure the MCP server:
   • Click “MCP” in the left sidebar.
   • Click “Add Global MCP Server”.
   • Add the following configuration:

{
  "mcpServers": {
    "mysql": {
      "command": "mysql-mcp-server",
      "args": ["mysql://user:password@localhost:3306/mydb"]
    }
  }
}

3. Save the configuration:
   • Click “Save” or press Cmd + S.
   • Restart Cursor for the changes to take effect.

How to use it in Cursor?

Open the intelligent chat window in Cursor and start asking database - related questions. It will have all the necessary context.

Security Best Practices

⚠️ Important Note

Always ensure your credentials are secure and do not expose your configuration publicly.

💡 Usage Tip

1. Use environment variables to store sensitive credentials:

{
  "mcpServers": {
    "mysql": {
      "command": "mysql-mcp-server",
      "args": ["mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@host:3306/mydb"]
    }
  }
}

2. Ensure the MySQL user has the minimum required permissions (read - only access).
3. Use strong passwords and follow security best practices.
4. Avoid committing configuration files containing credentials to the version control system.

📚 Documentation

Authentication

The server supports MySQL authentication via database URLs. The URL format is as follows:

mysql://username:password@host:port/database

Example:

• Database: mysql://user:pass@localhost:3306/mydb

Components

Tools

• query
  • Execute read - only SQL queries against the connected database.
  • Input: sql (string): The SQL query to execute.
  • All queries are executed in a read - only transaction.
  • Authentication is automatically handled using the provided credentials.

Resources

The server provides database schema information for each table:

• Table Schema (mysql://<host>/<table>/schema)
  • JSON schema information for each table.
  • Includes column names and data types.
  • Automatically discovered from database metadata.
  • Accessed with authentication using the provided credentials.

📄 License

This MCP server is released under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.