@connorbritain/mssql-mcp-core

中文文档
0.7.0发布于 2026/08/05MITTypeScriptES Module近 30 天下载 1.3万

Shared core library for MSSQL MCP servers - tools, config, routing, and server harness

原始使用文档
文档目录15 节
  1. Architecture
  2. How Consumer Packages Use This Library
  3. Exports
  4. Server Entry Point
  5. Tool Classes
  6. Environment Management
  7. Audit Logging
  8. Secret Resolution
  9. Intent Routing
  10. Policy Middleware
  11. Toolset Helpers
  12. Types
  13. Build
  14. Related Packages
  15. License

@connorbritain/mssql-mcp-core

Shared core library for the MSSQL MCP tiered package family. This package provides every tool class, the MCP server harness, environment management, audit logging, secret resolution, intent routing, and policy enforcement middleware. Consumer packages (reader, writer, server) depend on this library and call startMcpServer() with a tier to get a fully configured MCP server.

Architecture

@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)

Each consumer package is a thin wrapper that passes its tier to startMcpServer(). All business logic, tool implementations, and governance infrastructure live here.

How Consumer Packages Use This Library

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

startMcpServer({ tier: "reader" });

The tier parameter controls which tools are registered with the MCP server:

TierToolsWhat it adds
reader14All read-only and schema discovery tools
writer17Reader tools + insert_data, update_data, delete_data
admin20Writer tools + create_table, create_index, drop_table

Config Builder — Visual wizard to generate configuration files for consumer packages.

Exports

Server Entry Point

import { startMcpServer } from "@connorbritain/mssql-mcp-core";
  • startMcpServer(config: McpServerConfig) — Initializes the MCP server over stdio for the given tier. Registers tools, applies wrapToolRun policy middleware to each, and starts listening.

Tool Classes

All 20 tool classes are exported individually:

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";

Each tool class implements the RunnableTool interface with name, description, inputSchema, and run(params).

Environment Management

import { EnvironmentManager, getEnvironmentManager } from "@connorbritain/mssql-mcp-core";
  • EnvironmentManager — Manages multi-environment configurations, connection pools, per-environment policies (readonly, allowedTools, deniedTools, maxRowsDefault, requireApproval, auditLevel, allowedSchemas, deniedSchemas, allowedColumns, deniedColumns), and secret resolution.
  • getEnvironmentManager() — Returns the singleton instance.

Audit Logging

import { AuditLogger, auditLogger } from "@connorbritain/mssql-mcp-core";
  • AuditLogger — Writes JSON Lines audit log entries with timestamps, tool names, arguments (sensitive fields auto-redacted), results, session ID, and environment name.
  • auditLogger — Singleton instance. Configured via AUDIT_LOG_PATH and AUDIT_LOGGING environment variables.

Secret Resolution

import {
  SecretResolver,
  createSecretResolver,
  validateDotenvPath,
  validateFileDirectory,
} from "@connorbritain/mssql-mcp-core";
  • SecretResolver — Resolves ${secret:NAME} placeholders in environment config values from environment variables, .env files, or external secret providers.
  • createSecretResolver(config) — Factory for SecretResolver instances.

Intent Routing

import { IntentRouter } from "@connorbritain/mssql-mcp-core";
  • IntentRouter — Routes natural language intents to the appropriate MCP tool using keyword matching and scoring. Used internally by startMcpServer.

Policy Middleware

import { wrapToolRun } from "@connorbritain/mssql-mcp-core";
  • wrapToolRun(tool, options) — Monkey-patches a tool's run() method to enforce per-environment policies (readonly, allowedTools, deniedTools, requireApproval), obtain a connection pool, inject environment context into tool arguments, and log all invocations to the audit logger.

Toolset Helpers

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() — Instantiates all 20 tool classes and returns them as a named object.
  • getReaderTools(t) — Returns the 14-tool array for the reader tier.
  • getWriterTools(t) — Returns the 17-tool array for the writer tier.
  • getAdminTools(t) — Returns the 20-tool array for the admin/server tier.
  • buildToolRegistry(t) — Returns the full routing config array used by IntentRouter.
  • READER_MUTATING_TOOLS — Empty Set<string> (reader has no mutating tools).
  • WRITER_MUTATING_TOOLS — Set of insert_data, delete_data, update_data.
  • ADMIN_MUTATING_TOOLS — Set of all write + DDL tool names.
  • READER_APPROVAL_EXEMPT — Set of tools that bypass requireApproval in the reader tier.
  • WRITER_APPROVAL_EXEMPT — Set of tools that bypass requireApproval in the writer tier.
  • ADMIN_APPROVAL_EXEMPT — Set of tools that bypass requireApproval in the admin tier.

Types

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

Build

npm install
npm run build   # Compiles TypeScript to dist/
npm run watch   # Watch mode for development
PackagenpmTier
Reader@connorbritain/mssql-mcp-readerRead-only
Writer@connorbritain/mssql-mcp-writerRead + write
Server@connorbritain/mssql-mcp-serverFull admin

License

MIT

版本与发布记录

@connorbritain/mssql-mcp-core 共发布 14 个版本,首次发布于 2026/02/18;过去 12 个月发布了 14 个版本。

版本发布日期距今
0.7.0latest2026/08/053 个月前
0.6.12026/08/053 个月前
0.6.02026/06/304 个月前
0.5.02026/02/188 个月前
0.3.02026/02/188 个月前
0.2.22026/02/188 个月前

关于 @connorbritain/mssql-mcp-core 的常见问题

@connorbritain/mssql-mcp-core 是什么?

Shared core library for MSSQL MCP servers - tools, config, routing, and server harness

如何安装 @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 和提交记录判断。