MySQL服务器实现

一个用于MCP框架的MySQL服务器实现,允许通过MCP协议与MySQL数据库交互,支持SQL执行、表/资源列表和模式检索。

  • by Shubham9975
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 shubham9975/mcp-mysql-server

使用说明

mcps-mysql服务器

存储库: https://github.com/Shubham9975/mcp-mysql-server.git

MCP(模型控制协议)框架的MySQL服务器实现。此服务器允许您通过MCP协议与MySQL数据库交互,从而启用SQL执行、表/资源列表和模式检索。

特性

  • 执行SQL查询
  • 将MySQL表列为资源
  • 获取表架构
  • 可通过环境变量进行配置
  • 支持各种MySQL字符集和排序规则

安装

来自PyPI

pip install mcps-mysql-server

来源(GitHub)

git clone https://github.com/Shubham9975/mcp-mysql-server.git
cd mcp-mysql-server
pip install .

或用于开发(可编辑)模式:

pip install -e .

配置

设置以下环境变量(连接所需):

  • MYSQL_HOST:MySQL服务器主机(默认:“localhost”)
  • MYSQL_PORT:MySQL服务器端口(默认:3306)
  • MYSQL_USER:MySQL用户名(必需的)
  • MYSQL_PASSWORD:MySQL密码(必需的)
  • MYSQL_DATABASE:MySQL数据库名称(必需的)
  • MYSQL_CHARSET:MySQL字符集(默认值:“utf8mb4”)
  • MYSQL_COLLATION:MySQL排序规则(默认:“utf8mb4_unicode_ci”)
  • MYSQL_SQL_MODE:MySQL SQL模式(默认:“传统”)

例子:

export MYSQL_USER="your_user"
export MYSQL_PASSWORD="your_password"
export MYSQL_DATABASE="your_database"

用法

设置环境变量后,启动服务器:

mcps-mysql-server

MCP/Claude/Cursor集成

将其添加到您的MCP配置中(例如。, ~/.cursor/mcp.json):

{
  "mcpServers": {
    "mysql-server": {
      "command": "mcps-mysql-server",
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "your_user",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

可用工具

execute_sql

在MySQL服务器上执行SQL查询。

例子:

SELECT * FROM users LIMIT 10;

可用资源

  • mysql://tables --列出数据库中的所有表。
  • mysql://table/{table_name} --获取特定表的架构。例子: mysql://table/users

发展

  • 所有主代码都在 mysql_server/ 目录。
  • CLI入口点在中实现 mcp_mysql_server/launcher.py.
  • 使用 pip install -e . 用于开发期间的可编辑安装。
  • 如果添加测试,请将其放置在 tests/ 目录。

项目结构

mcp-mysql-server/
├── mcp_mysql_server/
│   ├── __init__.py
│   └── launcher.py         # CLI entry point: defines main()
├── mysql_server/
│   ├── __init__.py
│   └── server.py           # Main server logic
├── pyproject.toml          # Build system, metadata, CLI entry point
├── README.md               # Documentation
├── LICENSE                 # License file
└── .gitignore              # Git ignore rules

故障排除

  • 未找到命令:
    确保Python脚本目录在PATH中。
    在Windows上,这通常是 C:\Users\<YourUser>\AppData\Local\Programs\Python\Python3x\Scripts.

许可证

MIT许可证