MySQL MCP Server

MySQL MCP 服务

这是一个功能强大的数据库管理工具，基于 FastMCP 构建，为管理 SQLite 数据库提供交互式界面。本项目包含服务端组件和客户端界面，可轻松执行数据库操作。

功能

• 列出数据库中的所有表
• 获取任意表的详细架构信息
• 执行 SQL 查询并以格式化结果显示
• 用于数据库操作的交互式客户端界面

前置条件

• Python 3.8 或更高版本
• pip（Python 包安装程序）

设置

1. 克隆代码库：

git clone [email protected]:sajithamma/mysql-mcp-server.git
cd mysql-mcp-server

2. 创建并激活虚拟环境：

# Create virtual environment
python3.12 -m venv venv

# Activate virtual environment
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

3. 安装依赖项：

pip install -r requirements.txt

4. 运行 fixture 以创建数据库：

python sqlite_fixture.py

项目结构

本项目由两个主要组件构成：

1. mcpserver.py - MCP 服务实现
2. mcpclient.py - 客户端界面

服务端组件

服务端提供以下工具：

@mcp.tool()
def list_tables() -> List[str]:
    """List all tables in the SQLite database."""
    # Implementation details...

@mcp.tool()
def describe_table(table_name: str) -> Dict[str, Any]:
    """Get the schema information for a specific table."""
    # Implementation details...

@mcp.tool()
def run_query(query: str) -> Dict[str, Any]:
    """Execute a SQL query and return the results."""
    # Implementation details...

客户端组件

客户端提供用于数据库操作的交互式界面：

async def main():
    server = MCPServerSse(
        name="SQLite Database Manager",
        params={
            "url": "http://localhost:8000/sse",
        },
    )
    # Client implementation...

运行应用程序

1. 启动 MCP 服务：

fastmcp run mcpserver.py:mcp --transport sse --host 127.0.0.1 --port 8000

2. 在另一个终端中运行客户端：

python mcpclient.py

使用方法

服务端和客户端都运行后，即可使用自然语言命令与数据库交互。客户端支持以下操作：

1. 列出数据库中的所有表
2. 获取任意表的详细架构信息
3. 执行 SQL 查询以检索或修改数据

命令示例：

• “显示数据库中的所有表”
• “描述 users 表的结构”
• “运行查询以选取 users 表中的所有记录”

环境变量

在项目根目录中创建 .env 文件，并添加以下变量：

# Add any required environment variables here

贡献

欢迎贡献！欢迎提交 Pull Request。

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。