Mysql Local MCP

SQL MCP Server

面向 Claude Desktop / Claude Code 的 MCP 数据库服务，支持 MySQL 和 SQLite，内置表白名单、操作限制和 SSH 隧道。

目录

• 亮点
• 使用场景
• 效果预览
• 工作原理
• 快速开始
• Claude Desktop / Claude Code 集成
• 配置参考
• 支持的工具
• 使用示例
• 安全注意事项
• 本地开发

✨ 亮点

• 零安装 — npx 即可直接运行，无需全局安装
• 双数据库 — 同时支持 MySQL 和 SQLite
• SSH 隧道 — 内置 MySQL + SSH 隧道支持，轻松连接远程数据库
• 权限控制 — 支持表白名单与操作白名单，双重防护
• 开箱即用 — 兼容 Claude Desktop 配置格式

使用场景

1. 本地开发，批量插入测试数据

让 LLM 通过 db_insert 往开发库或 SQLite 文件里批量写入测试数据，快速准备联调环境、演示数据或回归测试样本。

2. 联调时快速理解数据库结构

让 LLM 先执行 db_connect 和 db_describe_schema，快速了解有哪些表、字段类型和约束，减少手动翻表结构的时间。

3. 排查脏数据或线上问题

在只开放 connect,schema,query 的前提下，让 LLM 帮你查询异常记录、比对状态字段、定位重复数据或缺失数据。

4. 做项目统计、报表和运营分析

适合统计提交人数、重复提交、逾期提交、订单汇总、用户活跃度等场景，让 LLM 把查询结果整理成可读报告。

5. 通过 SSH 隧道安全访问远程 MySQL

当数据库只能从堡垒机或跳板机访问时，可以结合 SSH 隧道能力，把远程数据库以受控方式接给 Claude 使用。

6. 分权限开放数据库能力

你可以按环境控制能力范围：开发环境开放 insert/delete，生产环境只开放 connect/schema/query，降低误操作风险。

效果预览

下面两张图分别展示了典型使用流程和最终输出效果：

工具调用过程

LLM 先按 MCP 协议连接数据库、识别表结构，再分步发起查询。

统计结果输出

查询完成后，LLM 会基于工具返回结果生成结构化报告。

🔍 工作原理

ALLOWED_METHODS 双层校验

ALLOWED_METHODS 通过以下机制控制 LLM 可调用的操作：

1. 工具隐藏 — 服务启动时解析白名单，ListTools 阶段只向 LLM 暴露被允许的工具
2. 执行拦截 — CallTool 执行时再次校验，未授权方法直接返回错误，不执行任何数据库操作

# 示例：LLM 只能查询，不能写入
ALLOWED_METHODS='connect,schema,query' npx -y @kk-2004/sql-mcp-server \
  --mode=sqlite \
  --db-path=/path/to/database.db \
  --tables='*'

LLM 如何操作数据库？

LLM 本身不会直接连接数据库，而是通过 MCP 工具间接操作：

用户提问
  └─▶ LLM 决策（调用哪个工具、传什么参数）
        └─▶ MCP 客户端发起工具调用
              └─▶ 服务端：权限检查 → 参数校验 → 执行 SQL
                    └─▶ 返回 JSON 结果给 LLM
                          └─▶ LLM 生成最终回复

服务端返回给 LLM 的格式示例：

{
  "content": [
    {
      "type": "text",
      "text": "{\"rowCount\": 2, \"rows\": [...]}"
    }
  ]
}

🚀 快速开始

方式一：npx（推荐）

SQLite

npx -y @kk-2004/sql-mcp-server \
  --mode=sqlite \
  --db-path=/path/to/database.db \
  --tables='*'

SQLite + 环境变量

DB_MODE=sqlite \
SQLITE_DB_PATH=/path/to/database.db \
ALLOWED_TABLES='users,orders' \
ALLOWED_METHODS='connect,schema,query' \
DEFAULT_LIMIT=50 \
MAX_LIMIT=500 \
npx -y @kk-2004/sql-mcp-server

MySQL

npx -y @kk-2004/sql-mcp-server \
  --mysql-host=127.0.0.1 \
  --mysql-port=3306 \
  --mysql-user=root \
  --mysql-password=password \
  --mysql-database=mydb \
  --tables='*'

MySQL + 连接串

npx -y @kk-2004/sql-mcp-server \
  --mysql-url='mysql://root:password@127.0.0.1:3306/mydb' \
  --tables='users,orders' \
  --methods='connect,schema,query,insert'

MySQL + SSH 隧道（私钥路径）

npx -y @kk-2004/sql-mcp-server \
  --ssh-enabled=true \
  --ssh-host=jump.example.com \
  --ssh-port=22 \
  --ssh-user=ubuntu \
  --ssh-private-key-path=/Users/you/.ssh/id_rsa \
  --mysql-host=127.0.0.1 \
  --mysql-port=3306 \
  --mysql-user=root \
  --mysql-password=password \
  --mysql-database=mydb \
  --tables='*'

MySQL + SSH 隧道（私钥内容）

npx -y @kk-2004/sql-mcp-server \
  --ssh-enabled=true \
  --ssh-host=jump.example.com \
  --ssh-user=ubuntu \
  --ssh-private-key='-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----' \
  --ssh-passphrase='your-passphrase' \
  --mysql-host=127.0.0.1 \
  --mysql-user=root \
  --mysql-password=db-password \
  --mysql-database=mydb \
  --tables='*'

