TiDB MCP 服务器
TiDB 的模型上下文协议 (MCP) 服务器,允许通过 MCP 工具执行 SELECT 查询。
特征
在 TiDB 上执行 SELECT 查询
通过环境变量实现安全连接
轻巧易用
Related MCP server: SQLite MCP Server
先决条件
Node.js 16+
TiDB 实例
安装
通过 Smithery 安装
通过Smithery自动为 Claude Desktop 安装 TiDB Server:
npx -y @smithery/cli install @l1806858547/tidb-server --client claude
通过 npx
npx tidb-mcp-server
全局安装
npm install -g tidb-mcp-server
tidb-mcp-server
配置
运行之前设置这些环境变量:
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.
用法
启动服务器:
tidb-server
添加到 MCP 配置(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"
}
}
}
}
使用 MCP 工具:
const result = await use_mcp_tool({
server_name: 'tidb-server',
tool_name: 'tidb_query',
arguments: {
sql: 'SELECT * FROM your_table LIMIT 10'
}
});
发展
克隆仓库:
git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server
安装依赖项:
npm install
建造:
npm run build
跑步:
node build/index.js
执照
麻省理工学院