返回 MCP 目录
public公开dns本地运行

MySQL Schema Explorer

MySQL数据库模式压缩服务

article

README

🚀 MySQL 模式 MCP 服务器

这是一个针对 MySQL 数据库的模型上下文协议 (MCP) 服务器,它以压缩形式提供数据库的模式信息。在处理大规模数据库模式时,当模式转储文件超出上下文大小限制,该 MCP 服务器就能发挥重要作用。

点击查看相关资源

✨ 主要特性

提供的工具

  • 表格列表获取 (list_tables)
    • 此功能可显示指定数据库内的所有表格信息,涵盖表格名称、注释、主键、唯一键、外键信息等。
    • 参数
      • dbName:用于指定获取信息的目标数据库名称。
  • 表格详细信息获取 (describe_tables)
    • 该功能可显示指定数据库中特定表格的详细信息,提供整理后的列定义、约束和索引等内容。
    • 参数
      • dbName:指定获取信息的目标数据库名称。
      • tableNames:指定获取详细信息的表格名称数组。

🚀 快速开始

📦 安装指南

执行以下安装命令:

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

配置文件设置

配置 mcp.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"
      }
    }
  }
}

💻 使用示例

基础用法

使用代理执行 SQL 生成,例如使用 ecshop 数据库结构,输出最近由用户名为 shibayu36 的用户购买的三个商品名称。具体代码可参考上述配置完成后,结合实际业务逻辑编写。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端