方式二：本地安装

# npm
npm install @kk-2004/sql-mcp-server

# pnpm
pnpm add @kk-2004/sql-mcp-server

# yarn
yarn add @kk-2004/sql-mcp-server

# bun
bun add @kk-2004/sql-mcp-server

安装后运行：

# 通过本地二进制
./node_modules/.bin/sql-mcp-server --mode=sqlite --db-path=/path/to/database.db --tables='*'

# 通过 npm exec
npm exec sql-mcp-server -- --mode=sqlite --db-path=/path/to/database.db --tables='*'

# 通过 node
node ./node_modules/@kk-2004/sql-mcp-server/server.js --mode=sqlite --db-path=/path/to/database.db --tables='*'

🔌 集成

以下配置可直接放入 Claude Desktop 配置文件。

macOS / Linux 可以直接使用 npx。 Windows 原生环境建议使用 cmd /c npx ...，避免 Claude 启动 MCP 服务时找不到 npx。

SQLite

{
  "mcpServers": {
    "sql-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@kk-2004/sql-mcp-server",
        "--mode=sqlite",
        "--db-path=/path/to/database.db",
        "--tables=*"
      ]
    }
  }
}

Windows（npx 启动示例）

{
  "mcpServers": {
    "sql-mcp": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "@kk-2004/sql-mcp-server",
        "--mode=sqlite",
        "--db-path=C:\\path\\to\\database.db",
        "--tables=*"
      ]
    }
  }
}

MySQL

{
  "mcpServers": {
    "sql-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@kk-2004/sql-mcp-server",
        "--mysql-host=127.0.0.1",
        "--mysql-port=3306",
        "--mysql-user=root",
        "--mysql-password=password",
        "--mysql-database=mydb",
        "--tables=users,orders"
      ]
    }
  }
}

MySQL + SSH 隧道

{
  "mcpServers": {
    "sql-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@kk-2004/sql-mcp-server",
        "--ssh-enabled=true",
        "--ssh-host=jump.example.com",
        "--ssh-port=22",
        "--ssh-user=ubuntu",
        "--ssh-private-key-path=/Users/you/.ssh/id_rsa",
        "--mysql-host=127.0.0.1",
        "--mysql-port=3306",
        "--mysql-user=root",
        "--mysql-password=password",
        "--mysql-database=mydb",
        "--tables=*"
      ]
    }
  }
}

使用环境变量（推荐用于敏感信息）

{
  "mcpServers": {
    "sql-mcp": {
      "command": "npx",
      "args": ["-y", "@kk-2004/sql-mcp-server"],
      "env": {
        "DB_MODE": "mysql",
        "MYSQL_HOST": "127.0.0.1",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "root",
        "MYSQL_PASSWORD": "your-password",
        "MYSQL_DATABASE": "mydb",
        "ALLOWED_TABLES": "users,orders",
        "ALLOWED_METHODS": "connect,schema,query,insert,delete",
        "DEFAULT_LIMIT": "100",
        "MAX_LIMIT": "1000",
        "ALLOW_EMPTY_DELETE": "false"
      }
    }
  }
}

本地安装版配置

方式 A：直接调用本地二进制

{
  "mcpServers": {
    "sql-mcp": {
      "command": "/Users/you/project/node_modules/.bin/sql-mcp-server",
      "args": ["--mode=sqlite", "--db-path=/path/to/database.db", "--tables=*"]
    }
  }
}

方式 B：通过 node 调用入口文件

{
  "mcpServers": {
    "sql-mcp": {
      "command": "node",
      "args": [
        "/Users/you/project/node_modules/@kk-2004/sql-mcp-server/server.js",
        "--mode=mysql",
        "--mysql-host=127.0.0.1",
        "--mysql-user=root",
        "--mysql-database=mydb",
        "--tables=users,orders"
      ]
    }
  }
}

⚙️ 配置参考

优先级：CLI 参数 > 环境变量 提示：使用 MYSQL_URL 时，建议将数据库名写入连接串，如 mysql://root:password@127.0.0.1:3306/mydb

通用参数

MySQL 参数

SQLite 参数

SSH 隧道参数

🛠️ 支持的工具

📖 使用示例

db_connect

请求

{}

响应

{
  "connected": true,
  "database": "mydb",
  "tables": ["users", "orders"]
}

db_describe_schema

查询单表

{ "table": "users" }

查询所有允许的表

{}

db_query

{
  "table": "users",
  "columns": ["id", "name", "email"],
  "where": { "status": "active" },
  "orderBy": { "column": "created_at", "direction": "DESC" },
  "limit": 10
}

db_insert

{
  "table": "users",
  "data": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}

db_delete

{
  "table": "users",
  "where": { "id": 123 }
}

🔒 安全注意事项

• 标识符校验 — 表名和字段名均通过合法性校验，防止注入
• 参数化查询 — 所有条件值使用参数化查询，杜绝 SQL 注入
• 强制 WHERE — DELETE 默认要求携带 WHERE 条件，可通过 ALLOW_EMPTY_DELETE=true 关闭
• 结果限制 — 查询结果有最大行数限制，防止大量数据泄露

🧑‍💻 本地开发

git clone https://github.com/kK-2004/sql-mcp.git
cd sql-mcp
npm install
node server.js --mode=sqlite --db-path=/path/to/database.db --tables='*'