@yuuzu/sql Mcp

@yuuzu/sql-mcp

用于执行 MSSQL、PostgreSQL 和 SQLite 数据库操作的模型上下文协议（MCP）服务。

安装

# Using bunx (recommended)
bunx @yuuzu/sql-mcp

# Using npx
npx @yuuzu/sql-mcp

功能

• 支持多种数据库：MSSQL、PostgreSQL 和 SQLite（通过 better-sqlite3）
• 8 个数据库操作工具
• 三种查询模式：safe、write、full
• 高级身份验证：Windows 身份验证（MSSQL）、SSL 证书（PostgreSQL）

工具

工具	描述
connect-database	连接到数据库服务
disconnect	断开当前连接
connection-status	检查连接状态和查询模式
list-databases	列出服务上的所有数据库
switch-database	切换到其他数据库
list-tables	列出所有表和视图
describe-table	获取表结构详情
execute-query	执行 SQL 查询

查询模式

通过 SQL_MCP_MODE 环境变量控制查询权限：

模式	允许的操作	描述
safe（默认）	SELECT、WITH、EXPLAIN	只读，最安全
write	+ INSERT、UPDATE、DELETE	允许修改数据
full	+ CREATE、DROP、ALTER、TRUNCATE	完全访问权限，请谨慎使用

注意： 所有模式（包括 safe）均允许使用 PRAGMA 语句（例如 PRAGMA table_info(users)），因为这类语句是只读元数据查询，通常用于 SQLite。

# Example: Enable write mode
SQL_MCP_MODE=write bunx @yuuzu/sql-mcp

使用示例

Claude Desktop 配置

将以下内容添加到 claude_desktop_config.json：

{
    "mcpServers": {
        "sql-mcp": {
            "command": "bunx",
            "args": ["@yuuzu/sql-mcp"],
            "env": {
                "SQL_MCP_MODE": "safe"
            }
        }
    }
}

连接到 MSSQL

{
    "tool": "connect-database",
    "arguments": {
        "engine": "mssql",
        "server": "localhost",
        "port": 1433,
        "user": "sa",
        "password": "your_password",
        "database": "master"
    }
}

连接到 PostgreSQL

{
    "tool": "connect-database",
    "arguments": {
        "engine": "postgres",
        "server": "localhost",
        "port": 5432,
        "user": "postgres",
        "password": "your_password",
        "database": "postgres"
    }
}

使用 Windows 身份验证连接（MSSQL）

{
    "tool": "connect-database",
    "arguments": {
        "engine": "mssql",
        "server": "localhost",
        "windowsAuth": true
    }
}

使用 SSL 连接（PostgreSQL）

{
    "tool": "connect-database",
    "arguments": {
        "engine": "postgres",
        "server": "your-server.com",
        "user": "postgres",
        "password": "your_password",
        "ssl": {
            "rejectUnauthorized": true,
            "ca": "/path/to/ca-certificate.crt"
        }
    }
}

连接到 SQLite（文件）

{
    "tool": "connect-database",
    "arguments": {
        "engine": "sqlite",
        "filename": "/absolute/path/to/database.db"
    }
}

连接到 SQLite（内存）

适用于测试、演示或临时工作区。

{
    "tool": "connect-database",
    "arguments": {
        "engine": "sqlite",
        "filename": ":memory:"
    }
}

连接到 SQLite（只读）

{
    "tool": "connect-database",
    "arguments": {
        "engine": "sqlite",
        "filename": "/absolute/path/to/database.db",
        "readonly": true,
        "fileMustExist": true
    }
}

SQLite 运行时说明： SQLite 支持使用 better-sqlite3，这需要 Node.js。通过 bunx 运行时，MSSQL 和 PostgreSQL 可正常工作，但 SQLite 连接会返回明确错误，提示你改用 npx 或 node。

开发

# Install dependencies
bun install

# Run in development mode
bun run dev

# Run tests
bun test

# Run tests with coverage
bun test --coverage

# Build
bun run build

# Type check
bun run typecheck

发布

发布通过 GitHub Actions 自动执行。要创建新版本：

# Create and push a version tag
git tag v1.0.0
git push origin v1.0.0

此过程将：

1. 构建项目
2. 使用来源证明发布到 npm
3. 创建 GitHub Release，并自动生成发布说明

要求：在 GitHub 仓库设置中配置 NPM_TOKEN 密钥。

许可证

MIT