MySQL MCP Server

A Model Context Protocol (MCP) server that enables Claude Desktop to interact with MySQL databases through natural language queries.

Features

🔍 Execute read-only SQL queries through Claude Desktop
🛡️ Built-in security with query validation (only SELECT statements allowed)
🔌 Easy integration with Claude Desktop
📊 JSON formatted query results
🔐 Environment-based configuration for database credentials

Quick Start

For Claude Code Users (Recommended - Easiest Method)

claude mcp add mysql -s user -- npx -y @hovecapital/read-only-mysql-mcp-server

Then set your database environment variables:

export DB_HOST=localhost
export DB_PORT=3306
export DB_DATABASE=your_database_name
export DB_USERNAME=your_username
export DB_PASSWORD=your_password

Done! Restart Claude Code and ask: "What tables are in my database?"

For Claude Desktop Users (Manual Configuration)

1. Open your config file:

# macOS
open ~/Library/Application\ Support/Claude/claude_desktop_config.json

# Windows
notepad %APPDATA%\Claude\claude_desktop_config.json

2. Add this configuration:

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@hovecapital/read-only-mysql-mcp-server"],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "3306",
        "DB_DATABASE": "your_database_name",
        "DB_USERNAME": "your_username",
        "DB_PASSWORD": "your_password"
      }
    }
  }
}

3. Save, restart Claude Desktop, and test!

Prerequisites

Node.js (v16 or higher) - If using mise, update the command path accordingly
MySQL database server
Claude Desktop application

Installation

Option 1: Install from MCP Registry (Recommended)

This server is published in the Model Context Protocol Registry as capital.hove/read-only-local-mysql-mcp-server.

Method A: Claude Code CLI (Easiest!)

claude mcp add mysql -s user -- npx -y @hovecapital/read-only-mysql-mcp-server

Then configure your database credentials using environment variables. Restart Claude Code and you're done!

Benefits:

One command installation
No manual JSON editing
Automatic configuration

Method B: Manual JSON Configuration

For Claude Desktop:

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@hovecapital/read-only-mysql-mcp-server"],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "3306",
        "DB_DATABASE": "your_database_name",
        "DB_USERNAME": "your_username",
        "DB_PASSWORD": "your_password"
      }
    }
  }
}

For Claude Code:

Edit ~/.config/claude-code/settings.json (macOS/Linux) or %APPDATA%\claude-code\settings.json (Windows):

{
  "mcp": {
    "servers": {
      "mysql": {
        "command": "npx",
        "args": ["-y", "@hovecapital/read-only-mysql-mcp-server"],
        "env": {
          "DB_HOST": "localhost",
          "DB_PORT": "3306",
          "DB_DATABASE": "your_database_name",
          "DB_USERNAME": "your_username",
          "DB_PASSWORD": "your_password"
        }
      }
    }
  }
}

Option 2: Install from npm

npm install -g @hovecapital/read-only-mysql-mcp-server

Option 3: Installation with Claude Code

If you're using Claude Code, you can easily install this MCP server:

# Clone the repository
git clone https://github.com/hovecapital/read-only-local-mysql-mcp-server.git
cd read-only-local-mysql-mcp-server

# Install dependencies and build
npm install
npm run build

Then configure Claude Code by adding to your MCP settings.

Option 4: Manual Installation

1. Clone or Download

Save the repository to a directory on your system:

mkdir ~/mcp-servers/mysql
cd ~/mcp-servers/mysql
git clone https://github.com/hovecapital/read-only-local-mysql-mcp-server.git .

2. Install Dependencies

npm install
npm run build

Configuration

Note: If you installed via Option 1 (MCP Registry with npx), you've already configured everything! This section is for users who chose Options 2, 3, or 4 (npm or manual installation).

Claude Code Configuration

If you're using Claude Code with a manual installation, add the MySQL server to your MCP settings:

Open your Claude Code settings (typically in ~/.config/claude-code/settings.json on macOS/Linux or %APPDATA%\claude-code\settings.json on Windows)
Add the MySQL MCP server configuration:

{
  "mcp": {
    "servers": {
      "mysql": {
        "command": "node",
        "args": ["/absolute/path/to/read-only-local-mysql-mcp-server/dist/index.js"],
        "env": {
          "DB_HOST": "localhost",
          "DB_PORT": "3306",
          "DB_DATABASE": "your_database_name",
          "DB_USERNAME": "your_username",
          "DB_PASSWORD": "your_password"
        }
      }
    }
  }
}

Restart Claude Code for the changes to take effect.

Claude Desktop Configuration

