mcpField
T
TiDB MCP Server

TiDB MCP Server

Local
github.com/l1806858547Databases0Updated 75w ago
Repository

About TiDB MCP Server

TiDB MCP Server lets MCP clients run SELECT queries against a TiDB database. It reads connection settings from environment variables and includes an optional setting for permitting INSERT operations.

Key features

  1. 01Run SELECT queries on TiDB
  2. 02Configure connections with environment variables
  3. 03Optionally enable INSERT operations

Use cases

  1. 01Query TiDB tables through MCP
  2. 02Allow INSERT operations when needed

MCP support

It exposes a TiDB query tool to MCP clients for SELECT queries. INSERT operations can be enabled through an environment variable.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
  "mcpServers": {
    "tidb-server": {
      "command": "npx",
      "args": [
        "-y",
        "tidb-mcp-server"
      ]
    }
  }
}
Run commandnpx -y tidb-mcp-server

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npmtidb-mcp-server

Tools

No tool list yet

Local servers expose tools only once running on your machine, and the maintainer has not provided a tool list.

Details

From the project README

TiDB MCP Server

smithery badge

A Model Context Protocol (MCP) server for TiDB that allows executing SELECT queries through MCP tools.

TiDB Server MCP server

Features

  • Execute SELECT queries on TiDB
  • Secure connection via environment variables
  • Lightweight and easy to use

Prerequisites

  • Node.js 16+
  • TiDB instance

Installation

Installing via Smithery

To install TiDB Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @l1806858547/tidb-server --client claude
Via npx
npx tidb-mcp-server
Global installation
npm install -g tidb-mcp-server
tidb-mcp-server

Configuration

Set these 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

WARNING: Enabling these operations may expose your database to modification risks.
Only enable what you need and ensure proper access controls are in place.

Usage

  1. Start the server:
tidb-server
  1. Add to MCP configuration (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"
      }
    }
  }
}
  1. 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 repo:
git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server
  1. Install dependencies:
npm install
  1. Build:
npm run build
  1. Run:
node build/index.js

License

MIT

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.