# @connorbritain/mssql-mcp-reader 中文文档

规范地址：https://npmcn.com/package/%40connorbritain/mssql-mcp-reader/

版本：0\.6\.1
npm 元数据更新时间：2026-08-04T21:23:14.216Z
中文译文更新时间：2026-11-10T15:45:40.388Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：8.1 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-12-04T08:00:24.118Z
- 最新版本发布：2026-08-04T21:23:14.084Z
- 近 30 天下载量：11466（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

只为Microsoft SQL 服务器读取的 MCP 服务器 - 不写操作的 schema 发现, 剖析和安全查询

## 安装

```sh
npm install @connorbritain/mssql-mcp-reader
```

也可以使用：`pnpm add @connorbritain/mssql-mcp-reader`、`yarn add @connorbritain/mssql-mcp-reader`、`bun add @connorbritain/mssql-mcp-reader`

## README

# MSSQL MCP 读取器

[![npm version](https://img.shields.io/npm/v/@connorbritain/mssql-mcp-reader.svg)](https://www.npmjs.com/package/@connorbritain/mssql-mcp-reader) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**Microsoft SQL 服务器的只读模式背景协议服务器.**

安全计划发现,剖析,查询 数据修改风险为零. 对于分析师,审计师, 和任何需要数据库 探索,没有写入.

## 建筑

这个包裹很薄的 [`@connorbritain/mssql-mcp-core`](https://github.com/ConnorBritain/mssql-mcp-core)它包含所有共享的逻辑、工具和治理特征。 包装器选择 `"reader"` 级别和出席核心会议的代表 `startMcpServer()` 函数。 这种设计可以:

-   **很难分离** 在一揽子层面——受监管企业能够保证某些建筑无法进行破坏性操作
-   **独立版本** ——每一级可按自己的发布周期单独发布
-   **清除审计线索** —— 说 `"we only allow mssql-mcp-reader in prod"` 是一个编译时间保证

核心库处理所有SQL服务器连接,工具发送,审计记录,以及治理执行.

* * *

## 软件包等级

| 软件包 | 无 | 工具 | 使用大小写 |
| --- | --- | --- | --- |
| **msql- mcp 读取器** (这个) | `@connorbritain/mssql-mcp-reader` | 14只读 | 分析员、审计员、安全勘探 |
| **[mssql- mcp 写作器](https://github.com/ConnorBritain/mssql-mcp-writer)** | `@connorbritain/mssql-mcp-writer` | 17 (阅读 + 数据操作) | 数据工程师, ETL 开发者 |
| **[msql- mcp 服务器](https://github.com/ConnorBritain/mssql-mcp-server)** | `@connorbritain/mssql-mcp-server` | 20(所有工具) | DBA, 完全管理员访问 |

* * *

**[配置构建器](https://connorbritain.github.io/mssql-mcp-config-builder/)** — 生成您的视觉向导 `mcp_config.json` 财务报告和审定财务报表 `environments.json` 文档.

* * *

## 包含的工具

| 类别 | 工具 |
| --- | --- |
| **发现** | `search_schema`, (中文(简体) ), `describe_table`, (中文(简体) ), `list_table`, (中文(简体) ), `list_databases`, (中文(简体) ), `list_environments` |
| **剖析** | `profile_table`, (中文(简体) ), `inspect_relationships`, (中文(简体) ), `inspect_dependencies`, (中文(简体) ), `explain_query` |
| **查询** | `read_data` (只有SELECT语) |
| **脚本** | `list_scripts`, (中文(简体) ), `run_script` (只读脚本) |
| **业务** | `test_connection`, (中文(简体) ), `validate_environment_config` |

**不包括:** `insert_data`, (中文(简体) ), `update_data`, (中文(简体) ), `delete_data`, (中文(简体) ), `create_table`, (中文(简体) ), `create_index`, (中文(简体) ), `drop_table`

* * *

## 快速启动

### 安装

```bash
npm install -g @connorbritain/mssql-mcp-reader@latest
```

### MCP 客户端配置

```json
{
  "mcpServers": {
    "mssql": {
      "command": "npx",
      "args": ["@connorbritain/mssql-mcp-reader@latest"],
      "env": {
        "SERVER_NAME": "127.0.0.1",
        "DATABASE_NAME": "mydb",
        "SQL_AUTH_MODE": "sql",
        "SQL_USERNAME": "readonly_user",
        "SQL_PASSWORD": "YourPassword123"
      }
    }
  }
}
```

* * *

## 配置

| 变量 | 需求 | 页:1 |
| --- | --- | --- |
| `SERVER_NAME` | 对 | SQL 服务器主机名/ IP |
| `DATABASE_NAME` | 对 | 目标数据库 |
| `SQL_AUTH_MODE` |  | `sql`, (中文(简体) ), `windows`,或 `aad` (默认 : `aad`(中文(简体) ) |
| `SQL_USERNAME` 编号 : `SQL_PASSWORD` |  | 所需经费 `sql`编号 :`windows` 模式 |
| `ENVIRONMENTS_CONFIG_PATH` |  | 多环境 JSON 配置路径 |
| `SCRIPTS_PATH` |  | 命名的 SQL 脚本目录路径 |
| `AUDIT_LOG_PATH` |  | 自定义审计日志路径 |

* * *

## 特征

MSSQL MCP 家族共享的所有软件包 :

-   **多种环境支助** - 以每个环境政策命名的数据库环境(prod、troduction、dev)
-   **治理控制** - 说吧 `allowedTools`, (中文(简体) ), `deniedTools`, (中文(简体) ), `allowedSchemas`, (中文(简体) ), `deniedSchemas`, (中文(简体) ), `requireApproval`
-   **审计记录** - JSON线路日志,附有会话ID和自动编辑
-   **秘密管理** - 说吧 `${secret:NAME}` 安全证书处理的占位符
-   **命名 SQL 脚本** - 与治理控制有关的预先核准的参数化查询

* * *

## 文档

主要储存库有完整的文件、配置实例和治理细节:

**[MSSQL MCP 服务器文档](https://github.com/ConnorBritain/mssql-mcp-server#readme)**

* * *

## 许可证

MIT许可证。 见 [自由主义](https://npmcn.com/package/%40connorbritain/mssql-mcp-reader/LICENSE) 详细情况.

* * *

**仓库 :** [https://github.com/康纳布里塔因/msql-mcp-reader 互联网档案馆的存檔,存档日期2013-12-22](https://github.com/ConnorBritain/mssql-mcp-reader) **问题:** [https://github.com/康纳布雷塔因/msql-mcp-reader/ 问题](https://github.com/ConnorBritain/mssql-mcp-reader/issues) **无 :** https://www.npmjs.com/package/@connorbritain/msql-mcp-reader 页面存档备份,存于互联网档案馆

## 常见问题

### @connorbritain/mssql-mcp-reader 是什么？

只为Microsoft SQL 服务器读取的 MCP 服务器 - 不写操作的 schema 发现, 剖析和安全查询

### 如何安装 @connorbritain/mssql-mcp-reader？

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

### @connorbritain/mssql-mcp-reader 支持 TypeScript 吗？

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

### @connorbritain/mssql-mcp-reader 支持 ESM 还是 CommonJS？

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

### @connorbritain/mssql-mcp-reader 可以商用吗？

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

### @connorbritain/mssql-mcp-reader 的下载量有多少？

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

### @connorbritain/mssql-mcp-reader 还在维护吗？

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