README
🚀 MSSQL MCP 服务器
MSSQL MCP 服务器是一个用于连接 Microsoft SQL Server 数据库的 Model Context Protocol (MCP) 服务器。它提供了执行 SQL 查询和管理数据库连接的工具,帮助开发者更便捷地操作数据库。
🚀 快速开始
MSSQL MCP 服务器可帮助你轻松连接并操作 Microsoft SQL Server 数据库。以下将为你介绍安装和使用方法。
📦 安装指南
使用以下命令安装 mssql-mcp-server:
npm install mssql-mcp-server
💻 使用示例
基础用法
将服务器添加到您的 MCP 设置配置文件中:
{
"mcpServers": {
"mssql": {
"command": "mssql-mcp-server",
"env": {
"MSSQL_CONNECTION_STRING": "Server=localhost;Database=master;User Id=sa;Password=yourpassword;",
// 或者单独的连接参数:
"MSSQL_HOST": "localhost",
"MSSQL_PORT": "1433",
"MSSQL_DATABASE": "master",
"MSSQL_USER": "sa",
"MSSQL_PASSWORD": "yourpassword",
"MSSQL_ENCRYPT": "false",
"MSSQL_TRUST_SERVER_CERTIFICATE": "true"
}
}
}
}
高级用法
query 工具
query 工具可在 MSSQL 数据库上执行 SQL 查询。
参数
| 属性 | 详情 |
|------|------|
| connectionString | 完整的连接字符串(连接参数的替代方案),可选 |
| host | 数据库服务器主机名,可选 |
| port | 数据库服务器端口(默认:1433),可选 |
| database | 数据库名称(默认:master),可选 |
| username | 数据库用户名,可选 |
| password | 数据库密码,可选 |
| query | 要执行的 SQL 查询,必需 |
| encrypt | 启用加密(默认:false),可选 |
| trustServerCertificate | 信任服务器证书(默认:true),可选 |
要么提供 connectionString,要么同时提供 (host + username + password)。
示例
const result = await use_mcp_tool({
server_name: 'mssql',
tool_name: 'query',
arguments: {
host: 'localhost',
username: 'sa',
password: 'yourpassword',
query: 'SELECT * FROM Users',
},
});
🔧 技术细节
开发命令
以下是开发过程中常用的命令:
# 安装依赖项
npm install
# 在开发模式下运行
npm run dev
# 构建
npm run build
# 运行测试
npm test
# 运行代码检查
npm run lint
# 格式化代码
npm run format
📄 许可证
本项目采用 MIT 许可证。
Scan to contact