Servidor MCP de TiDB

Un servidor de Protocolo de Contexto de Modelo (MCP) para TiDB que permite ejecutar consultas SELECT a través de herramientas MCP.

Características

Ejecutar consultas SELECT en TiDB
Conexión segura a través de variables de entorno
Ligero y fácil de usar.

Prerrequisitos

Node.js 16+
Instancia de TiDB

Instalación

Vía npx

npx tidb-mcp-server

Instalación global

npm install -g tidb-mcp-server
tidb-mcp-server

Configuración

Establezca estas variables de entorno antes de ejecutar:

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.

Uso

Iniciar el servidor:

tidb-server

Agregar a la configuración de 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"
      }
    }
  }
}

Utilice la herramienta MCP:

const result = await use_mcp_tool({
  server_name: 'tidb-server',
  tool_name: 'tidb_query', 
  arguments: {
    sql: 'SELECT * FROM your_table LIMIT 10'
  }
});

Desarrollo

Clonar el repositorio:

git clone https://github.com/l1806858547/tidb-server.git
cd tidb-server

Instalar dependencias:

npm install

Construir:

npm run build

Correr:

node build/index.js

Licencia

Instituto Tecnológico de Massachusetts (MIT)