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

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

版本：0\.7\.0
npm 元数据更新时间：2026-08-04T21:22:20.265Z
中文译文更新时间：2026-11-10T15:45:16.919Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：628 kB，198 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-02-17T21:34:24.305Z
- 最新版本发布：2026-08-04T21:22:20.123Z
- 近 30 天下载量：13186（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

MSSQL MCP 服务器共享核心库 - 工具,配置,路由,和服务器使用

## 安装

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

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

## README

# @connorbritain/msql-mcp-core (英语)

MSSQL MCP分级包家族共享核心库. 这个软件包提供每个工具类,MCP服务器的利用,环境管理,审计记录,秘密解析,意图路由,以及政策执行中间软件. 消费者软件包(阅读器、作家、服务器)依赖于此库和呼叫 `startMcpServer()` 带有一个级,以获得一个配置齐全的MCP服务器.

## 建筑

```
@connorbritain/mssql-mcp-core
        |
        |-- @connorbritain/mssql-mcp-reader  (14 read-only tools)
        |-- @connorbritain/mssql-mcp-writer  (17 tools: reader + INSERT/UPDATE/DELETE)
        |-- @connorbritain/mssql-mcp-server  (20 tools: writer + CREATE TABLE/INDEX, DROP TABLE)
```

每一个消费者包件都是薄薄的包装纸,通过它的分层 `startMcpServer()`所有业务逻辑、工具实施和治理基础设施都在这里.

## 消费者软件包如何使用此库

```ts
import { startMcpServer } from "@connorbritain/mssql-mcp-core";

startMcpServer({ tier: "reader" });
```

这个 `tier` 参数控制在 MCP 服务器上注册的工具 :

| 级别 | 工具 | 上面写的 |
| --- | --- | --- |
| `reader` | 页:1 | 所有只读和计划发现工具 |
| `writer` | 页:1 | 阅读工具 + `insert_data`, (中文(简体) ), `update_data`, (中文(简体) ), `delete_data` |
| `admin` | 20国 | 写作工具+ `create_table`, (中文(简体) ), `create_index`, (中文(简体) ), `drop_table` |

