Dperussina Mssql MCP Server

🚀 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 服務器提供以下核心功能：

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. 數據庫模塊 (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: 查詢結果文件的存儲路徑。

⚠️ 注意事項

⚠️ 重要提示

數據庫連接字符串包含敏感信息，請確保其安全。洩露可能導致未經授權訪問您的數據庫。

💡 使用建議

1. 安全性
   • 請勿共享數據庫連接字符串
   • 使用安全的憑據
   • 配置適當的數據訪問權限
2. 性能優化
   • 確保索引優化
   • 處理大結果集時使用分頁
   • 避免長時間運行的查詢

結束語

通過以上指南，您可以順利配置和使用 MS SQL MCP 服務器，並根據需要進行擴展和優化。