Dperussina Mssql MCP Server

MS SQL MCP Server是一个无需编码的桥梁工具，让AI助手能直接查询和探索Microsoft SQL Server数据库，支持数据库发现、表结构查看、安全执行只读SQL查询及自然语言转SQL功能。

数据库开发者工具 #SQL桥接 #AI查询 #数据库工具 #无代码 .JavaScript

评分 : 2分

下载量 : 15

更新时间 : 2025-04-29

What is MS SQL MCP Server?

The MS SQL MCP Server is a powerful tool that connects AI assistants like Claude to your SQL Server databases. It allows you to explore, query, and analyze your database using natural language commands without writing SQL code.

How does it work?

The server acts as a secure middle layer between your AI assistant and database. It translates natural language requests into SQL queries, executes them safely (read-only by default), and returns the results to the AI for analysis.

Who should use this?

Perfect for business analysts who need data insights without SQL knowledge, developers exploring database structures, data analysts collaborating with AI, and DBAs who want to provide controlled AI access to databases.

Key Features

Database ExplorationDiscover and examine tables, columns, and relationships in your SQL Server database through simple commands.

Natural Language QueryConvert plain English questions into SQL queries automatically and get results back in easy-to-understand formats.

Safe Read-Only AccessAll queries are read-only by default, protecting your data from accidental modifications while allowing full exploration.

Large Data HandlingEfficient pagination and result handling allows working with datasets too large for normal AI context windows.

Pros and Cons

Advantages

No coding required - interact with databases using natural language

Maintains data security with read-only access by default

Saves hours of manual work copying data between systems

Provides deeper analysis by giving AI direct schema access

Works with existing SQL Server installations (on-prem or Azure)

Limitations

Currently only supports Microsoft SQL Server (not MySQL, PostgreSQL etc.)

Requires Node.js installation on the client machine

Advanced SQL features may require some technical knowledge

Performance depends on database size and network connection

Getting Started

Install Prerequisites

Install Node.js (version 14 or higher) on your computer and ensure you have access to a SQL Server database.

Set Up the Server

Clone the repository and install dependencies using npm (Node Package Manager).

Configure Database Connection

Edit the .env file with your database credentials and connection details.

Start the Server

Run the server using Node.js. Choose between stdio mode (for direct AI integration) or HTTP/SSE mode (for network access).

Connect Your AI Assistant

Configure your AI tool (like Claude Desktop or Cursor IDE) to connect to the running MCP server.

Example Use Cases

Sales Performance AnalysisAnalyze monthly sales trends and identify top-performing products by region.

Customer SegmentationGroup customers by purchase behavior and demographics for targeted marketing.

Database DocumentationCreate comprehensive documentation of your database structure.

Frequently Asked Questions

Is my database secure when using this tool?

Can I use this with Azure SQL Database?

What if I need to write data to the database?

How do I handle very large query results?

Can I use this with AI tools other than Claude?

Additional Resources

Official GitHub Repository

Source code and latest updates

Node.js Installation Guide

Download and install Node.js

SQL Server Documentation

Microsoft's official SQL Server docs

MCP Protocol Specification

Technical details about the Model Context Protocol

🚀 MS SQL MCP 服务器中文指南

本指南旨在帮助您快速上手并深入了解 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 服务器提供以下核心功能：

📊 数据库工具
- 查询数据
- 浏览表结构
- 执行管理命令
🔍 结果导航
- 分页浏览
- 导出结果
- 搜索内容
💻 查询执行
- 支持多种格式（JSON, CSV）
- 大结果集处理
- 事务支持
📁 数据库发现
- 浏览数据库结构
- 查看表信息
- 获取存储过程文档

💻 使用示例

🔍 查询数据

🌟 基础用法

SELECT TOP 5 * FROM Customers

⚙️ 高级用法

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

📂 浏览数据库结构

🌟 基础用法

# 列出所有数据库
LIST DATABASES

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

📚 详细文档

🔖 操作指南

🔄 分页浏览结果

获取分页信息

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

执行分页查询
```
{
  "tool": "paged_query"
}
```

⚙️ 执行管理命令

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

🔧 技术细节

🧩 核心模块

数据库模块 (database.mjs)
- 负责处理所有数据库连接和交互
- 管理事务和会话状态
查询执行模块 (query_executor.mjs)
- 解析和执行 SQL 语句
- 处理结果集
- 执行存储过程
分页模块 (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: 查询结果文件的存储路径。