AI导哈

TiDB查询服务

一个基于MCP协议的TiDB查询服务，支持通过MCP工具执行SELECT查询操作。

  • by l1806858547
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 l1806858547/tidb-server

使用说明

TiDB MCP服务器

TiDB的模型上下文协议（MCP）服务器，允许通过MCP工具执行SELECT查询。

特性

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

先决条件

  • Node.js 16+
  • TiDB实例

安装

通过Smithery安装

通过以下方式自动安装Claude Desktop的TiDB服务器 史密瑟里:

npx -y @smithery/cli install @l1806858547/tidb-server --client claude

通过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"

# Optional operation permissions (default: false)
export ALLOW_INSERT_OPERATION="false"  # Set to "true" to allow INSERT operations
export ALLOW_UPDATE_OPERATION="false"  # Set to "true" to allow UPDATE operations 
export ALLOW_DELETE_OPERATION="false"  # Set to "true" to allow DELETE operations

WARNING: Enabling these operations may expose your database to modification risks.
Only enable what you need and ensure proper access controls are in place.

用法

  1. 启动服务器：
tidb-server
  1. 添加到MCP配置（cline_MCP_settings.json）：
{
  "mcpServers": {
    "tidb-server": {
      "command": "npx",
      "args": ["-y", "tidb-mcp-server"], # Also adding the -y flag for consistency
      "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

许可证

麻省理工学院

相关 MCP