MySQL交互工具

基于FastMCP的Python项目,提供与MySQL数据库交互的工具,支持服务器与客户端通信,数据查询和分析。

  • by hoonzinope
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 hoonzinope/pymcp-mysql

使用说明

pymcp

pymcp这是一个基于FastMCP的Python项目,提供了与MySQL数据库交互的工具。该项目支持服务器与客户端之间的通信,并可通过各种工具查询和分析数据。

项目结构

pymcp/
├── client.py          # 클라이언트 코드
├── main.py            # 서버 실행 코드
├── src/
│   ├── env.py         # 로컬 환경 설정
│   ├── env_dev.py     # 개발 환경 설정
│   ├── mcp_instance.py # MCP 인스턴스 초기화
│   ├── mysql_tool.py  # MySQL 관련 도구 정의
├── pyproject.toml     # 프로젝트 메타데이터 및 의존성
├── requirements.txt   # 의존성 목록
└── README.md          # 프로젝트 설명

安装及运行

1. 安装依赖项

需要 Python 3.13 或更高版本。要安装依赖项,请运行以下命令:

pip install -r requirements.txt

2. 运行服务器

要运行服务器 main.py请运行以下内容:

python main.py

服务器基本上 0.0.0.0:8080在那里运行。

3. 客户端运行

要运行客户端 client.py运行它:

python client.py

客户端可以与服务器通信,执行MySQL查询或查看工具列表。

环境设置

根据环境的不同,MySQL 设置会有所不同地应用:

  • 本地环境根据上面的信息,执行如下指令: src/env.py
  • 开发环境根据上面的信息,执行如下指令: src/env_dev.py

环境是 APP_ENV 可以通过环境变量来设置。默认值为 local是。

export APP_ENV=dev  # 개발 환경 설정

提供的工具

服务器提供的工具如下:

  1. describe_tools
    列出可用工具并说明其使用方法。

  2. query_mysql(sql: str)
    执行给定的SQL查询并返回结果。
    示例: query_mysql("SELECT * FROM users LIMIT 10;")

主要文件说明

main.py

这是运行服务器的入口点。初始化MCP实例并注册工具后,运行服务器。

client.py

这是与服务器交互的客户端代码。可以连接到服务器并调用工具。

src/mysql_tool.py

这是定义MySQL相关工具的文件。 query_mysql可以通过这样的工具执行SQL查询。

src/env.py 及 src/env_dev.py

这是一个包含MySQL连接设置的环境变量文件。根据环境加载适当的设置。