Skip to main content

An MCP server implementation for MySQL database integration

Project description

mysqldb-mcp-server MCP server

smithery badge

A MySQL database MCP server project.

Installation

You can install the package using uv:

uv pip install mysqldb-mcp-server

Or using pip:

pip install mysqldb-mcp-server

Components

Tools

The server provides two tools:

  • connect_database: Connects to a specific MySQL database

    • database parameter: Name of the database to connect to (string)
    • Returns a confirmation message when connection is successful
  • execute_query: Executes MySQL queries

    • query parameter: SQL query/queries to execute (string)
    • Returns query results in JSON format
    • Multiple queries can be sent separated by semicolons

Configuration

The server uses the following environment variables:

  • MYSQL_HOST: MySQL server address (default: "localhost")
  • MYSQL_USER: MySQL username (default: "root")
  • MYSQL_PASSWORD: MySQL password (default: "")
  • MYSQL_DATABASE: Initial database (optional)
  • MYSQL_READONLY: Read-only mode (set to 1/true to enable, default: false)

Quickstart

Installation

Claude Desktop

MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Server Configuration
{
  "mcpServers": {
    "mysqldb-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/burakdirin/Projects/mysqldb-mcp-server",
        "run",
        "mysqldb-mcp-server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "password",
        "MYSQL_DATABASE": "[optional]",
        "MYSQL_READONLY": "true"
      }
    }
  }
}
Published Server Configuration
{
  "mcpServers": {
    "mysqldb-mcp-server": {
      "command": "uvx",
      "args": [
        "mysqldb-mcp-server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "password",
        "MYSQL_DATABASE": "[optional]",
        "MYSQL_READONLY": "true"
      }
    }
  }
}

Installing via Smithery

To install MySQL Database Integration Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @burakdirin/mysqldb-mcp-server --client claude

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /Users/burakdirin/Projects/mysqldb-mcp-server run mysqldb-mcp-server

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orange_mysqldb_mcp_server-0.1.2.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orange_mysqldb_mcp_server-0.1.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file orange_mysqldb_mcp_server-0.1.2.tar.gz.

File metadata

File hashes

Hashes for orange_mysqldb_mcp_server-0.1.2.tar.gz
Algorithm Hash digest
SHA256 8441a2b92207a8fcd71a257346f1948970c45c669dfefc953e218bc3001ba749
MD5 373de8b0fa5d3b1e7a8d29b867ec071a
BLAKE2b-256 a3f9974963a93ebaacd0e713862c637d78bca256fdecb22b63fac9fe0f1d0728

See more details on using hashes here.

File details

Details for the file orange_mysqldb_mcp_server-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for orange_mysqldb_mcp_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 77e63a4ad2595a96b57a572fd2a79257b1459374f66e16ee84e9461dfb67a26b
MD5 812fe251dca10ceab89e83f4284e77f6
BLAKE2b-256 0ecd561ea019708bd21f690419747c95b888a169243ecf4e4355cfc4f22e086d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page