MS SQL MCP 服务器中文指南

开始使用

安装依赖

运行以下命令安装所需的依赖项：

npm install

配置环境变量

创建或编辑项目根目录下的 .env 文件，并根据实际情况填写以下内容：

# 数据库连接设置
DB_USER=你的用户名           # SQL Server 用户名
DB_PASSWORD=你的密码         # SQL Server 密码
DB_SERVER=你的服务器名称      # 服务器主机名或 IP 地址（例如：localhost, 10.0.0.1, myserver.database.windows.net）
DB_DATABASE=你的数据库名称    # 要连接的数据库名称

# 服务配置
PORT=3333                    # HTTP/SSE 服务器监听的端口
TRANSPORT=stdio              # 连接方式：'stdio'（用于 Claude Desktop）或 'sse'（用于网络连接）
SERVER_URL=http://localhost:3333   # 使用 SSE 运输时的基础 URL（必须与 PORT 设置匹配）

# 高级设置
DEBUG=false                  # 设为 'true' 以启用详细日志记录（调试时有用）
QUERY_RESULTS_PATH=/path/to/query_results  # 查询结果保存的目录路径（每个查询结果将作为 JSON 文件存储在此处）

启动服务

• 使用 stdio 运输启动：

  npm start
  

• 使用 sse 运输启动：

  npm run start:sse
  

功能概述

MS SQL MCP 服务器提供以下核心功能：

1. 数据库工具

   • 查询数据
   • 浏览表结构
   • 执行管理命令

2. 结果导航

   • 分页浏览
   • 导出结果
   • 搜索内容

3. 查询执行

   • 支持多种格式（JSON, CSV）
   • 大结果集处理
   • 事务支持

4. 数据库发现

   • 浏览数据库结构
   • 查看表信息
   • 获取存储过程文档

快速上手示例

查询数据

基本查询

SELECT TOP 5 * FROM Customers

分页查询

SELECT * FROM Orders 
ORDER BY OrderID OFFSET 10 ROWS FETCH NEXT 20 ROWS ONLY

浏览数据库结构

# 列出所有数据库
LIST DATABASES

# 显示当前数据库表
DESCRIBE TABLE Customers

操作指南

分页浏览结果

1. 获取分页信息

   {
     "tool": "pagination",
     "args": {
       "query": "SELECT * FROM Orders",
       "page_size": 20,
       "current_page": 1
     }
   }
   

2. 执行分页查询

   {
     "tool": "paged_query"
   }
   

执行管理命令

EXECUTE SYSTEM COMMAND 'BACKUP DATABASE MyDatabase TO DISK = \'C:\Backups\MyDatabase.bak\''

注意事项

1. 安全性

   • 请勿共享数据库连接字符串
   • 使用安全的凭据
   • 配置适当的数据访问权限

2. 性能优化

   • 确保索引优化
   • 处理大结果集时使用分页
   • 避免长时间运行的查询

深入架构

核心模块

1. 数据库模块 (database.mjs)

   • 负责处理所有数据库连接和交互
   • 管理事务和会话状态

2. 查询执行模块 (query_executor.mjs)

   • 解析和执行 SQL 语句
   • 处理结果集
   • 执行存储过程

3. 分页模块 (pagination.mjs)

   • 实现分页逻辑
   • 支持多种数据库方言
   • 提供高效的数据导航

环境配置解释

数据库连接设置

• DB_USER: 登录 SQL Server 的用户名。
• DB_PASSWORD: 对应用户的密码。
• DB_SERVER: 服务器的网络地址。
• DB_DATABASE: 要连接的具体数据库名称。

服务配置

• PORT: 服务运行的端口，默认为 3333。
• TRANSPORT: 连接方式，stdio 用于本地开发，sse 用于生产环境。
• SERVER_URL: 当使用 sse 运输时，定义服务器的基础 URL。

高级设置

• DEBUG: 启用调试模式以获取详细日志信息。
• QUERY_RESULTS_PATH: 查询结果文件的存储路径。

注意：请勿分享此连接字符串

数据库连接字符串包含敏感信息，请确保其安全。泄露可能导致未经授权访问您的数据库。

结束语

通过以上指南，您可以顺利配置和使用 MS SQL MCP 服务器，并根据需要进行扩展和优化。