TiDB MCP 服务器

一个为 TiDB 设计的 Model Context Protocol (MCP) 服务器，允许通过 MCP 工具执行 SELECT 查询。

功能

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

先决条件

• 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"  # 设置为 "true" 允许 INSERT 操作
export ALLOW_UPDATE_OPERATION="false"  # 设置为 "true" 允许 UPDATE 操作 
export ALLOW_DELETE_OPERATION="false"  # 设置为 "true" 允许 DELETE 操作

注意：启用这些操作可能会使您的数据库面临修改风险。
仅在需要时启用，并确保适当的访问控制措施到位。

使用方法

1. 启动服务器：

tidb-server

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

{
  "mcpServers": {
    "tidb-server": {
      "command": "npx",
      "args": ["-y", "tidb-mcp-server"], # 同时添加 -y 标志以保持一致性
      "env": {
        "TIDB_HOST": "your_tidb_host",
        "TIDB_PORT": "your_tidb_port",
        "TIDB_USER": "your_username",
        "TIDB_PASS": "your_password",
        "TIDB_DB": "your_database"
      }
    }
  }
}

3. 使用 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

2. 安装依赖项：

npm install

3. 构建：

npm run build

4. 运行：

node build/index.js

许可证

MIT