🚀 SQL Server MCP 客户端
SQL Server MCP 客户端是一个基于 .NET 的程序，用于连接和操作 Microsoft SQL Server 数据库。它通过实现 MCP（Microsoft Common Platform）协议，提供了与 SQL Server 交互的接口，方便用户对数据库进行各类操作。
🚀 快速开始
先决条件
- 安装 .NET 运行时环境，以确保程序能够正常运行。
- 确保安装了 Docker（如果需要通过 Docker 运行）。
- 配备有效的 SQL Server 数据库和相应的访问权限。
构建指令
要从源代码构建项目，请按照以下步骤操作：
- 克隆此仓库到本地开发环境。
- 打开终端或命令提示符，导航至项目的根目录。
- 运行以下命令进行构建：
dotnet build --configuration Release
✨ 主要特性
- 数据库连接：支持通过多种身份验证方式连接到 SQL Server。
- 数据操作：提供基本的 CRUD（创建、读取、更新、删除）操作功能。
- 查询执行：允许用户执行自定义 SQL 查询并查看结果集。
- 连接字符串配置：可以通过环境变量设置数据库连接信息。
📦 安装指南
Docker 支持
本地 Registry 使用
将项目构建成果发布为 Docker 镜像，并使用以下命令运行：
docker run -it --rm -e "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;" YOUR_REGISTRY/mssqlclient:latest
手动 Docker 构建
在项目的根目录下，运行以下命令构建 Docker 镜像：
docker build -t mssqlclient .
然后使用以下命令运行镜像：
docker run -it --rm -e "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;" mssqlclient
Docker 推送
要将镜像推送到私有或公共 Registry，请运行：
docker push YOUR_REGISTRY/mssqlclient:latest
📚 详细文档
MCP 协议使用方法
客户端集成
在 Claude 桌面中配置 SQL Server MCP 客户端，有两种方式可供选择。
本地安装
- 添加服务器配置到 Claude 桌面的配置文件中：
"mssql": {
"command": "dotnet",
"args": [
"YOUR_PATH_TO_DLL\\Core.Infrastructure.McpServer.dll"
],
"env": {
"MSSQL_CONNECTIONSTRING": "Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;"
}
}
- 保存文件并重启 Claude 桌面。
Docker 容器使用
- 在 Claude 桌面配置中添加以下内容：
"mssql": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e", "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;",
"localhost:5000/mssqlclient-mcp-server:latest"
]
}
- 保存文件并重启 Claude 桌面。
配置
数据库连接字符串
配置 SQL Server 连接字符串时，请确保包含以下信息：
- 服务器名 或 IP 地址
- 数据库名
- 身份验证方式
- 用户名 和 密码
示例连接字符串：
Server=my-server;Database=my-database;User Id=my-user;Password=my-password;TrustServerCertificate=True;
⚠️ 注意事项
⚠️ 重要提示
确保所有环境变量和配置信息的安全性，避免泄露敏感数据。
💡 使用建议
在生产环境中使用前，请进行充分的测试和验证。
📄 许可证
请参考项目的LICENSE文件获取详细许可信息。