@wangy_as/query-db

MCP (Model Context Protocol) MySQL 数据库查询工具

项目描述

这是一个为 MCP 生态系统开发的 MySQL 数据库查询工具。它提供了命令行界面，可以方便地进行数据库查询操作，并与 Model Context Protocol SDK 无缝集成。

安装方法

全局安装（使用 npm）：

npm install -g @wangy_as/query-db

或使用 yarn：

yarn global add @wangy_as/query-db

主要功能

• MySQL 数据库查询功能
• 集成 MCP SDK
• 命令行界面（基于 yargs）
• 使用 TypeScript 和 Zod 实现类型安全

依赖项

• @modelcontextprotocol/sdk - ^1.8.0
• mysql2 - ^3.14.0
• yargs - ^17.7.2
• zod - ^3.24.2

使用说明

MCP 服务器配置说明

配置参数

在 MCP 服务器中使用本工具时，需要配置以下数据库连接参数：

• host: MySQL 服务器地址（默认：localhost）
• port: MySQL 服务器端口（默认：3306）
• user: MySQL 用户名（默认：root）
• password: MySQL 密码（默认：空）
• database: MySQL 数据库名称（必填）

可用功能

工具提供两个主要功能：

1. execute-query: 执行 SELECT 查询语句

   • 用于查询数据的只读操作
   • 返回查询结果的 JSON 格式数据

2. execute-non-query: 执行 INSERT、UPDATE、DELETE 语句

   • 用于修改数据的操作
   • 返回操作结果的影响行数等信息

错误处理

工具会自动处理以下情况：

• 数据库连接失败
• SQL 语句执行错误
• 参数验证错误

如果遇到错误，会在控制台输出详细的错误信息。

注意事项

1. 确保 MySQL 服务器已经启动并可访问
2. 确保提供的数据库用户具有足够的操作权限
3. 建议在生产环境中使用专门的数据库用户，避免使用 root 账户
4. 密码等敏感信息建议通过环境变量或配置文件传入，避免在命令行中明文显示

许可证

ISC

作者

wangy_as