Mssql MCP Server

🚀 SQL Server MCP 服務器

SQL Server MCP 服務器是一個提供與 SQL Server 數據庫交互工具的模型上下文協議 (MCP) 服務器。它允許大型語言模型 (LLMs) 通過標準化協議查詢和檢查 SQL Server 數據庫，為數據庫操作提供了便捷的途徑。

🚀 快速開始

先決條件

• .NET 8.0 SDK 或更高版本
• SQL Server 實例（本地或遠程）

安裝

# 克隆倉庫
git clone https://github.com/Popplywop/mssql-mcp-server 
cd mssql-mcp-server

# 構建項目
dotnet build

運行服務器

服務器可以通過直接連接字符串或引用環境變量來運行：

# 使用直接連接字符串
dotnet run --dsn "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"

# 使用環境變量
dotnet run --env-var "SQL_CONNECTION_STRING"

MCP 服務器配置

要與Claude或其他支持模型上下文協議的 LLM 配合使用，您需要在 MCP 配置中對其進行配置。以下是示例 JSON 配置：

{
  "servers": [
    {
      "name": "SqlServerMcp",
      "command": "path/to/mssql-mcp-server.exe",
      "args": [
        "--dsn",
        "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"
      ]
    }
  ]
}

將路徑和連接字符串替換為實際值。此配置可用於 Claude 的 MCP 集成或其他支持模型上下文協議的 LLM 平臺。

✨ 主要特性

• 數據庫查詢：執行 SQL 查詢並獲取結果
• 模式檢查：列出表、視圖、存儲過程，並檢查表結構

📦 安裝指南

克隆與構建

# 克隆倉庫
git clone https://github.com/Popplywop/mssql-mcp-server 
cd mssql-mcp-server

# 構建項目
dotnet build

運行方式

# 使用直接連接字符串
dotnet run --dsn "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"

# 使用環境變量
dotnet run --env-var "SQL_CONNECTION_STRING"

MCP 配置

{
  "servers": [
    {
      "name": "SqlServerMcp",
      "command": "path/to/mssql-mcp-server.exe",
      "args": [
        "--dsn",
        "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"
      ]
    }
  ]
}

💻 使用示例

基礎用法

ExecuteQuery:
  query: "SELECT TOP 10 * FROM MyTable"
  maxRows: 100

📚 詳細文檔

命令行選項

• --dsn 或 -d：SQL Server 連接字符串
• --env-var 或 -e：包含連接字符串的環境變量名稱

可用 MCP 工具

查詢工具

• ExecuteQuery：執行 SQL 查詢並返回結果
  • 參數：
    • query：要執行的 SQL 查詢
    • commandTimeout：可選命令超時時間（秒）
    • maxRows：可選的最大行數

模式工具

• ListTables：列出數據庫中的所有表
• GetTableSchema：獲取特定表的結構
  • 參數：
    • tableName：表的名稱
• ListViews：列出數據庫中的所有視圖
• ListStoredProcedures：列出數據庫中的所有存儲過程
• GetDatabaseInfo：獲取連接的數據庫信息

🔧 技術細節

服務器通過標準化的 MCP 協議，允許大型語言模型與 SQL Server 數據庫進行交互。它支持數據庫查詢和模式檢查等功能，通過命令行選項可以靈活配置連接方式。在運行時，可以直接使用連接字符串，也可以引用環境變量中的連接字符串。同時，通過 MCP 配置，可以與支持該協議的 LLM 進行集成。

📄 許可證

此項目根據 MIT License 發佈，具體內容請參閱 LICENSE.md 文件。MIT 許可證是一種寬鬆的許可協議，允許任何人以最少的限制重新使用軟件。您可以自由地使用、修改和分發代碼，但必須在分發的作品中包含原始版權聲明和許可聲明。

⚠️ 重要提示

• 使用 SQL Server 賬戶並授予適當權限（最小權限原則）
• 安全地存儲連接字符串（不在源代碼中）
• 考慮使用環境變量來存儲連接字符串
• 啟用 TLS/SSL 進行數據庫連接