@connorbritain/mssql-mcp-reader

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

Read-only MCP server for Microsoft SQL Server - schema discovery, profiling, and safe querying without write operations

原始使用文档
文档目录10 节
  1. Architecture
  2. Package Tiers
  3. Tools Included
  4. Quick Start
  5. Install
  6. MCP Client Configuration
  7. Configuration
  8. Features
  9. Documentation
  10. License

MSSQL MCP Reader

npm version License: MIT

Read-only Model Context Protocol server for Microsoft SQL Server.

Safe schema discovery, profiling, and querying with zero risk of data modification. Ideal for analysts, auditors, and anyone who needs database exploration without write access.

Architecture

This package is a thin wrapper around @connorbritain/mssql-mcp-core, which contains all shared logic, tools, and governance features. The wrapper selects the "reader" tier and delegates to the core's startMcpServer() function. This design enables:

  • Hard separation at the package level — regulated enterprises can guarantee that certain builds physically cannot perform destructive operations
  • Independent versioning — each tier can be published separately with its own release cycle
  • Clear audit trail — "we only allow mssql-mcp-reader in prod" is a compile-time guarantee

The core library handles all SQL Server connections, tool dispatch, audit logging, and governance enforcement.


Package Tiers

PackagenpmToolsUse Case
mssql-mcp-reader (this)@connorbritain/mssql-mcp-reader14 read-onlyAnalysts, auditors, safe exploration
mssql-mcp-writer@connorbritain/mssql-mcp-writer17 (reader + data ops)Data engineers, ETL developers
mssql-mcp-server@connorbritain/mssql-mcp-server20 (all tools)DBAs, full admin access

Config Builder — Visual wizard to generate your mcp_config.json and environments.json files.


Tools Included

CategoryTools
Discoverysearch_schema, describe_table, list_table, list_databases, list_environments
Profilingprofile_table, inspect_relationships, inspect_dependencies, explain_query
Queryingread_data (SELECT only)
Scriptslist_scripts, run_script (readonly scripts only)
Operationstest_connection, validate_environment_config

Not included: insert_data, update_data, delete_data, create_table, create_index, drop_table


Quick Start

Install

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

MCP Client Configuration

{
  "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"
      }
    }
  }
}

Configuration

VariableRequiredNotes
SERVER_NAMEYesSQL Server hostname/IP
DATABASE_NAMEYesTarget database
SQL_AUTH_MODEsql, windows, or aad (default: aad)
SQL_USERNAME / SQL_PASSWORDRequired for sql/windows modes
ENVIRONMENTS_CONFIG_PATHPath to multi-environment JSON config
SCRIPTS_PATHPath to named SQL scripts directory
AUDIT_LOG_PATHCustom audit log path

Features

All packages in the MSSQL MCP family share:

  • Multi-environment support - Named database environments (prod, staging, dev) with per-environment policies
  • Governance controls - allowedTools, deniedTools, allowedSchemas, deniedSchemas, requireApproval
  • Audit logging - JSON Lines logs with session IDs and auto-redaction
  • Secret management - ${secret:NAME} placeholders for secure credential handling
  • Named SQL scripts - Pre-approved parameterized queries with governance controls

Documentation

Full documentation, configuration examples, and governance details are available in the main repository:

MSSQL MCP Server Documentation


License

MIT License. See LICENSE for details.


Repository: https://github.com/ConnorBritain/mssql-mcp-reader Issues: https://github.com/ConnorBritain/mssql-mcp-reader/issues npm: https://www.npmjs.com/package/@connorbritain/mssql-mcp-reader

版本与发布记录

@connorbritain/mssql-mcp-reader 共发布 11 个版本,首次发布于 2025/12/04;过去 12 个月发布了 11 个版本。

版本发布日期距今
0.6.1latest2026/08/053 个月前
0.6.02026/08/053 个月前
0.5.12026/08/053 个月前
0.5.02026/06/304 个月前
0.4.22026/02/188 个月前
0.4.12026/02/188 个月前

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

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

Read-only MCP server for Microsoft SQL Server - schema discovery, profiling, and safe querying without write operations

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