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 查询并获取结果
• 模式检查：列出表、视图、存储过程，并检查表结构

📚 详细文档

命令行选项

• --dsn 或 -d：SQL Server 连接字符串
• --env-var 或 -e：包含连接字符串的环境变量名称

可用 MCP 工具

查询工具

• ExecuteQuery：执行 SQL 查询并返回结果
  • 参数：
    • query：要执行的 SQL 查询
    • commandTimeout：可选命令超时时间（秒）
    • maxRows：可选的最大行数

模式工具

• ListTables：列出数据库中的所有表
• GetTableSchema：获取特定表的结构
  • 参数：
    • tableName：表的名称
• ListViews：列出数据库中的所有视图
• ListStoredProcedures：列出数据库中的所有存储过程
• GetDatabaseInfo：获取连接的数据库信息

💻 使用示例

基础用法

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

⚠️ 安全注意事项

• 使用 SQL Server 账户并授予适当权限（最小权限原则）
• 安全地存储连接字符串（不在源代码中）
• 考虑使用环境变量来存储连接字符串
• 启用 TLS/SSL 进行数据库连接

📄 许可证

此项目根据 MIT License 发布，具体内容请参阅 LICENSE.md 文件。MIT 许可证是一种宽松的许可协议，允许任何人以最少的限制重新使用软件。您可以自由地使用、修改和分发代码，但必须在分发的作品中包含原始版权声明和许可声明。