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

Prerequisites

- Node.js 16+
- TiDB instance

Installation

$3

``bash
npx @l1806858547/tidb-server
`

$3

`bash
npm install -g @l1806858547/tidb-server
tidb-server
`

Configuration

Set these environment variables before running:

`bash
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:
`bash
tidb-server
`

2. Add to MCP configuration (cline_mcp_settings.json):
`json
{
"mcpServers": {
"tidb-server": {
"command": "npx",
"args": ["@l1806858547/tidb-server"],
"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:
`javascript
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:
`bash
git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server
`

2. Install dependencies:
`bash
npm install
`

3. Build:
`bash
npm run build
`

4. Run:
`bash
node build/index.js
``

License

MIT