# @bilims/mcp-sqlserver 中文文档

规范地址：https://npmcn.com/package/%40bilims/mcp-sqlserver/

版本：2\.0\.3
npm 元数据更新时间：2025-10-09T11:58:11.727Z
中文译文更新时间：2026-11-08T02:24:57.410Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bilims/mcp-sqlserver
原文对照：https://npmcn.com/package/%40bilims/mcp-sqlserver/?lang=original
项目主页：https://github.com/bilims/mcp-sqlserver
源码仓库：https://github.com/bilims/mcp-sqlserver

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：141 kB，79 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：3 个
- 首次发布：2025-07-23T21:07:51.538Z
- 最新版本发布：2025-10-09T11:58:11.558Z
- 近 30 天下载量：4134（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 0 个）

## 中文简介

用于Microsoft SQL 服务器的只读模式上下文协议(MCP)服务器,使AI代理能够安全地探索和查询SQL 服务器数据库

## 安装

```sh
npm install @bilims/mcp-sqlserver
```

也可以使用：`pnpm add @bilims/mcp-sqlserver`、`yarn add @bilims/mcp-sqlserver`、`bun add @bilims/mcp-sqlserver`

## README

# MCP SQL 服务器

为Microsoft SQL Server提供只读的模型上下文协议(MCP)服务器,能使AI代理安全地探索并查询SQL Server数据库.

## 快速启动

### 步骤1:安装软件包

```bash
# Global installation (recommended)
npm install -g @bilims/mcp-sqlserver

# Verify installation
mcp-sqlserver --version
```

### 步骤2: 配置您的 SQL 服务器连接

选择您的 SQL 服务器类型并遵循配置 :

#### Azure SQL 数据库

```bash
export SQLSERVER_HOST="your-server.database.windows.net"
export SQLSERVER_USER="your-username"
export SQLSERVER_PASSWORD="your-password"
export SQLSERVER_DATABASE="your-database"
export SQLSERVER_ENCRYPT="true"
export SQLSERVER_TRUST_CERT="false"
```

#### 在线 SQL 服务器

```bash
export SQLSERVER_HOST="your-sql-server.company.com"
export SQLSERVER_USER="your-username"
export SQLSERVER_PASSWORD="your-password"
export SQLSERVER_DATABASE="your-database"
export SQLSERVER_ENCRYPT="true"
export SQLSERVER_TRUST_CERT="true"  # For self-signed certificates
```

#### 本地 SQL 服务器快递

```bash
export SQLSERVER_HOST="localhost\\SQLEXPRESS"
export SQLSERVER_USER="sa"
export SQLSERVER_PASSWORD="your-password"
export SQLSERVER_DATABASE="master"
export SQLSERVER_ENCRYPT="false"
export SQLSERVER_TRUST_CERT="true"
```

### 第3步:测试连接

```bash
# Test your configuration
mcp-sqlserver --help

# Quick connection test (press Ctrl+C to exit)
mcp-sqlserver
```

### 步骤4: 添加到 Claude 桌面

1.  **查找您的 Claude 桌面配置文件 :**
    
    -   **马科斯**数字 : `~/Library/Application Support/Claude/claude_desktop_config.json`
    -   **窗口**数字 : `%APPDATA%\Claude\claude_desktop_config.json`
2.  **添加 MCP 服务器配置 :**
    

```json
{
  "mcpServers": {
    "sqlserver": {
      "command": "mcp-sqlserver",
      "env": {
        "SQLSERVER_HOST": "your-server.database.windows.net",
        "SQLSERVER_USER": "your-username",
        "SQLSERVER_PASSWORD": "your-password",
        "SQLSERVER_DATABASE": "your-database",
        "SQLSERVER_ENCRYPT": "true",
        "SQLSERVER_TRUST_CERT": "false"
      }
    }
  }
}
```

3.  **重新启动 Claude 桌面**

### 第5步:开始探索!

在 Claude 桌面中尝试这些命令 :

-   `"Test the SQL Server connection"`
-   `"List all databases on the server"`
-   `"Show me the tables in [database name]"`
-   `"Describe the structure of the Users table"`
-   `"Show me foreign key relationships"`

