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

Here are some ways you can work with MCP across AWS, and we'll be adding support to more products including Amazon Q Developer CLI soon: (e.g. for Amazon Q Developer CLI MCP, ~/.aws/amazonq/mcp.json):

{
  "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": []
    }
  }
}

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.1.tar.gz (69.8 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.1-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: awslabs_mysql_mcp_server-1.0.1.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for awslabs_mysql_mcp_server-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e776a1f027d8777775984ff068f9893c9753eb559c3917e17a93765abcab8157
MD5 ca3dd267b912db3d91908e0fad8a828f
BLAKE2b-256 4907cdc6c053ba6b207af2f063cc0b032de5d9f6ebbae23835705da509c46912

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_mysql_mcp_server-1.0.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_mysql_mcp_server-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83fc8b61621c184cb9b78a5096978cf8baa99b072a57b38377c0f62805fa0d12
MD5 d2baa2a66fba80ff4c6cd0590ef88882
BLAKE2b-256 106d52b53c94908747248733d5547407c6937caf861cce4a828dea758c827efb

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_mysql_mcp_server-1.0.1-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