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 許可證。