SQL Server MCP

io.github.cvelasquez由 GitHub 账号 cvelasquez 发布v3.3.0更新于 Oct 24, 2026

MCP server for DBAs running dozens of SQL Server instances: grouped connections, plans, indexes

已验证STDIO仅桌面数据库开发者工具

概览

AI 生成的概览

本地 MCP 服务器,让 AI 助手通过一个分组连接文件查询和检查多个 SQL Server 实例。

可以做什么
列出并重新加载分组的 SQL Server 连接,每个响应标明来源连接,并提示导致连接被禁用的缺失环境变量。执行 SQL 查询,支持行数上限、截断提示、CSV 输出、服务器消息和多个结果集。查看表结构、索引和存储过程源码。获取执行计划而不实际执行查询。
适用场景
适合管理多个客户或环境下大量 SQL Server 实例的 DBA 和顾问,用一个助手条目代替每个数据库一个条目。适用于表结构对比、索引审查、存储过程与执行计划分析,以及密码轮换后检查连接。
运行要求
通过 npx 以 stdio 在本地运行,需要 Node.js 22 或更高版本。需要 connections.json 文件(可用 --init 创建),或通过 MSSQL_MCP_CONNECTIONS_JSON 内联传入连接 JSON;也可用 MSSQL_MCP_CONNECTIONS 指定路径。需要能访问 SQL Server 主机的网络,以及数据库登录或域/Entra ID 凭据。
安装前请注意
连接文件保存数据库凭据,应排除在版本控制之外、限制文件权限,并优先使用环境变量引用而非明文密码。query 工具会执行助手编写的任意 SQL,readOnly 只是防护栏而非安全边界,应使用最小权限登录。内联的 MSSQL_MCP_CONNECTIONS_JSON 变量会把凭据放进助手配置中。

安装

在 SourceWeft 中

  1. 打开 控制台中的 SQL Server MCP,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

SQL Server MCP for people who manage dozens of instances

[npm] [CI] [License: MIT] [Node.js] [MCP]

One MCP entry, every SQL Server you administer. Connections live in a single connections.json, grouped by client or environment, hot-reloaded without restarting your AI agent — plus execution plans, index audits and stored-procedure analysis.

Built for DBAs and consultants, not for a demo against a single localhost database.

Install

Add this to your AI agent's MCP configuration:

json
{  "mcpServers": {    "sqlserver": {      "command": "npx",      "args": ["-y", "@cevelas/mcp-sqlserver"]    }  }}

Then create your connections file and restart the agent:

bash
npx -y @cevelas/mcp-sqlserver --init

That writes ~/.mcp-sqlserver/connections.json from a commented template. Edit it, and ask your agent to "list all SQL Server connections".

Needs Node.js 22 or newer.

Where each agent keeps its MCP config
AgentConfig file
Claude Desktop (Windows)%APPDATA%\Claude\claude_desktop_config.json
Claude Desktop (macOS)~/Library/Application Support/Claude/claude_desktop_config.json
Claude Codeclaude mcp add sqlserver -- npx -y @cevelas/mcp-sqlserver
VS Code / Copilot.vscode/mcp.json
Cursor~/.cursor/mcp.json

Any MCP-compatible agent works — ChatGPT, Gemini, Copilot, Cline, Zed and others all take the same command / args pair.

Why this one

Most SQL Server MCP servers take a single connection string. That is fine for one database. It falls apart when you administer thirty across eight clients, because every instance needs its own entry in the agent config, its own credentials, and its own restart when something changes.

Single-DSN serversThis one
Instances per MCP entry1all of them
Organised by client or environment—connectionGroup
Add or change a connectionedit agent config, restartedit a file, reload_connections
Which server answered?you assumein every response's metadata
Beyond SELECT—execution plans, index layout, SP source
Read-only safety rail—"readOnly": true per connection

Connections

json
{  "connections": [    {      "name": "acme-prod",      "connectionGroup": "Acme Corp",      "description": "Production - head office",      "server": "192.168.1.10\\SQLEXPRESS",      "database": "AcmeDB_Prod",      "user": "app_reader",      "password": "${env:ACME_PROD_PASSWORD}",      "port": 1433,      "encrypt": true,      "trustServerCertificate": false,      "readOnly": true    }  ]}
FieldRequiredNotes
nameyesUnique; this is what you say to the agent
serveryesHostname, IP, or host\instance
connectionGroupnoClient, project or environment. Groups the listing
descriptionnoShown in list_connections and in every response
databasenoDefaults to the login's default database
user, passwordnoOmit for domain or Entra ID auth
portnoDefaults to 1433
encrypt, trustServerCertificatenoencrypt defaults to true
readOnlynoRejects writing statements — see below

