Skip to main content
Glama
by l1806858547

TiDB MCP Server

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

Features

  • Execute SELECT queries on TiDB

  • Secure connection via environment variables

  • Lightweight and easy to use

Related MCP server: SQLite MCP Server

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

One-click Deploy
A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/l1806858547/tidb-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server