@f4ww4z/mcp-mysql-server

@f4ww4z/mcp-mysql-server

site icon
2024.12.27 0
JavaScript数据库服务MySQL 操作数据库
f4ww4z_mcp-mysql-server 是一个基于 Model Context Protocol 的服务器,提供 MySQL 数据库操作功能。它通过标准化接口使 AI 模型能够与 MySQL 数据库进行交互,支持多种数据库操作,包括连接数据库、执行查询、插入、更新、删除等操作。
View on GitHub

Overview

基本能力

产品定位

f4ww4z_mcp-mysql-server 是一个专门用于 MySQL 数据库操作的 MCP 服务器,旨在为 AI 模型提供与 MySQL 数据库交互的能力。

核心功能

  • 数据库连接管理:支持通过 connect_db 工具建立和管理数据库连接。
  • 查询执行:通过 query 工具执行 SELECT 查询,支持参数化查询。
  • 数据操作:通过 execute 工具执行 INSERT、UPDATE、DELETE 等操作。
  • 表结构查询:通过 list_tablesdescribe_table 工具查询数据库中的表及其结构。
  • 安全特性:支持预处理语句以防止 SQL 注入,自动关闭连接,并提供详细的错误处理。

适用场景

  • AI 模型需要与 MySQL 数据库交互的场景。
  • 需要执行复杂查询或数据操作的自动化任务。
  • 需要动态查询数据库结构的开发或调试场景。

工具列表

  1. connect_db:建立与 MySQL 数据库的连接。
  2. query:执行 SELECT 查询,支持参数化查询。
  3. execute:执行 INSERT、UPDATE、DELETE 等操作。
  4. list_tables:列出数据库中的所有表。
  5. describe_table:获取指定表的结构信息。

常见问题解答

  • 连接失败:检查环境变量 MYSQL_HOSTMYSQL_USERMYSQL_PASSWORDMYSQL_DATABASE 是否正确设置。
  • 查询错误:确保 SQL 语句语法正确,参数数量与占位符匹配。
  • 权限问题:确保数据库用户有足够的权限执行操作。

使用教程

使用依赖

  • 需要安装 Node.js 和 npm。

安装教程

通过 Smithery 安装

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

手动安装

npx @f4ww4z/mcp-mysql-server

配置

在 MCP 配置文件中设置以下环境变量:

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@f4ww4z/mcp-mysql-server"],
      "env": {
        "MYSQL_HOST": "your_host",
        "MYSQL_USER": "your_user",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

调试方式

  1. 确保环境变量正确设置。
  2. 使用 connect_db 工具测试数据库连接。
  3. 使用 queryexecute 工具执行简单查询,验证功能是否正常。
  4. 检查错误日志以排查问题。

许可证

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