TiDB MCP サーバー

TiDB MCP サーバーは、自然言語の指示を使用して TiDB データベースと対話できるオープンソースツールです。

MCP と TiDB MCP サーバーの理解

モデルコンテキストプロトコル（MCP）は、LLM と外部ツール間の通信を標準化するプロトコルです。

MCP はクライアントサーバーアーキテクチャを採用しており、ホストアプリケーションが複数の外部サーバーに接続できます。

ホスト: MCP サーバーへの接続を開始する、Claude Desktop などの AI 搭載アプリケーションや、Cursor などの IDE。
クライアント: 個々の MCP サーバーと 1 対 1 の接続を確立するホストアプリケーション内に埋め込まれたコンポーネント。
サーバー: 外部システムと対話するためのツール、コンテキスト、プロンプトをクライアントに提供するTiDB MCP サーバーなどの外部サービス。

TiDB MCP サーバーは、MCP クライアントが TiDB データベースと対話するためのツールとコンテキストを提供する MCP 互換サーバーです。

前提条件

始める前に、次のものがあることを確認してください。

MCP 互換クライアント: たとえば、カーソルまたはクロード・デスクトップ。
Python (>=3.10) と uv : Python (3.10以降) とuvインストールされていることを確認してください。4 インストールガイド手順に従ってuvインストールしてください。
TiDB Cloud Starter クラスター: TiDB Cloudに無料の TiDB クラスターを作成できます。

サポートされているMCPクライアント

特定の MCP クライアントで TiDB MCP サーバーを使用する詳細な例については、次のガイドを参照してください。

上記のリストに MCP クライアントが含まれていない場合は、以下のセットアップ手順に従ってください。

セットアップ手順

TiDB MCP サーバーは、MCP クライアントと統合するための 2 つのモードをサポートしています。

標準入出力（STDIO）モード（デフォルト）
サーバー送信イベント（SSE）モード

TiDB MCP サーバーはデフォルトで STDIO モードを使用するため、事前にスタンドアロンサーバーを起動する必要はありません。

MCP クライアントで TiDB MCP サーバーを設定するには、いずれかのモードを選択できます。

STDIOモード

STDIO モードを使用して MCP クライアントで TiDB MCP サーバーを設定するには、次の手順を実行します。

MCPサーバーを構成する方法については、MCP クライアントのドキュメントを参照してください。
TiDB Cloudクラスターページに移動し、クラスターの概要ページに移動します。
クラスターの概要ページで[接続]をクリックして、接続パラメータを取得します。

AI アプリケーションの構成ファイルのmcpServersセクションで、接続パラメータを使用して TiDB MCP サーバーを構成します。

MCP 構成ファイルの例:

{
  "mcpServers": {
    "TiDB": {
      "command": "uvx --from pytidb[mcp] tidb-mcp-server",
      "env": {
        "TIDB_HOST": "localhost",
        "TIDB_PORT": "4000",
        "TIDB_USERNAME": "root",
        "TIDB_PASSWORD": "",
        "TIDB_DATABASE": "test"
      }
    }
  }
}

サーバー送信イベント（SSE）モード

SSE モードを使用して MCP クライアントに TiDB MCP サーバーを設定するには、次の手順を実行します。

MCPサーバーを構成する方法については、MCP クライアントのドキュメントを参照してください。
TiDB Cloudクラスターページに移動してクラスターを選択します。
接続パラメータを取得するには、クラスターページで[接続]をクリックします。

接続パラメータを含む.envファイルを作成します。

例.envファイル:

cat > .env <<EOF
TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
TIDB_PORT=4000
TIDB_USERNAME={prefix}.root
TIDB_PASSWORD={password}
TIDB_DATABASE=test
EOF

--transport sseオプションで TiDB MCP サーバーを起動します。
```
uvx --from "pytidb[mcp]" tidb-mcp-server --transport sse
```
AI アプリケーションの構成ファイルのmcpServersセクションにTiDB MCPサーバー構成を追加します。
```
{
  "mcpServers": {
    "TiDB": {
      "url": "http://localhost:8000/sse"
    }
  }
}
```

サポートされているアクション（ツール）

TiDB MCPサーバーは、MCPクライアントに以下のアクション（ツール）を提供します。これらを使用することで、自然言語による指示でTiDBプロジェクトやデータベースと対話できます。

データベース管理

show_databases - TiDB クラスター内のすべてのデータベースを表示します
- username : データベースユーザー名（文字列、オプション）
- password : データベースパスワード（文字列、オプション）
switch_database - 特定のデータベースに切り替える
- db_name : 切り替え先のデータベース名（文字列、必須）
- username : データベースユーザー名（文字列、オプション）
- password : データベースパスワード（文字列、オプション）
show_tables - 現在のデータベース内のすべてのテーブルを表示します

SQLクエリと実行

db_query - 読み取り専用SQLクエリを実行する
- sql_stmt : SQLクエリステートメント（文字列、必須）
db_execute - SQL文（DMLまたはDDL）を実行する
- sql_stmts : 単一のSQL文またはSQL文の配列（文字列または配列、必須）

ユーザー管理

db_create_user - 新しいデータベースユーザーを作成する
- username : 新しいユーザーの名前（文字列、必須）
- password : 新しいユーザーのパスワード（文字列、必須）
db_remove_user - 既存のデータベースユーザーを削除する
- username : 削除するユーザーの名前（文字列、必須）