mssql-server-mcp

v1.0.0

Published

9 months ago

MSSQL Server MCP - Model Context Protocol server for Microsoft SQL Server database operations

Downloads

0High
0Medium
0Low

kfnzero

mcp model-context-protocol mssql sql-server database stdio

MSSQL Server MCP

一個支援 STDIO 協定的 Microsoft SQL Server MCP (Model Context Protocol) 伺服器，提供資料庫 Schema 查詢、Trigger 管理和 SQL 查詢執行功能。

功能特色

🔌 STDIO 協定支援 - 與 MCP 客戶端無縫整合
🗄️ Schema 查詢 - 查詢資料庫結構、資料表、欄位和索引
⚡ Trigger 管理 - 查看和分析觸發器
🔧 預存程序管理 - 查詢、執行和分析預存程序
📊 SQL 查詢執行 - 支援 SELECT、INSERT、UPDATE、DELETE 操作
🔒 安全設計 - 參數化查詢和權限控制
🌍 環境變數配置 - 靈活的連線設定

快速開始

安裝

npm install -g mssql-server-mcp

設定環境變數

# 複製環境變數範例檔案
cp .env.example .env

# 編輯 .env 檔案，填入真實的連線資訊
vim .env

⚠️ 重要：.env 檔案包含敏感資訊，不會被提交到版本控制。

執行

mssql-server-mcp

MCP 客戶端整合

在 Claude Desktop 或其他 MCP 客戶端中配置：

# 複製 MCP 配置範例
cp .mcp.example.json .mcp.json

# 編輯配置檔案，填入真實連線資訊
vim .mcp.json

配置範例：

{
  "mcpServers": {
    "mssql-server": {
      "command": "mssql-server-mcp",
      "env": {
        "MSSQL_SERVER": "your_actual_server",
        "MSSQL_DATABASE": "your_actual_database", 
        "MSSQL_USER": "your_actual_user",
        "MSSQL_PASSWORD": "your_actual_password"
      }
    }
  }
}

⚠️ 重要：.mcp.json 檔案包含敏感資訊，不會被提交到版本控制。

可用工具

Schema 查詢

list_schemas - 列出所有資料庫 Schema
list_tables - 列出指定 Schema 的資料表
describe_table - 描述資料表結構

Trigger 管理

list_triggers - 列出觸發器
describe_trigger - 描述觸發器詳細資訊

預存程序管理

list_stored_procedures - 列出預存程序
describe_stored_procedure - 描述預存程序詳細資訊
execute_stored_procedure - 執行預存程序
search_stored_procedures - 搜尋預存程序
get_procedure_dependencies - 取得預存程序相依關係

SQL 查詢

execute_query - 執行 SQL 查詢

環境變數

基本連線設定

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_SERVER | SQL Server 伺服器位址 | localhost | | MSSQL_PORT | 連接埠 | 1433 | | MSSQL_DATABASE | 資料庫名稱 | master | | MSSQL_USER | 使用者名稱 | sa | | MSSQL_PASSWORD | 密碼 | - |

安全設定

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_ENCRYPT | 啟用加密 | true | | MSSQL_TRUST_SERVER_CERTIFICATE | 信任伺服器憑證 | true | | MSSQL_DOMAIN | Windows 網域 | - | | MSSQL_INSTANCE_NAME | SQL Server 實例名稱 | - |

連線逾時設定

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_CONNECTION_TIMEOUT | 連線逾時 (ms) | 15000 | | MSSQL_REQUEST_TIMEOUT | 請求逾時 (ms) | 15000 | | MSSQL_CANCEL_TIMEOUT | 取消逾時 (ms) | 5000 |

連線池設定

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_POOL_MAX | 連線池最大連線數 | 10 | | MSSQL_POOL_MIN | 連線池最小連線數 | 0 | | MSSQL_POOL_IDLE_TIMEOUT | 連線池閒置逾時 (ms) | 30000 | | MSSQL_POOL_ACQUIRE_TIMEOUT | 取得連線逾時 (ms) | 60000 | | MSSQL_POOL_CREATE_TIMEOUT | 建立連線逾時 (ms) | 30000 | | MSSQL_POOL_DESTROY_TIMEOUT | 銷毀連線逾時 (ms) | 5000 | | MSSQL_POOL_REAP_INTERVAL | 連線回收間隔 (ms) | 1000 | | MSSQL_POOL_CREATE_RETRY_INTERVAL | 重試建立連線間隔 (ms) | 200 |

進階設定

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_ENABLE_ARITH_ABORT | 啟用算術中斷 | true | | MSSQL_USE_UTC | 使用 UTC 時間 | true | | MSSQL_PARSE_JSON | 解析 JSON | false | | MSSQL_ARRAY_ROW_MODE | 陣列行模式 | false | | MSSQL_APP_NAME | 應用程式名稱 | mssql-server-mcp | | MSSQL_WORKSTATION_ID | 工作站 ID | - | | MSSQL_READ_ONLY_INTENT | 唯讀意圖 | false | | MSSQL_STREAM | 串流模式 | false | | MSSQL_FALLBACK_TO_DEFAULT_DB | 回退到預設資料庫 | false |

Azure Active Directory 驗證

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_AUTH_TYPE | 驗證類型 | default | | MSSQL_AUTH_DOMAIN | 驗證網域 | - | | MSSQL_AUTH_TOKEN | 存取權杖 | - | | MSSQL_AUTH_CLIENT_ID | 客戶端 ID | - | | MSSQL_AUTH_CLIENT_SECRET | 客戶端密鑰 | - | | MSSQL_AUTH_TENANT_ID | 租戶 ID | - |

除錯設定

| 變數名稱 | 描述 | 預設值 | |---------|------|--------| | MSSQL_DEBUG | 啟用除錯模式 | false | | MSSQL_LOG_LEVEL | 記錄層級 | info |

開發

建置

git clone https://github.com/yourusername/mssql-server-mcp.git
cd mssql-server-mcp
npm install
npm run build

開發模式

npm run dev

測試

npm test

程式碼檢查

npm run lint

安全考量

僅支援 SELECT、INSERT、UPDATE、DELETE 操作
使用參數化查詢防止 SQL 注入
不支援 DDL 操作以確保資料庫安全
支援 SSL/TLS 加密連線

授權

MIT License

貢獻

歡迎提交 Issue 和 Pull Request！