TiDB MCP Server

TiDB MCP サーバー

MCP ツールを通じて SELECT クエリを実行できる、TiDB 用の Model Context Protocol（MCP）サーバーです。

機能

• TiDB で SELECT クエリを実行します
• 環境変数を使用した安全な接続
• 軽量で使いやすい

前提条件

• Node.js 16+
• TiDB インスタンス

インストール

Smithery 経由でのインストール

Smithery 経由で TiDB Server を Claude Desktop に自動インストールするには：

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

2. 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"
      }
    }
  }
}

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