mcpField
T
TiDB MCP Server

TiDB MCP Server

本地服务
github.com/l1806858547数据库075 周前更新
代码仓库

关于 TiDB MCP Server

TiDB MCP Server 是面向 MCP 客户端的 TiDB 数据库服务，可执行 SELECT 查询。连接参数通过环境变量配置，并提供可选的 INSERT 权限设置。

主要功能

  1. 01执行 TiDB SELECT 查询
  2. 02通过环境变量配置连接
  3. 03可选启用 INSERT 操作

适用场景

  1. 01通过 MCP 查询 TiDB 表
  2. 02按需开放 INSERT 操作

MCP 相关

向 MCP 客户端提供 TiDB 查询工具，可执行 SELECT 查询；INSERT 操作可通过环境变量选择启用。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "tidb-server": {
      "command": "npx",
      "args": [
        "-y",
        "tidb-mcp-server"
      ]
    }
  }
}
启动命令npx -y tidb-mcp-server

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npmtidb-mcp-server

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具，维护者暂未提供工具列表。

详细介绍

TiDB MCP 服务

smithery badge

一个适用于 TiDB 的模型上下文协议（MCP）服务，可通过 MCP 工具执行 SELECT 查询。

TiDB Server MCP server

功能

  • 在 TiDB 上执行 SELECT 查询
  • 通过环境变量安全连接
  • 轻量且易于使用

前置条件

  • 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.

使用

  1. 启动服务：
tidb-server
  1. 添加到 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"
      }
    }
  }
}
  1. 使用 MCP 工具：
const result = await use_mcp_tool({
  server_name: 'tidb-server',
  tool_name: 'tidb_query', 
  arguments: {
    sql: 'SELECT * FROM your_table LIMIT 10'
  }
});

开发

  1. 克隆仓库：
git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server
  1. 安装依赖：
npm install
  1. 构建：
npm run build
  1. 运行：
node build/index.js

许可证

MIT

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。