**[配置构建器](https://connorbritain.github.io/mssql-mcp-config-builder/)** ——视觉向导为消费者包生成配置文件.

## 出口

### 服务器入口

```ts
import { startMcpServer } from "@connorbritain/mssql-mcp-core";
```

-   **`startMcpServer(config: McpServerConfig)`** ——初始化 MCP 服务器为给定等级的 stdio. 注册工具,应用 `wrapToolRun` 策略中间软件,然后开始听.

### 工具类

所有20个工具类别都单独导出:

```ts
import {
  // Read-only (Reader tier)
  ReadDataTool,
  ListTableTool,
  ListDatabasesTool,
  ListEnvironmentsTool,
  ValidateEnvironmentConfigTool,
  ListScriptsTool,
  RunScriptTool,
  DescribeTableTool,
  SearchSchemaTool,
  ProfileTableTool,
  RelationshipInspectorTool,
  InspectDependenciesTool,
  TestConnectionTool,
  ExplainQueryTool,

  // Write (Writer tier adds these)
  InsertDataTool,
  DeleteDataTool,
  UpdateDataTool,

  // Admin/DDL (Server tier adds these)
  CreateTableTool,
  CreateIndexTool,
  DropTableTool,
} from "@connorbritain/mssql-mcp-core";
```

每个工具类执行 `RunnableTool` 接口 `name`, (中文(简体) ), `description`, (中文(简体) ), `inputSchema`,以及 `run(params)`。 。 。 .

### 环境管理

```ts
import { EnvironmentManager, getEnvironmentManager } from "@connorbritain/mssql-mcp-core";
```

-   **`EnvironmentManager`** ——管理多环境配置,连接池,每个环境政策(只读,允许的Tools,拒绝的Tools,最大RowsDefault,需要的Approval,审计级,允许的Schemas,拒绝的Schemas,允许的Columns,拒绝的Columns),以及秘密解析.
-   **`getEnvironmentManager()`** ——返回单子实例.

### 审计日志

```ts
import { AuditLogger, auditLogger } from "@connorbritain/mssql-mcp-core";
```

-   **`AuditLogger`** ——将JSON行的审计日志条目写入时间戳,工具名,参数(敏感字段自动编辑),结果,会话ID,以及环境名.
-   **`auditLogger`** - Singleton的例子。 通过配置 `AUDIT_LOG_PATH` 财务报告和审定财务报表 `AUDIT_LOGGING` 环境变量.

### 秘密解析

```ts
import {
  SecretResolver,
  createSecretResolver,
  validateDotenvPath,
  validateFileDirectory,
} from "@connorbritain/mssql-mcp-core";
```

-   **`SecretResolver`** - 决定 `${secret:NAME}` 环境变量配置值中的占位符, `.env` 文件,或外部秘密提供者.
-   **`createSecretResolver(config)`** - 工厂 `SecretResolver` 实例.

### 有意路线

```ts
import { IntentRouter } from "@connorbritain/mssql-mcp-core";
```

-   **`IntentRouter`** ——用关键词匹配和打分的方式将自然语言意图通向适当的MCP工具. 内部使用 `startMcpServer`。 。 。 .

### 策略中间软件

```ts
import { wrapToolRun } from "@connorbritain/mssql-mcp-core";
```

-   **`wrapToolRun(tool, options)`** - 猴子拍出一个工具 `run()` 执行每个环境政策的方法(只读、允许Tools、拒绝使用Tools、需要Approval),获得连接池,在工具参数中输入环境上下文,并将所有引用记录到审计日志.

### 工具夹帮助工具

```ts
import {
  createAllToolInstances,
  getReaderTools,
  getWriterTools,
  getAdminTools,
  buildToolRegistry,
  READER_MUTATING_TOOLS,
  WRITER_MUTATING_TOOLS,
  ADMIN_MUTATING_TOOLS,
  READER_APPROVAL_EXEMPT,
  WRITER_APPROVAL_EXEMPT,
  ADMIN_APPROVAL_EXEMPT,
} from "@connorbritain/mssql-mcp-core";
```

-   **`createAllToolInstances()`** ——将全部20个工具类进行校正,并作为被命名的对象返回.
-   **`getReaderTools(t)`** ——返回阅读层的14个工具阵列.
-   **`getWriterTools(t)`** ——返回写入层的17个工具阵列.
-   **`getAdminTools(t)`** 返回管理员/服务器级的20个工具阵列.
-   **`buildToolRegistry(t)`** ——返回全程配置数组 `IntentRouter`。 。 。 .
-   **`READER_MUTATING_TOOLS`** - 空的 `Set<string>` (阅读器没有变异工具).
-   **`WRITER_MUTATING_TOOLS`** —— 说 `Set` 联 合 国 `insert_data`, (中文(简体) ), `delete_data`, (中文(简体) ), `update_data`。 。 。 .
-   **`ADMIN_MUTATING_TOOLS`** —— 说 `Set` 所有写入 + DDL 工具名称.
-   **`READER_APPROVAL_EXEMPT`** —— 说 `Set` 绕行工具 `requireApproval` 在阅读层.
-   **`WRITER_APPROVAL_EXEMPT`** —— 说 `Set` 绕行工具 `requireApproval` 在写作层.
-   **`ADMIN_APPROVAL_EXEMPT`** —— 说 `Set` 绕行工具 `requireApproval` 在行政级别.

### 类型

```ts
import type {
  TierLevel,
  McpServerConfig,
  IntentCategory,
  RunnableTool,
  ToolRoutingConfig,
  IntentRouterOptions,
  RoutingCandidate,
  RouteParams,
  RouteResult,
  WrapToolRunOptions,
  EnvironmentConfig,
  EnvironmentsConfig,
  AccessLevel,
  AuditLogEntry,
  AuditLevel,
  SecretsConfig,
  SecretProviderConfig,
} from "@connorbritain/mssql-mcp-core";
```

## 构建

```bash
npm install
npm run build   # Compiles TypeScript to dist/
npm run watch   # Watch mode for development
```

## 相关软件包

| 软件包 | 无 | 级别 |
| --- | --- | --- |
| 阅读器 | `@connorbritain/mssql-mcp-reader` | 只读 |
| 作家 | `@connorbritain/mssql-mcp-writer` | 读取并写入 |
| 服务器 | `@connorbritain/mssql-mcp-server` | 完全管理员 |

## 许可证

麻省理工学院

## 常见问题

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

MSSQL MCP 服务器共享核心库 - 工具,配置,路由,和服务器使用

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

在项目目录运行 npm install @connorbritain/mssql-mcp-core，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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