Tidb Server

🚀 TiDB MCP Server

A Model Context Protocol (MCP) server designed for TiDB, allowing SELECT queries to be executed via MCP tools.

🚀 Quick Start

The TiDB MCP Server enables you to execute SELECT queries on TiDB through MCP tools. Follow the steps below to get started.

✨ Features

• Execute SELECT queries on TiDB.
• Establish secure connections via environment variables.
• Lightweight and easy to use.

📦 Installation

Using npx

npx tidb-mcp-server

Global Installation

npm install -g tidb-mcp-server
tidb-mcp-server

📚 Documentation

Prerequisites

• Node.js 16+
• A TiDB instance

Configuration

Set the following environment variables before running:

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

Note: Enabling these operations may expose your database to modification risks.
Only enable them when necessary and ensure appropriate access control measures are in place.

Usage

1. Start the server:

tidb-server

2. Add to MCP configuration (cline_mcp_settings.json):

{
  "mcpServers": {
    "tidb-server": {
      "command": "npx",
      "args": ["-y", "tidb-mcp-server"], # Add 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. Use the MCP tool:

const result = await use_mcp_tool({
  server_name: 'tidb-server',
  tool_name: 'tidb_query', 
  arguments: {
    sql: 'SELECT * FROM your_table LIMIT 10'
  }
});

Development

1. Clone the repository:

git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Run the project:

node build/index.js

📄 License

This project is licensed under the MIT license.