## 特征

-   **QQ 只读操作**: 只允许 SELECT 查询, 并进行全面的安全验证
-   **· 舍马发现**: 探索数据库、表格、视图、关系和元数据
-   **数据勘探**: 执行内置限制和超时的安全查询
-   **企业化准备**: 为生产环境加密证书信任的连接
-   **安全第一**: 查询验证、SQL注射保护以及访问控制

## 可用工具

### Schema 发现

-   `list_databases` - 列出 SQL 服务器实例上的所有数据库
-   `list_tables` - 数据库或计划中的列表表格
-   `list_views` - 在数据库或计划中列出视图
-   `describe_table` - 获得详细的表格计划,包括列、数据类型和制约因素

### 关系分析

-   `get_foreign_keys` - 为表格获取外国关键关系
-   `get_table_stats` - 获得包括行数和大小信息在内的表格统计

### 数据勘探

-   `execute_query` - 执行只读的SELECT查询,并进行安全验证
-   `get_server_info` - 获得SQL 服务器版本、版本和配置细节

## Claude 桌面的共同命令

一旦您的 MCP 服务器配置完毕, 请尝试这些自然语言命令 :

### 获取开始命令

```
"Test the SQL Server connection"
"Show me server information"
"List all databases on this server"
"What tables are in the [database name] database?"
```

### 数据库勘探

```
"Describe the structure of the Users table"
"Show me foreign key relationships in this database"
"What are the largest tables by row count?"
"Give me a sample of data from the Orders table"
```

### 高级分析

```
"Help me understand the relationship between Orders and Customers"
"Show me all lookup tables in this database"
"What columns contain date/time information?"
"Find tables that might contain user authentication data"
```

### 自定义查询

```
"Run this query: SELECT TOP 10 * FROM Products WHERE Price > 100"
"Show me all customers created in the last 30 days"
"What are the different product categories in the database?"
```

## 安装

```bash
npm install
npm run build
```

## 配置

服务器使用环境变量配置 :

### 需求

-   `SQLSERVER_USER` - SQL 服务器用户名
-   `SQLSERVER_PASSWORD` - SQL 服务器密码

### 可选

-   `SQLSERVER_HOST` - 服务器主机名( 默认: localhost)
-   `SQLSERVER_DATABASE` - 默认数据库名称
-   `SQLSERVER_PORT` - 口号(默认:1433)
-   `SQLSERVER_ENCRYPT` - 启用加密( 默认: 真)
-   `SQLSERVER_TRUST_CERT` - 信任服务器证书( 默认: 真)
-   `SQLSERVER_CONNECTION_TIMEOUT` - 连接超时 ms( 默认: 3000)
-   `SQLSERVER_REQUEST_TIMEOUT` - 请求超时毫秒( 默认: 60000)
-   `SQLSERVER_MAX_ROWS` - 每个查询的最大行数( 默认: 1000)

## 使用量

### 环境变量

```bash
export SQLSERVER_HOST="your-server.database.windows.net"
export SQLSERVER_USER="your-username"
export SQLSERVER_PASSWORD="your-password"
export SQLSERVER_DATABASE="your-database"
export SQLSERVER_ENCRYPT="true"
export SQLSERVER_TRUST_CERT="true"
```

### 运行服务器

```bash
npm start
```

## 安装选项

### 备选办法1:全球安装(建议)

```bash
npm install -g @bilims/mcp-sqlserver
```

### 备选案文2:当地安装

```bash
npm install @bilims/mcp-sqlserver
npx mcp-sqlserver
```

### 选项3: Npx 运行( 无安装)

```bash
npx @bilims/mcp-sqlserver
```

## 整合实例

### 克劳德桌面

添加到您的 Claude 桌面配置( N)`claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "sqlserver": {
      "command": "mcp-sqlserver",
      "env": {
        "SQLSERVER_HOST": "your-server.database.windows.net",
        "SQLSERVER_USER": "your-username",
        "SQLSERVER_PASSWORD": "your-password",
        "SQLSERVER_DATABASE": "your-database"
      }
    }
  }
}
```

### Claude 代码 CLI

