JinDaGe - MySQL Read-Only MCP Details

article

README

🚀 MCP 服务器：MySQL 实现指南

本指南详细介绍了 MCP 服务器基于 MySQL 的实现方法，涵盖安装、配置、测试、故障排除、贡献等方面，助您轻松搭建和使用 MCP 服务器。

🚀 快速开始

本指南将帮助您完成 MCP 服务器的安装、配置、测试等操作，让您快速上手使用。

📦 安装指南

使用 Smithery 进行安装

smithery install @benborla/mcp-server-mysql

使用 MCP Get 进行安装

mcp-get install @benborla/mcp-server-mysql

📚 详细文档

配置说明

根据文档中提供的配置选项，您可以选择以下方式设置环境变量：

设置 PATH 环境变量（可选）

export PATH="/path/to/node/bin:$PATH"

配置示例

{
  "env": {
    "NODE_OPTIONS": "--loader ts-node/index",
    "PATH": "/path/to/node/bin:/usr/bin:/bin"
  }
}

测试指南

数据库准备

创建测试用户和数据库

CREATE USER 'mcp_test'@'localhost' IDENTIFIED BY 'mcp_test_password';
GRANT ALL PRIVILEGES ON mcp_test.* TO 'mcp_test'@'localhost';
FLUSH PRIVILEGES;

运行数据库脚本

pnpm run setup:test:db

创建测试环境文件 在项目根目录下创建.env.test文件：

MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=mcp_test
MYSQL_PASS=mcp_test_password
MYSQL_DB=mcp_test

更新 package.json

在 package.json 中添加以下脚本：

{
  "scripts": {
    "setup:test:db": "ts-node scripts/setup-test-db.ts",
    "pretest": "pnpm run setup:test:db",
    "test": "vitest run",
    "test:watch": "vitest",
    "test:coverage": "vitest run --coverage"
  }
}

执行测试

# 初始化测试环境
pnpm run setup:test:db

# 运行所有测试
pnpm test

故障排除

使用 Smithery 进行诊断

smithery status @benborla/mcp-server-mysql
smithery diagnose @benborla/mcp-server-mysql
smithery logs @benborla/mcp-server-mysql

常见问题

连接问题
- 确认 MySQL 服务器运行状态。
- 检查用户权限设置。
性能问题
- 调整数据库配置参数。
- 使用更高效的数据查询方式。
版本兼容性
- 确保 Node.js 和相关工具的版本与项目要求一致。

贡献指南

代码仓库访问

git clone https://github.com/yourusername/mcp-server-mysql.git

开发环境设置

克隆仓库：

git clone https://github.com/yourusername/mcp-server-mysql.git
cd mcp-server-mysql

安装依赖：

pnpm install

启动开发服务器：

pnpm dev

文档参考

官方文档：MCP 服务器文档
社区支持：GitHub 仓库

通过以上步骤，您可以轻松完成 MCP 服务器的安装、配置和测试工作。如果有任何问题，请随时参考官方文档或联系社区寻求帮助。

MySQL Read-Only