Mysql Schema Explorer

🚀 MySQL Schema MCP Server

A Model Context Protocol (MCP) server that provides schema information of a MySQL database in a compressed format. This MCP server is very useful in scenarios where large database schemas are used and the schema dump file exceeds the context size limit.

https://github.com/user-attachments/assets/f81b2513-31bd-4a60-9b54-45f76323d112

🚀 Quick Start

Step 1: Installation

go install github.com/shibayu36/mysql-schema-explorer-mcp@latest

Step 2: Configure the mcp.json file

{
  "mcpServers": {
    "mysql-schema-explorer-mcp": {
      "command": "/path/to/mysql-schema-explorer-mcp",
      "env": {
        "DB_HOST": "127.0.0.1",
        "DB_PORT": "3306",
        "DB_USER": "root",
        "DB_PASSWORD": "root"
      }
    }
  }
}

Step 3: Generate SQL using the proxy

Example: Use the ecshop database structure to output the names of the three most recently purchased products by the user named shibayu36.

✨ Features

Provided Tools

List Tables (list_tables)

• Displays information about all tables in the specified database. It includes table names, comments, primary keys, unique keys, foreign keys, etc.
• Parameters
  • dbName: The name of the target database to retrieve information from.

Describe Tables (describe_tables)

• Displays detailed information about specific tables in the specified database. It provides organized column definitions, constraints, and indexes.
• Parameters
  • dbName: The name of the target database to retrieve information from.
  • tableNames: An array of table names to retrieve detailed information for.