Tidb Server

🚀 TiDB MCP 服务器

TiDB MCP 服务器是专为 TiDB 设计的 Model Context Protocol (MCP) 服务器，它允许用户借助 MCP 工具执行 SELECT 查询，为数据库操作提供了便捷途径。

🚀 快速开始

TiDB MCP 服务器可让你轻松在 TiDB 上执行 SELECT 查询。使用前，需确保满足先决条件，并完成安装与配置。

✨ 主要特性

• 查询执行：能够在 TiDB 上执行 SELECT 查询。
• 安全连接：支持通过环境变量实现安全连接。
• 轻量易用：整体设计轻量级，使用起来简单便捷。

📦 安装指南

使用 npx

npx tidb-mcp-server

全局安装

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

💻 使用示例

基础用法

启动服务器

tidb-server

添加到 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"
      }
    }
  }
}

使用 MCP 工具

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

开发流程

克隆仓库

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

安装依赖项

npm install

构建

npm run build

运行

node build/index.js

📚 详细文档

配置说明

在运行服务器之前，需要设置以下环境变量：

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 操作

⚠️ 重要提示

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

📄 许可证

本项目采用 MIT 许可证。