Anything else you put here is passed straight to mssql, so requestTimeout, connectionTimeout, pool, authentication and a nested options object all work.

Keeping passwords out of the file

Any string may reference an environment variable:

json
"password": "${env:ACME_PROD_PASSWORD}"

A connection that references a variable you have not set is disabled, and list_connections names both the connection and the missing variable. Leaving the literal in place would only move the failure to connect time, where it arrives as Login failed for user and tells you nothing.

You can also skip the file entirely and pass the whole thing through the agent config, which keeps credentials in one place with the rest of your MCP secrets:

json
{  "mcpServers": {    "sqlserver": {      "command": "npx",      "args": ["-y", "@cevelas/mcp-sqlserver"],      "env": {        "MSSQL_MCP_CONNECTIONS_JSON": "{\"connections\":[{\"name\":\"prod\",\"server\":\"10.0.0.1\",\"database\":\"App\",\"user\":\"reader\",\"password\":\"...\"}]}"      }    }  }}

Where the file is looked for

In order, first hit wins:

  1. --connections <path>
  2. $MSSQL_MCP_CONNECTIONS — a path
  3. $MSSQL_MCP_CONNECTIONS_JSON — the JSON itself, inline
  4. ./connections.json in the working directory
  5. ~/.mcp-sqlserver/connections.json
  6. connections.json next to the installed package

A path given explicitly via 1 or 2 that does not exist is an error — the server will not quietly fall back to a different file and talk to the wrong database.

Checking every connection at once

bash
npx -y @cevelas/mcp-sqlserver --check

Connects to every entry in parallel, runs SELECT 1, and lists which ones fail and why. Exits non-zero if any did, so it works in a scheduled task. Useful after a password rotation, or before blaming the agent.

Windows domain and Entra ID authentication

The bundled tedious driver supports NTLM and the Entra ID (Azure AD) family. Add domain for NTLM:

json
{  "name": "warehouse",  "server": "dwh.corp.local",  "database": "DWH",  "domain": "CORP",  "user": "svc_analytics",  "password": "${env:DWH_PASSWORD}"}
json
{  "name": "azure-sql",  "server": "myserver.database.windows.net",  "database": "reporting",  "encrypt": true,  "authentication": {    "type": "azure-active-directory-password",    "options": { "userName": "${env:AZURE_USER}", "password": "${env:AZURE_PASSWORD}" }  }}

Fully integrated auth — a trusted connection with no password at all — needs the native msnodesqlv8 driver, which is not bundled because it would break the one-line install on machines without a build toolchain. NTLM with an explicit service account is the supported path.

Tools

ToolArgumentsWhat it does
list_connections—Every connection, grouped
reload_connections—Re-read the file, drop open pools
queryconnection, sql, maxRows?, format?Run a query
get_schemaconnection, table?Columns, types, nullability, defaults
get_indexesconnection, tableIndexes, types, key and included columns
get_execution_planconnection, sqlSHOWPLAN_XML — the plan, without running the query
get_stored_procedureconnection, nameSource of a stored procedure

Every response carries the connection it came from:

json
{  "metadata": {    "connection": "acme-prod",    "connectionGroup": "Acme Corp",    "description": "Production - head office",    "server": "192.168.1.10\\SQLEXPRESS",    "database": "AcmeDB_Prod"  },  "data": [ ... ]}

With thirty connections in play, that line is what tells you the answer came from the client you meant.

Query results that fit in a context window

An agent that runs SELECT * FROM Orders does not need four million rows, and neither does its context window.

  • Row cap. query returns at most 1000 rows across all result sets. maxRows changes that, up to 10000. When the cap is hit the query is cancelled on the server, not trimmed afterwards.
  • A truncated result says so, first. The response opens with "truncated": true and a note stating that more rows exist, that the total is unknown, and how to get it. It sits before the rows on purpose: a 10000-row response runs to hundreds of KB, and a client that cuts long output keeps the beginning. An agent must never conclude "the table has 10000 rows" from a capped result. Asking for more than 10000 is not an error — the cap is lowered to 10000, and if rows were left out the note says what was asked for.
  • format: "csv". JSON repeats every column name on every row. With csv the response is one JSON header line with the metadata, a blank line, then the rows. NULL is an empty cell and an empty string is "", so the two stay distinguishable.
  • Server messages. PRINT output and SET STATISTICS IO, TIME ON results come back in messages, so the agent can read logical reads and CPU time instead of guessing.
  • Every result set. A batch with several SELECTs returns them all in recordsets. data is still the first one.
  • Binary columns come back as hex (0x8f3a...), truncated after 64 bytes, instead of a JSON array with one number per byte.

