数据库性能监控工具

TiDB Insight MCP是一款用于TiDB数据库分析和性能监控的自定义Model Context Protocol (MCP) 服务器,提供SQL查询执行、表分析、数据库统计和查询基准测试等功能。

  • by RyutoYoda
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 RyutoYoda/tidb-insight-mcp

使用说明

TiDB Insight MCP(注:MCP在此处可能代表某种特定的模块、组件或概念,但根据上下文无法确定具体含义,因此直接保留原英文缩写。若需具体翻译,需更多上下文信息。)

这是用于分析和监控TiDB数据库的自定义模型上下文协议(MCP)服务器。

功能

  • 执行SQL查询执行任意SQL查询并附带执行时间测量选项
  • 表格分析获取包括大小、行数、索引统计在内的详细表信息
  • 数据库统计全面的数据库指标和信息
  • 查询基准测试多次执行查询以测量平均执行时间和性能

可用工具

1. execute_sql

在TiDB数据库中执行SQL查询,并可选择进行时间测量。

参数:

  • query (必填):要执行的SQL查询
  • measure_time (可选):是否测量执行时间

2. get_table_info

获取包括尺寸和结构在内的表格详细信息。

参数:

  • table_name (可选):特定的表名,或留空以表示所有表

3. get_database_stats

获取全面的数据库统计信息和连接信息。

4. benchmark_query

执行SQL查询的性能基准测试。

参数:

  • query (必填):要进行基准测试的SQL查询
  • iterations (可选):重复次数(默认:5、最大:50)

安装

  1. 克隆此存储库:
git clone https://github.com/yourusername/tidb-insight-mcp.git
cd tidb-insight-mcp
  1. 设置环境变量:
cp .env.example .env
# .envファイルを編集してTiDBの接続情報を入力
  1. 执行安装脚本:
./setup.sh

设定

请在Claude Desktop的设置文件中添加以下内容:

{
  "mcpServers": {
    "tidb-insight": {
      "command": "/path/to/tidb-insight-mcp/venv/bin/python",
      "args": ["/path/to/tidb-insight-mcp/server.py"],
      "env": {
        "TIDB_HOST": "your-tidb-host",
        "TIDB_PORT": "4000",
        "TIDB_USERNAME": "your-username",
        "TIDB_PASSWORD": "your-password",
        "TIDB_DATABASE": "your-database"
      }
    }
  }
}

环境变量

  • TIDB_HOSTTiDB服务器的主机名
  • TIDB_PORTTiDB服务器的端口号(默认:4000)
  • TIDB_USERNAME数据库用户名
  • TIDB_PASSWORD数据库密码
  • TIDB_DATABASE数据库名

必要条件

  • Python 3.10+(或译为:Python 3.10及以上版本)
  • TiDB Cloud或自托管TiDB实例
  • Claude Desktop(中文可译为“克劳德桌面版”或根据具体语境简化为“克劳德桌面”,但通常直接保留原名以体现品牌特色)

许可证

麻省理工学院许可证(MIT License)