MCP Server Tidb

🚀 mcp-server-tidb

An MCP server implementation for TiDB (serverless) database.

🚀 Quick Start

✨ Features

This project is an MCP server implementation for the TiDB (serverless) database, enabling seamless interaction with TiDB databases.

📦 Installation

Before installation, ensure you have the uv (Python package installation tool) installed.

# Clone the repository
git clone https://github.com/c4pt0r/mcp-server-tidb
cd mcp-server-tidb

# Use uv to create a virtual environment and install packages and dependencies
uv venv
uv pip install -e .

Configuration

Visit tidbcloud.com to create a free TiDB database cluster.

Configuration can be provided via environment variables or using a .env file:

• TIDB_HOST - TiDB host address, e.g., 'gateway01.us-east-1.prod.aws.tidbcloud.com'
• TIDB_PORT - TiDB port (default: 4000)
• TIDB_USERNAME - Database username, e.g., 'xxxxxxxxxx.'
• TIDB_PASSWORD - Database password
• TIDB_DATABASE - Database name, default is test

💻 Usage Examples

Running with Claude Desktop

To configure Claude Desktop, refer to HOWTO

claude_desktop_config.json:

{
  "mcpServers": {
      "tidb": {
          "command": "uv",
          "args": [
              "--directory",
              "/path/to/mcp-server-tidb",
              "run",
              "src/main.py"
          ]
      }
  }
}

If running mcp-server-tidb in WSL, claude_desktop_config.json should be as follows:

{
  "mcpServers": {
    "tool-with-env-vars": {
      "command": "wsl.exe",
      "args": [
        "bash",
        "-c",
        "/path/to/uv --directory /path/to/mcp-server-tidb run python src/main.py"
      ]
    }
  }
}