https://github.com/shibayu36/mysql-schema-explorer-mcp
https://github.com/shibayu36/mysql-schema-explorer-mcp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/shibayu36/mysql-schema-explorer-mcp
- Owner: shibayu36
- License: mit
- Created: 2025-04-20T11:34:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-05-31T07:09:24.000Z (4 months ago)
- Last Synced: 2025-06-19T01:39:23.439Z (4 months ago)
- Language: Go
- Size: 145 KB
- Stars: 16
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - shibayu36/mysql-schema-explorer-mcp - scale databases. (🗄️ Databases)
- awesome-mcp-servers - **mysql-schema-explorer-mcp** - Go-based (actively maintained) `database` `http` `mysql` `git` `github` `go install shibayu36/mysql-schema-explorer-mcp@latest` (Database)
- awesome-mcp-servers - **mysql-schema-explorer-mcp** - Go-based `database` `http` `mysql` `git` `github` `go install shibayu36/mysql-schema-explorer-mcp@latest` (Database)
README
# MySQL Schema MCP Server
This is a Model Context Protocol (MCP) server that provides compressed schema information for MySQL databases.
This MCP server is useful when the schema dump file does not fit in the context size because you are using a large database schema.
https://github.com/user-attachments/assets/0cecef84-cd70-4f84-95cb-01c6ec7c9ac7
## Provided Tools
- List Tables (`list_tables`)
- Lists all table information in the specified database. Includes table name, comment, primary key, unique key, and foreign key information.
- Parameters
- `dbName`: The name of the database to retrieve information from (not required when DB_NAME environment variable is set)
- Describe Tables (`describe_tables`)
- Displays detailed information for specific tables in the specified database. Provides formatted information such as column definitions, key constraints, and indexes.
- Parameters
- `dbName`: The name of the database to retrieve information from (not required when DB_NAME environment variable is set)
- `tableNames`: An array of table names to retrieve detailed information for
## Quick Start
1. Install the command
```
go install github.com/shibayu36/mysql-schema-explorer-mcp@latest
```
2. Configure mcp.json
```json
{
"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"
},
}
}
}
```
3. Execute SQL generation using the agent
Example: Using the structure of the ecshop database, list the names of the 3 most recently ordered products by the user shibayu36.
## Usage
### Fixing to a Specific Database
When accessing only one database, you can set the `DB_NAME` environment variable to avoid specifying the database name each time.
```json
{
"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",
"DB_NAME": "ecshop"
},
}
}
}
```