Tidb Server

🚀 TiDB MCP サーバー

TiDB 用に設計された Model Context Protocol (MCP) サーバーです。MCP ツールを通じて SELECT クエリを実行できます。

🚀 クイックスタート

TiDB MCP サーバーは、TiDB で SELECT クエリを実行するための MCP サーバーです。以下の手順に従って、サーバーをセットアップして使用しましょう。

✨ 主な機能

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

📦 インストール

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