mcp-server-mysql

mcp-server-mysql

site icon
2025.04.17 6
JavaScript数据库服务只读查询模式检查数据库
mcp-server-mysql 是一个基于 Model Context Protocol 的 MySQL 数据库服务,专为 LLMs(大型语言模型)设计,使其能够检查数据库模式并执行只读查询。该服务提供了对 MySQL 数据库的安全、只读访问,支持 Docker 和 NPM 安装方式,适用于需要数据库查询和分析的场景。
View on GitHub

Overview

基本能力

产品定位

mcp-server-mysql 是一个为 MySQL 数据库提供只读访问的服务,特别适用于需要数据库模式检查和查询执行的 LLMs 应用场景。

核心功能

  • 对 MySQL 数据库的只读访问
  • 数据库模式检查能力
  • 在只读事务中安全执行查询
  • 支持 Docker 容器化部署
  • 提供 NPM 包安装方式

适用场景

  • LLMs 需要查询 MySQL 数据库的场景
  • 数据库模式分析和检查
  • 需要安全、只读访问数据库的应用

工具列表

  • Docker:支持通过 Docker 容器化部署和运行服务。
  • NPM:提供 NPM 包安装方式,便于集成到现有项目中。
  • Smithery:支持通过 Smithery 自动安装和配置服务。

常见问题解答

  • 安全性:所有查询都在只读事务中执行,确保数据库安全。建议创建只读用户以增强安全性。
  • macOS 使用 Docker:如果 MySQL 服务器运行在主机网络上,使用 host.docker.internal 作为主机名。

使用教程

使用依赖

无特殊前置依赖,支持 Docker 和 NPM 安装方式。

安装教程

使用 Docker

# Build the Docker image
make docker

# Run with Docker
docker run -i --rm mcp/mysql mysql://host:port/dbname

使用 NPM

npm install @modelcontextprotocol/server-mysql

使用 Smithery

npx -y @smithery/cli install @yuru-sha/mcp-server-mysql --client claude

调试方式

# Initial setup
make setup

# Build the project
make build

# Format code
make format

# Run linter
make lint

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。