Mysql Database Server

🚀 @enemyrr/mcp-mysql-server

一个提供MySQL数据库操作的Model Context Protocol服务器，该服务器可让AI模型借助标准化接口与MySQL数据库进行交互，为数据操作提供便利。

🚀 快速开始

✨ 主要特性

• 支持多种连接方式（URL、工作区、直接）。
• 提供安全的连接处理和自动清理。
• 支持prepared statements以防止SQL注入。
• 提供Schema管理工具。
• 具有全面的错误处理和验证。
• 支持TypeScript。
• 自动检测工作区。

📦 安装指南

通过Smithery安装

要自动通过Smithery安装Claude Desktop的MySQL数据库服务器，可使用以下命令：

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

手动安装

1. 克隆并构建项目：

git clone https://github.com/enemyrr/mcp-mysql-server.git
cd mcp-mysql-server
npm install
npm run build

2. 在Cursor IDE设置中添加服务器：
   • 打开命令palette（Cmd/Ctrl + Shift + P）。
   • 搜索“MCP: Add Server”。
   • 填写信息：
     • 名称：mysql
     • 类型：command
     • 命令：node /绝对路径/to/mcp-mysql-server/build/index.js

⚠️ 重要提示

将 /absolute/path/to/ 替换为实际克隆和构建项目的路径。

数据库配置

你可以通过三种方式配置数据库连接：

1. 在.env中的Database URL（推荐）：

DATABASE_URL = mysql://username:password@host:port/database

2. 单独设置DB参数：

DB_HOST = host
DB_USER = username
DB_PASSWORD = password
DB_NAME = database
DB_PORT = port

3. 通过工具直接连接并提供详细信息。

💻 使用示例

基础用法

本服务器提供了一系列实用工具，以下是部分工具的使用示例：

# 建立数据库连接
connect_db()

# 执行查询
query("SELECT * FROM table_name")

# 执行非查询操作
execute("INSERT INTO table_name (column1, column2) VALUES ('value1', 'value2')")

# 列出所有表
list_tables()

# 获取指定表的列信息
get_columns("table_name")

# 执行自定义查询
execute_query("SELECT column1 FROM table_name WHERE condition")

# 插入数据
insert_data("table_name", {"column1": "value1", "column2": "value2"})

# 更新数据
update_data("table_name", {"column1": "new_value"}, "condition")

# 删除数据
delete_data("table_name", "condition")

🔧 技术细节

安全

• 使用prepared statements防止SQL注入。
• 通过环境变量支持安全密码处理。
• 在执行前验证查询。
• 自动关闭连接。

错误处理

服务器为以下情况提供详细的错误信息：

• 连接失败。
• 无效的查询或参数。
• 配置缺失。
• 数据库错误。
• Schema验证错误。

📄 许可证

本项目采用MIT许可证。

贡献

欢迎贡献！请随意提交Pull Request到 https://github.com/enemyrr/mcp-mysql-server