If you're using Claude Desktop with a manual installation, open your Claude Desktop configuration file:

macOS:

~/Library/Application Support/Claude/claude_desktop_config.json

Windows:

%APPDATA%\Claude\claude_desktop_config.json

Add the MySQL server configuration:

{
  "mcpServers": {
    "mysql": {
      "command": "node",
      "args": ["/absolute/path/to/read-only-local-mysql-mcp-server/dist/index.js"],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "3306",
        "DB_DATABASE": "your_database_name",
        "DB_USERNAME": "your_username",
        "DB_PASSWORD": "your_password"
      }
    }
  }
}

Using mise for Node.js

If you're using mise for Node.js version management, make sure to use the full path to the Node.js executable in your configuration.

Environment Variables

Variable	Description	Default
`DB_HOST`	MySQL server hostname	`mysql`
`DB_PORT`	MySQL server port	`3306`
`DB_DATABASE`	Database name	`database`
`DB_USERNAME`	MySQL username	`root`
`DB_PASSWORD`	MySQL password	(empty)

Usage

Restart Claude Desktop after updating the configuration
Start chatting with Claude about your database

Example Queries

"Show me all tables in my database"
"What's the structure of the users table?"
"Get the first 10 records from the products table"
"How many orders were placed last month?"
"Show me users with email addresses ending in @gmail.com"

Claude will automatically convert your natural language requests into appropriate SQL queries and execute them against your database.

Security Features

Read-Only Operations

The server only allows SELECT queries. The following operations are blocked:

INSERT - Adding new records
UPDATE - Modifying existing records
DELETE - Removing records
DROP - Removing tables/databases
ALTER - Modifying table structure
CREATE - Creating new tables/databases

Recommended Database Setup

For enhanced security, create a dedicated read-only user for the MCP server:

-- Create a read-only user
CREATE USER 'claude_readonly'@'localhost' IDENTIFIED BY 'secure_password';

-- Grant only SELECT permissions on your specific database
GRANT SELECT ON your_database_name.* TO 'claude_readonly'@'localhost';

-- Apply the changes
FLUSH PRIVILEGES;

Troubleshooting

Connection Issues

Verify MySQL is running: Check if your MySQL server is active
Check credentials: Ensure username/password are correct
Network connectivity: Confirm Claude Desktop can reach your MySQL server

Configuration Issues

Restart required: Always restart Claude Desktop after configuration changes
Path accuracy: Ensure the absolute path to dist/index.js is correct
JSON syntax: Validate your claude_desktop_config.json format

Debug Mode

To see server logs, you can run the server manually:

node dist/index.js

File Structure

~/mcp-servers/mysql/
├── src/
│   └── index.ts
├── dist/
│   ├── index.js
│   └── index.d.ts
├── package.json
├── tsconfig.json
└── node_modules/

Dependencies

@modelcontextprotocol/sdk: MCP protocol implementation
mysql2: Modern MySQL client for Node.js with Promise support

Contributing

Feel free to submit issues and enhancement requests!

License

This project is open source and available under the MIT License.

Support

If you encounter issues:

Check the troubleshooting section above
Verify your MySQL connection independently
Ensure Claude Desktop is updated to the latest version
Review the Claude Desktop MCP documentation

Note: This server is designed for development and analysis purposes. For production use, consider additional security measures and monitoring.

Name		Name	Last commit message	Last commit date
Latest commit History 69 Commits
.github/workflows		.github/workflows
src		src
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierrc		.prettierrc
.release-please-config.json		.release-please-config.json
.release-please-manifest.json		.release-please-manifest.json
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
server.json		server.json
tsconfig.json		tsconfig.json

License

hovecapital/read-only-local-mysql-mcp-server

Folders and files

Latest commit

History

Repository files navigation

MySQL MCP Server

Features

Quick Start

For Claude Code Users (Recommended - Easiest Method)

For Claude Desktop Users (Manual Configuration)

Prerequisites

Installation

Option 1: Install from MCP Registry (Recommended)

Method A: Claude Code CLI (Easiest!)

Method B: Manual JSON Configuration

Option 2: Install from npm

Option 3: Installation with Claude Code

Option 4: Manual Installation

1. Clone or Download

2. Install Dependencies

Configuration

Claude Code Configuration

Claude Desktop Configuration

Using mise for Node.js

Environment Variables

Usage

Example Queries

Security Features

Read-Only Operations

Recommended Database Setup

Troubleshooting

Connection Issues

Configuration Issues

Debug Mode

File Structure

Dependencies

Contributing

License

Support

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 17

Packages 0

Contributors 2

Uh oh!

Languages

Packages