```bash
# Set environment variables
export SQLSERVER_HOST="your-server"
export SQLSERVER_USER="your-username"
export SQLSERVER_PASSWORD="your-password"

# Use with Claude Code
claude mcp add sqlserver mcp-sqlserver
```

### 带有 MCP 扩展的 VSCode

为 VSCode 安装 MCP 扩展并添加服务器配置 .

## 安全特性

### 查询验证

-   仅允许SELECT、SHOW、DESCRIBE和Explaine 语句
-   危险关键词综合黑名单(INSERT, UPDATE, DELETE, DROP等)
-   SQL 注射模式检测
-   自动查询消毒

### 连接安全

-   默认启用的 TLS/ SSL 加密
-   针对企业环境的服务器证书信任选项
-   连接集合和超时控制
-   配置请求超时

### 结果限制

-   每个查询的最大行限制( 可配置)
-   用于 SELECT 查询的自动 TOP 条款注入
-   查询执行时间跟踪
-   内存使用保护

## 示例查询

一旦连接,您可以通过您的 MCP 客户端使用工具 :

```typescript
// List all databases
await callTool("list_databases", {});

// List tables in a specific schema
await callTool("list_tables", { schema: "dbo" });

// Get table schema details
await callTool("describe_table", { 
  table_name: "Users", 
  schema: "dbo" 
});

// Execute a read-only query
await callTool("execute_query", { 
  query: "SELECT TOP 10 * FROM Users WHERE active = 1",
  limit: 10
});

// Get foreign key relationships
await callTool("get_foreign_keys", { 
  table_name: "Orders" 
});
```

## 发展

```bash
# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

# Run linting
npm run lint

# Run tests
npm test
```

## 解决问题

### 连接问题

1.  验证服务器主机名和端口
2.  检查加密/ 认证设置是否匹配您的 SQL 服务器配置
3.  确保用户有适当的阅读权限
4.  首先使用 SQL 服务器管理工作室进行测试连接

### 权限问题

用户账户至少需要:

-   `CONNECT` 允许进入数据库
-   `SELECT` 在您要查询的表格/视图上的权限
-   元数据查询访问系统

### 常见 SQL 服务器配置

#### Azure SQL 数据库

```bash
export SQLSERVER_HOST="your-server.database.windows.net"
export SQLSERVER_ENCRYPT="true"
export SQLSERVER_TRUST_CERT="false"
```

#### 现场 SQL 带有自签名证书的服务器

```bash
export SQLSERVER_HOST="sql-server.company.com"
export SQLSERVER_ENCRYPT="true" 
export SQLSERVER_TRUST_CERT="true"
```

## 许可证

麻省理工学院

## 捐款

1.  叉子存储器
2.  创建特性分支
3.  做你的改变
4.  在适用的情况下添加测试
5.  提交拉动请求

## 支助

关于议题和问题清单:

-   检查上面的故障排除区域
-   审查 SQL 服务器连接文档
-   确保MCP客户端兼容性

* * *

与该建筑 [示范背景协议SDK](https://github.com/modelcontextprotocol/typescript-sdk) 用于无缝AI集成.

## 常见问题

### @bilims/mcp-sqlserver 是什么？

用于Microsoft SQL 服务器的只读模式上下文协议\(MCP\)服务器,使AI代理能够安全地探索和查询SQL 服务器数据库

### 如何安装 @bilims/mcp-sqlserver？

在项目目录运行 npm install @bilims/mcp-sqlserver，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mcp-sqlserver，可以用 npx mcp-sqlserver 直接运行。

### @bilims/mcp-sqlserver 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bilims/mcp-sqlserver 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bilims/mcp-sqlserver 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bilims/mcp-sqlserver 可以商用吗？

@bilims/mcp-sqlserver 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bilims/mcp-sqlserver 的下载量有多少？

根据 npm 官方下载统计，@bilims/mcp-sqlserver 在 2026/10/08 – 2026/11/06 这 30 天内被下载 4,134 次，日均约 138 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bilims/mcp-sqlserver 还在维护吗？

最新版本 2\.0\.3 发布于 2025/10/09（1\.1 年前）；至今共发布 18 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/07/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。