Skip to main content

An AWS Labs Model Context Protocol (MCP) server for mysql

Project description

AWS Labs MySQL MCP Server

An AWS Labs Model Context Protocol (MCP) server for Aurora MySQL

Features

Natural language to MySQL SQL query

  • Converting human-readable questions and commands into structured MySQL-compatible SQL queries and executing them against the configured Aurora MySQL database.

Prerequisites

  1. Install uv from Astral or the GitHub README
  2. Install Python using uv python install 3.10
  3. Aurora MySQL Cluster with MySQL username and password stored in AWS Secrets Manager
  4. Enable RDS Data API for your Aurora MySQL Cluster, see instructions here
  5. This MCP server can only be run locally on the same host as your LLM client.
  6. Docker runtime
  7. Set up AWS credentials with access to AWS services
    • You need an AWS account with appropriate permissions
    • Configure AWS credentials with aws configure or environment variables

Installation

Kiro Cursor VS Code
Add to Kiro Install MCP Server Install on VS Code

Configure the MCP server in your MCP client configuration (e.g., for Kiro, edit ~/.kiro/settings/mcp.json):

Connection Methods

This MCP server supports two connection methods:

  1. RDS Data API Connection (using --resource_arn): Uses the AWS RDS Data API to connect to Aurora MySQL. This method requires that your Aurora cluster has the Data API enabled.

  2. Direct MySQL Connection (using --hostname): Uses asyncmy to connect directly to any MySQL database, including Aurora MySQL, RDS MySQL, RDS MariaDB, or self-hosted MySQL/MariaDB instances.

Choose the connection method that best fits your environment and requirements.

Option 1: Using RDS Data API Connection (for Aurora MySQL)

{
  "mcpServers": {
    "awslabs.mysql-mcp-server": {
      "command": "uvx",
      "args": [
        "awslabs.mysql-mcp-server@latest",
        "--resource_arn", "[your data]",
        "--secret_arn", "[your data]",
        "--database", "[your data]",
        "--region", "[your data]",
        "--readonly", "True"
      ],
      "env": {
        "AWS_PROFILE": "your-aws-profile",
        "AWS_REGION": "us-east-1",
        "FASTMCP_LOG_LEVEL": "ERROR"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Option 2: Using Direct MySQL Connection (for Aurora MySQL, RDS MySQL, and RDS MariaDB)

{
  "mcpServers": {
    "awslabs.mysql-mcp-server": {
      "command": "uvx",
      "args": [
        "awslabs.mysql-mcp-server@latest",
        "--hostname", "[your data]",
        "--secret_arn", "[your data]",
        "--database", "[your data]",
        "--region", "[your data]",
        "--readonly", "True"
      ],
      "env": {
        "AWS_PROFILE": "your-aws-profile",
        "AWS_REGION": "us-east-1",
        "FASTMCP_LOG_LEVEL": "ERROR"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Note: The --port parameter is optional and defaults to 3306 (the standard MySQL port). You only need to specify it if your MySQL instance uses a non-default port.

Windows Installation

For Windows users, the MCP server configuration format is slightly different:

{
  "mcpServers": {
    "awslabs.mysql-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "uv",
      "args": [
        "tool",
        "run",
        "--from",
        "awslabs.mysql-mcp-server@latest",
        "awslabs.mysql-mcp-server.exe"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR",
        "AWS_PROFILE": "your-aws-profile",
        "AWS_REGION": "us-east-1"
      }
    }
  }
}

Build and install docker image locally on the same host of your LLM client

  1. 'git clone https://github.com/awslabs/mcp.git'
  2. Go to sub-directory 'src/mysql-mcp-server/'
  3. Run 'docker build -t awslabs/mysql-mcp-server:latest .'

Add or update your LLM client's config with following:

{
  "mcpServers": {
    "awslabs.mysql-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "AWS_ACCESS_KEY_ID=[your data]",
        "-e", "AWS_SECRET_ACCESS_KEY=[your data]",
        "-e", "AWS_REGION=[your data]",
        "awslabs/mysql-mcp-server:latest",
        "--resource_arn", "[your data]",
        "--secret_arn", "[your data]",
        "--database", "[your data]",
        "--region", "[your data]",
        "--readonly", "True"
      ]
    }
  }
}

NOTE: By default, only read-only queries are allowed and it is controlled by --readonly parameter above. Set it to False if you also want to allow writable DML or DDL.

AWS Authentication

The MCP server uses the AWS profile specified in the AWS_PROFILE environment variable. If not provided, it defaults to the "default" profile in your AWS configuration file.

"env": {
  "AWS_PROFILE": "your-aws-profile"
}

Make sure the AWS profile has permissions to access the RDS data API, and the secret from AWS Secrets Manager. The MCP server creates a boto3 session using the specified profile to authenticate with AWS services. Your AWS IAM credentials remain on your local machine and are strictly used for accessing AWS services.

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

awslabs_mysql_mcp_server-1.0.18.tar.gz (114.6 kB view details)

Uploaded Source

Built Distribution

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

awslabs_mysql_mcp_server-1.0.18-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file awslabs_mysql_mcp_server-1.0.18.tar.gz.

File metadata

File hashes

Hashes for awslabs_mysql_mcp_server-1.0.18.tar.gz
Algorithm Hash digest
SHA256 f858567abfe99d7a8909bb9a997772e486b58af493a8feb7916d6f5a7da9b196
MD5 b608a27a300a0a1616ca8d41f811f53b
BLAKE2b-256 4f2e05b492c85fc6ea0f0e89876ce1f76c56b1e91328dadcc9c9bbd21aeaf883

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_mysql_mcp_server-1.0.18.tar.gz:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file awslabs_mysql_mcp_server-1.0.18-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_mysql_mcp_server-1.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 355207a36ee16b9c178612ab711a09fce4eead25f2aa8597a0a9332dafcb7fb3
MD5 c76b13f01f4f99f1cd095f6f64c5f262
BLAKE2b-256 d143417fd6984c3b933ec500eae0c11fcacd4998bd4a88462238838d0068ec69

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_mysql_mcp_server-1.0.18-py3-none-any.whl:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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