Microsoft SQL Server MCP Server (MSSQL)

🚀 MS SQL MCP 服務器中文文檔

MS SQL MCP（Microsoft SQL Machine Learning Platform）服務器是一款模塊化、可擴展的工具，能簡化用戶與 Microsoft SQL 數據庫的交互過程。它提供了查詢執行、表結構查看和數據庫發現等多種功能，助力用戶探索和操作數據庫。

🚀 快速開始

MS SQL MCP 服務器是一個模塊化、可擴展的工具，用於幫助用戶探索和操作 Microsoft SQL 數據庫。它通過提供多種功能，如查詢執行、表結構查看和數據庫發現，簡化了與 SQL 數據庫交互的過程。

✨ 主要特性

• 數據庫發現功能強大：支持表結構查看、數據預覽和元數據提取，方便用戶瀏覽和分析數據庫結構。
• 模塊化設計：各個組件分工明確，包括數據庫連接、工具註冊、資源管理、分頁處理、錯誤處理和日誌系統等。
• 詳細日誌記錄：支持詳細的日誌輸出，可通過設置 DEBUG 環境變量啟用或禁用。
• 完善的錯誤處理：遇到錯誤時提供詳細信息，幫助用戶快速定位和解決問題。

📦 安裝指南

文檔未提及安裝步驟，故跳過此章節。

💻 使用示例

基礎用法

連接到 SQL Server

const { Database } = require('mssql-mcp');

async function connect() {
    const db = new Database({
        config: {
            user: 'your_username',
            password: 'your_password',
            server: 'localhost',
            database: 'your_database'
        }
    });

    try {
        await db.connect();
        console.log('已連接到 SQL Server。');
    } catch (error) {
        console.error('無法連接到數據庫:', error);
    }
}

connect();

執行查詢

async function queryExample() {
    const db = new Database({
        config: {
            user: 'your_username',
            password: 'your_password',
            server: 'localhost',
            database: 'your_database'
        }
    });

    try {
        await db.connect();
        const result = await db.query('SELECT TOP 5 * FROM YourTable');
        console.log('查詢結果:', result);
    } catch (error) {
        console.error('執行查詢時出錯:', error);
    } finally {
        await db.disconnect();
    }
}

queryExample();

分頁處理

async function paginatedQuery() {
    const db = new Database({
        config: {
            user: 'your_username',
            password: 'your_password',
            server: 'localhost',
            database: 'your_database'
        },
        options: {
            pageNumber: 2,
            pageSize: 10
        }
    });

    try {
        await db.connect();
        const result = await db.query('SELECT * FROM YourTable ORDER BY Id');
        console.log('分頁結果:', result);
    } catch (error) {
        console.error('執行分頁查詢時出錯:', error);
    } finally {
        await db.disconnect();
    }
}

paginatedQuery();

📚 詳細文檔

核心組件

環境配置說明

.env 文件控制 MS SQL MCP 服務器如何連接到數據庫以及其運行方式。以下是對每個設置的詳細解釋：

# 數據庫連接設置
DB_USER=your_username           # SQL Server 用戶名
DB_PASSWORD=your_password       # SQL Server 密碼
DB_SERVER=your_server_name      # 服務器主機名或 IP 地址（示例：localhost, 10.0.0.1, myserver.database.windows.net）
DB_DATABASE=your_database_name  # 要連接到的數據庫名稱

# 服務器配置
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  # 存儲查詢結果的文件夾路徑

連接類型說明

stdio 傳輸

• 當直接使用 Claude Desktop 連接時使用。
• 通過標準輸入/輸出流進行通信。
• 在 .env 文件中設置 TRANSPORT=stdio。
• 使用命令 npm start 啟動。

HTTP/SSE 傳輸

• 當通過網絡連接（如與 Cursor 自然連接）時使用。
• 支持 Server-Sent Events (SSE) 的 HTTP 協議。
• 在 .env 文件中設置 TRANSPORT=sse。
• 使用命令 npm run sse 啟動。

數據庫發現

MS SQL MCP 服務器提供了一個強大的數據庫發現功能，使用戶能夠輕鬆瀏覽和分析其結構。主要功能如下：

1. 表結構查看：支持以樹狀視圖或表格形式顯示錶的列信息。
2. 數據預覽：允許用戶選擇特定行數進行快速數據分析。
3. 元數據提取：提供數據庫、表和列級別的詳細元數據。

日誌記錄

MS SQL MCP 服務器支持詳細的日誌記錄，以幫助用戶調試和監控運行狀態。通過設置 DEBUG 環境變量，可以啟用或禁用詳細日誌輸出。

# 啟用調試模式
DEBUG=true npm start

# 禁用調試模式（默認）
npm start

錯誤處理

在遇到錯誤時，MS SQL MCP 服務器會提供詳細的錯誤信息，幫助用戶快速定位和解決問題。以下是一些常見的錯誤場景及解決方案：

連接錯誤

• 原因：數據庫憑據不正確或網絡問題。
• 解決方法：檢查用戶名、密碼和服務器地址是否正確，並確保網絡連接正常。

查詢錯誤

• 原因：語法錯誤或權限不足。
• 解決方法：驗證 SQL 查詢的語法是否正確，並確認用戶具有執行該查詢的權限。

資源限制

• 原因：數據庫資源耗盡（如內存不足）。
• 解決方法：優化查詢性能，減少同時運行的查詢數量，或增加數據庫服務器的資源。

🔧 技術細節

文檔中關於技術細節的描述分散在各個部分，整體技術細節圍繞服務器的模塊化設計，各組件協同工作實現數據庫連接、操作、分頁、錯誤處理和日誌記錄等功能。通過 .env 文件配置服務器連接和運行方式，不同的連接類型採用不同的啟動命令。核心組件分工明確，保證了服務器的高效運行和功能的實現。

📄 許可證

文檔未提及許可證信息，故跳過此章節。

總結

MS SQL MCP 服務器是一個功能強大且靈活的工具，能夠幫助用戶高效地與 Microsoft SQL 數據庫交互。通過其模塊化設計和豐富的功能集，用戶可以輕鬆完成從基礎查詢到複雜數據分析的各項任務。