rowCount is always present; truncated, messages and recordsets only appear when they have something to say. Responses are compact JSON.

What this gets you

Things that are tedious by hand and become one sentence to the agent:

  • "Why is this stored procedure slow?" — get_stored_procedure for the source, get_execution_plan for the plan, get_indexes for what is missing.
  • "Compare the Orders schema between acme-prod and acme-qa" — get_schema on both, agent diffs them.
  • "Which indexes on this table are never covering anything?" — get_indexes plus the queries you care about.
  • "I added a client to connections.json" — reload_connections, no restart.

Read-only connections

json
"readOnly": true

Rejects INSERT, UPDATE, DELETE, MERGE, DROP, TRUNCATE, ALTER, CREATE, GRANT, EXEC, BACKUP, DBCC, OPENQUERY, DISABLE/ENABLE and friends before the query leaves your machine. It also requires the batch to start with something that reads — SELECT, WITH, DECLARE, SET, IF and so on — because T-SQL lets you call a procedure without EXEC, and sp_rename 'dbo.Users','Users_old' contains no blocked keyword at all.

String literals, comments and bracketed identifiers are ignored, so WHERE note = 'please delete this', SELECT [delete] FROM [Audit] and DECLARE @Create DATETIME all pass. get_execution_plan still works, because SHOWPLAN_XML returns the plan without executing anything.

Anything other than an explicit false turns the guard on — a hand-written "readOnly": "false" locks the connection down rather than silently opening it, and says so in list_connections.

This is a guard rail, not a security boundary. It stops an agent from "helpfully" fixing a row in production. It will not stop someone determined to write. The real protection is a SQL login that only has db_datareader:

sql
CREATE LOGIN mcp_reader WITH PASSWORD = '...';CREATE USER mcp_reader FOR LOGIN mcp_reader;ALTER ROLE db_datareader ADD MEMBER mcp_reader;GRANT VIEW DEFINITION TO mcp_reader;   -- for get_stored_procedureGRANT SHOWPLAN TO mcp_reader;          -- for get_execution_plan

Use both.

Security notes

  • connections.json holds credentials. Keep it out of version control — the bundled .gitignore covers connections*.json.
  • Prefer ${env:VAR} over literal passwords.
  • Give each connection the least privilege it needs. Do not use sa.
  • Restrict file permissions: icacls connections.json /inheritance:r /grant:r "%USERNAME%:F" on Windows, chmod 600 connections.json elsewhere.
  • The query tool runs whatever SQL the agent writes. That is the point of the tool — treat the connection's permissions as the boundary, not the tool.

Web UI

web/connections.html is a standalone page for editing connections.json without hand-writing JSON: drag and drop between groups, duplicate a connection, autocompleting group selector, and auto-save through the File System Access API in Chrome and Edge. No build, no dependencies, entirely optional. See web/README.md.

Claude Desktop one-click install

Grab the .mcpb bundle from the latest release and drag it onto Claude Desktop's extensions settings. Point it at your connections.json in the extension's settings, or leave that empty to use ~/.mcp-sqlserver/connections.json.

Upgrading from 2.x

Your existing connections.json works unchanged — every new field is optional and the tools take the same arguments. Two things worth knowing:

  • Multi-connection was broken before 3.0. The server used the mssql global connection pool, which ignores the config it is handed once a connection is already open. In practice every connection after the first silently reused the first one's server and database. If you were relying on results from more than one connection in a session, they may not have come from where you thought. Fixed in 3.0 with a pool per connection.
  • If your agent config points at node C:\path\to\index.js, that still works. The file resolution order now checks that path last, so nothing moves.

Development

bash
npm installnpm test                     # unit tests, no database needednode .github/scripts/smoke.mjs   # packs, installs and speaks MCP to the tarball

Against a real server, name a connection from your own file:

bash
MSSQL_TEST_CONNECTION=local npm run test:integration

The mssql driver is injected, so the unit tests mock only that boundary — everything else is the real code path. test/contract.test.js freezes the tool names and arguments so a refactor cannot change the MCP surface by accident.

License

MIT — see LICENSE.

Author

Christian Velasquez — @cvelasquez

Issues · Changelog · Sponsor

来源:README.md,提交 a829b87

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

4
  1. v3.3.0最新Oct 12, 2026
  2. v3.1.0Sep 18, 2026
  3. v3.0.1Sep 18, 2026
  4. v3.0.0Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分