MySQL数据库IDE连接工具

用于Cursor IDE的MySQL MCP服务器

这是一个模型上下文协议（MCP）服务器，允许Cursor IDE与MySQL数据库交互。它提供了连接数据库、执行查询、探索模式和管理数据库操作的工具。

特性

• 🔌 数据库连接管理：连接到MySQL数据库和断开与MySQL数据库的连接
• 🔍 查询执行：执行SQL查询并获取结果
• 📋 模式探索：列出表和查看表架构
• 🗄️ 数据库管理：列出可用数据库并在它们之间切换
• 🛡️ 错误处理：全面的错误处理和验证
• 🔧 环境配置：通过环境变量进行安全凭据管理

先决条件

• Node.js（版本18或更高）
• MySQL服务器正在运行且可访问
• 光标IDE

安装

1. 克隆或下载此存储库

   复制

   git clone <repository-url>
   cd mysql-mcp
   

2. 安装依赖项

   复制

   npm install
   

3. 配置数据库连接

   复制

   cp env.example .env
   

   编辑 .env 使用MySQL数据库凭据的文件：

   复制

   DB_HOST=localhost
   DB_USER=your_username
   DB_PASSWORD=your_password
   DB_NAME=your_database
   DB_PORT=3306
   

使用Cursor IDE进行设置

1. 在游标中配置MCP:

   • 打开光标IDE
   • 转到“设置”（Ctrl/Cmd+，）
   • 搜索“MCP”或“模型上下文协议”
   • 将路径添加到您的 mcp-config.json 文件

2. 替代方案：直接使用MCP配置:

   • 复制以下内容 mcp-config.json 到您的光标MCP设置
   • 确保路径 src/server.js 是正确的

可用工具

MCP服务器提供Cursor可以使用的以下工具：

1. connect

连接到MySQL数据库。

• 参数: host, user, password, database, port （可选，默认值：3306）

2. disconnect

断开与当前数据库连接的连接。

3. execute_query

执行SQL查询并返回结果。

• 参数: query （SQL查询字符串）

4. get_tables

列出当前数据库中的所有表。

5. get_table_schema

获取特定表的架构信息。

• 参数: table_name

6. get_databases

列出服务器上所有可用的数据库。

7. switch_database

切换到其他数据库。

• 参数: database

使用示例

配置后，您可以在Cursor IDE中使用这些工具：

连接到数据库

Use the connect tool with:
- host: localhost
- user: myuser
- password: mypassword
- database: mydatabase

执行查询

Use the execute_query tool with:
- query: SELECT * FROM users LIMIT 10

获取表架构

Use the get_table_schema tool with:
- table_name: users

发展

运行服务器

# Production mode
npm start

# Development mode with auto-restart
npm run dev

测试

您可以通过运行以下命令独立测试服务器：

node src/server.js

安全考虑

• 永远不要承诺你的 .env 文件到版本控制
• 为MySQL数据库使用强密码
• 考虑将连接池用于生产环境
• 在MySQL服务器上实施适当的访问控制

故障排除

常见问题

1. 连接被拒绝：确保你的MySQL服务器正在运行并且可以访问
2. 认证失败：在中验证您的用户名和密码 .env 文件
3. 权限不足：确保您的MySQL用户具有必要的权限
4. MCP不工作：检查路径是否正确 mcp-config.json 是正确的

调试模式

要启用调试日志记录，请设置环境变量：

DEBUG=mysql-mcp:*

贡献

请随时提交问题和增强请求！

许可证

MIT许可证-有关详细信息，请参阅许可证文件。