TiDB MCP Server

基本能力

产品定位

TiDB MCP Server 是一个专门为 TiDB 设计的 MCP 服务器，主要用于通过 MCP 工具执行 SELECT 查询。

核心功能

• 执行 TiDB 上的 SELECT 查询
• 通过环境变量实现安全连接
• 轻量级且易于使用

适用场景

• 需要从 TiDB 数据库中查询数据的场景
• 需要轻量级接口与 TiDB 交互的场景
• 需要通过 MCP 工具集成 TiDB 查询的场景

工具列表

• tidb_query: 用于执行 SELECT 查询的工具

常见问题解答

• 如何启用 INSERT/UPDATE/DELETE 操作？ 通过设置环境变量 ALLOW_INSERT_OPERATION、ALLOW_UPDATE_OPERATION 和 ALLOW_DELETE_OPERATION 为 "true" 来启用这些操作。但需注意安全风险。

使用教程

使用依赖

• Node.js 16+
• TiDB 实例

安装教程

通过 npx 安装

npx tidb-mcp-server

全局安装

npm install -g tidb-mcp-server
tidb-mcp-server

配置

设置以下环境变量：

export TIDB_HOST="your_tidb_host"
export TIDB_PORT="your_tidb_port" 
export TIDB_USER="your_username"
export TIDB_PASS="your_password"
export TIDB_DB="your_database"

# 可选操作权限（默认: false）
export ALLOW_INSERT_OPERATION="false"
export ALLOW_UPDATE_OPERATION="false"
export ALLOW_DELETE_OPERATION="false"

使用

1. 启动服务器：

tidb-server

1. 添加到 MCP 配置（cline_mcp_settings.json）：

{
  "mcpServers": {
    "tidb-server": {
      "command": "npx",
      "args": ["-y", "tidb-mcp-server"],
      "env": {
        "TIDB_HOST": "your_tidb_host",
        "TIDB_PORT": "your_tidb_port",
        "TIDB_USER": "your_username",
        "TIDB_PASS": "your_password",
        "TIDB_DB": "your_database"
      }
    }
  }
}

1. 使用 MCP 工具：

const result = await use_mcp_tool({
  server_name: 'tidb-server',
  tool_name: 'tidb_query', 
  arguments: {
    sql: 'SELECT * FROM your_table LIMIT 10'
  }
});

调试方式

1. 克隆仓库：

git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server

1. 安装依赖：

npm install

1. 构建：

npm run build

1. 运行：

node build/index.js

许可证

该项目遵循 MIT 开源许可条款。