使用说明

项目简介

MSSQL MCP Server 是一个 MCP (Model Context Protocol) 服务器，旨在为大型语言模型 (LLM) 应用提供访问 Microsoft SQL Server 数据库的能力。通过此服务器，LLM 客户端可以安全、便捷地执行 SQL 查询，从而获取数据库中的信息作为上下文，增强 LLM 应用的功能。

主要功能点

SQL 查询工具: 提供 'query' 工具，允许 LLM 客户端发送 SQL 查询请求并在 MSSQL 数据库上执行。
连接管理: 支持通过连接字符串或单独的连接参数（主机、端口、用户名、密码等）连接到 MSSQL 数据库。
标准化 MCP 协议: 遵循 MCP 协议标准，使用 JSON-RPC 进行通信，易于集成到任何支持 MCP 协议的 LLM 客户端。
环境配置: 通过环境变量灵活配置数据库连接信息，方便部署和管理。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node Package Manager)。
安装 MSSQL MCP Server: 打开终端，运行以下命令安装 'mssql-mcp-server'：
```
npm install mssql-mcp-server
```

服务器配置

要将 MSSQL MCP Server 集成到 MCP 客户端，你需要在客户端的 MCP 服务器配置中添加以下信息。以下是一个 JSON 格式的配置示例，你需要根据你的 MSSQL 数据库连接信息进行修改：

{
  "mcpServers": {
    "mssql": {
      "command": "mssql-mcp-server",
      "env": {
        "MSSQL_CONNECTION_STRING": "Server=your_server_address;Database=your_database_name;User Id=your_username;Password=your_password;",
        // 或者，你可以使用单独的连接参数，如果 connectionString 存在，则优先使用 connectionString
        // "MSSQL_HOST": "your_server_address",
        // "MSSQL_PORT": "1433", // 默认端口为 1433
        // "MSSQL_DATABASE": "your_database_name", // 默认数据库为 master
        // "MSSQL_USER": "your_username",
        // "MSSQL_PASSWORD": "your_password",
        // "MSSQL_ENCRYPT": "false", // 是否启用加密，默认为 false
        // "MSSQL_TRUST_SERVER_CERTIFICATE": "true" // 是否信任服务器证书，默认为 true
      }
    }
  }
}

配置参数说明:

'server name': 为该 MSSQL MCP 服务器配置指定一个名称，例如 'mssql'。这个名称将在 LLM 客户端调用工具时使用。
'command': 启动 MSSQL MCP Server 的命令，这里设置为 'mssql-mcp-server'，前提是 'mssql-mcp-server' 已安装并在环境变量 'PATH' 中。
'env': 环境变量配置，用于传递数据库连接信息。
- 'MSSQL_CONNECTION_STRING': 完整的 MSSQL 连接字符串，如果提供此项，则忽略其他单独的连接参数。
- 'MSSQL_HOST': MSSQL 服务器主机名或 IP 地址。
- 'MSSQL_PORT': MSSQL 服务器端口号，默认为 '1433'。
- 'MSSQL_DATABASE': 要连接的数据库名称，默认为 'master' 数据库。
- 'MSSQL_USER': 数据库用户名。
- 'MSSQL_PASSWORD': 数据库密码。
- 'MSSQL_ENCRYPT': 是否启用连接加密，布尔值，默认为 'false'。
- 'MSSQL_TRUST_SERVER_CERTIFICATE': 是否信任服务器证书，布尔值，默认为 'true'。

注意: 请务必替换示例配置中的 'your_server_address', 'your_database_name', 'your_username', 'your_password' 为你实际的 MSSQL 数据库连接信息。

基本使用方法

配置完成后，在 LLM 客户端中，你可以使用 'query' 工具来执行 SQL 查询。以下是一个使用示例（伪代码，具体使用方式取决于你的 MCP 客户端）：

const result = await use_mcp_tool({
  server_name: 'mssql', //  server name 需要与你在 MCP 客户端配置中设置的名称一致
  tool_name: 'query',
  arguments: {
    //  你可以选择使用 connectionString 或 单独的连接参数
    // connectionString: 'Server=...',
    host: 'your_server_address',
    username: 'your_username',
    password: 'your_password',
    query: 'SELECT * FROM your_table_name WHERE condition', //  你需要执行的 SQL 查询语句
  },
});

console.log(result); //  查询结果将以 JSON 格式返回

请参考你的 MCP 客户端文档，了解如何配置和使用 MCP 服务器以及如何调用 'query' 工具。

关键词