关键词

SQL Server数据库查询AI助手数据分析自然语言查询

使用说明

项目简介

SQL Server AI桥接器 (MS SQL MCP Server) 是一个轻量级工具，旨在弥合AI助手与Microsoft SQL Server数据库之间的鸿沟。它作为一个MCP服务器，允许AI助手通过标准化的Model Context Protocol (MCP) 直接访问和操作SQL Server数据库，无需编写复杂的集成代码。用户可以使用自然语言与数据库进行交互，实现数据探索、查询执行和分析等功能。

主要功能点

  • 数据库结构发现: AI助手可以自动发现数据库中的表、列和schema信息。
  • 表结构查看: 获取指定表的详细结构，包括列名、数据类型等。
  • 安全SQL查询: 执行只读SQL查询，保障数据安全。
  • 自然语言生成SQL: 根据自然语言描述，辅助生成SQL查询语句。
  • 多种传输协议: 支持 Stdio 和 HTTP/SSE 两种传输协议，适应不同的应用场景。
  • 会话管理: 支持会话管理，保持与客户端的连接状态。
  • 结果分页: 支持分页查询，处理大型数据集。

安装步骤

  1. 安装Node.js: 确保已安装Node.js (版本 14 或更高)。
  2. 克隆仓库: 使用Git克隆 'mssql-mcp-server' 仓库到本地。 
    git clone https://github.com/dperussina/mssql-mcp-server.git
cd mssql-mcp-server
  3. 安装依赖: 在项目目录下运行 'npm install' 安装所需的依赖包。 
    npm install
  4. 配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，然后编辑 '.env' 文件，填入你的SQL Server数据库连接信息。 
    cp .env.example .env
vim .env  # 或使用你喜欢的编辑器
    '.env' 文件内容示例如下： 
    DB_USER=你的数据库用户名
DB_PASSWORD=你的数据库密码
DB_SERVER=你的服务器地址或IP
DB_DATABASE=你的数据库名
PORT=3333                      # HTTP/SSE 传输协议使用的端口
TRANSPORT=stdio                # 传输协议，默认为 stdio，可选 sse
SERVER_URL=http://localhost:3333 # SSE 传输协议的服务URL，需要与 PORT 保持一致
DEBUG=false                    # 是否开启调试模式，设置为 true 可查看详细日志
QUERY_RESULTS_PATH=/path/to/query_results # 查询结果保存路径，可选

服务器配置

为了让MCP客户端（例如Claude Desktop）连接到 SQL Server AI桥接器，需要配置客户端的MCP服务器设置。以下是针对 Claude Desktop 的配置示例，配置信息为 JSON 格式：

{
    "mcpServers": {
        "mssql": {
            "command": "node",
            "args": [
                "/你的仓库路径/mssql-mcp-server/server.mjs"
            ]
        }
    }
}

配置参数说明:

  • '"mssql"': 自定义的服务名称，在Claude中用于标识和选择该服务。
  • '"command": "node"': 启动服务器的命令，这里使用 Node.js 运行 'server.mjs' 文件。
  • '"args"': 命令参数，数组形式。
    • '"/你的仓库路径/mssql-mcp-server/server.mjs"': 请务必替换为你的 'mssql-mcp-server' 仓库在本地机器上的绝对路径。 指向服务器入口文件 'server.mjs'。

Claude Desktop 配置步骤:

  1. 安装 Claude Desktop 应用程序。
  2. 找到 Claude Desktop 的配置文件 'claude_desktop_config.json'，通常位于 '~/Library/Application Support/Claude/' (macOS) 或 '%APPDATA%/Claude/' (Windows)。
  3. 编辑 'claude_desktop_config.json' 文件，将上述 JSON 配置代码添加到 'mcpServers' 字段中。如果 'mcpServers' 字段不存在，则创建它。
  4. 重启 Claude Desktop 应用程序。

基本使用方法

  1. 启动服务器:

    • 使用 Stdio 传输协议 (默认，适用于 Claude Desktop): 
      npm start
    • 使用 HTTP/SSE 传输协议 (适用于网络访问，例如 Cursor IDE): 
      npm run start:sse

    启动成功后，服务器将开始监听请求。

  2. 在AI助手中使用: 在配置好MCP服务器的AI助手（如Claude Desktop 或 Cursor IDE）中，你可以使用预定义的工具来与SQL Server数据库交互。例如，在 Claude 中，你可以使用类似以下的指令：

    // 发现数据库表
mcp_SQL_mcp_discover_database()

// 获取表 "Customers" 的详细信息
mcp_SQL_mcp_table_details({ tableName: "Customers" })

// 执行 SQL 查询
mcp_SQL_mcp_execute_query({ sql: "SELECT TOP 10 * FROM Customers", returnResults: true })

    具体可用的工具和详细的 Prompt 指引，请参考仓库的 README 文档。

注意: 请确保 SQL Server 数据库服务正在运行，并且配置的数据库连接信息正确。首次使用建议先阅读 README 文档，了解更多高级功能和配置选项。

信息

分类

数据库与文件

访问项目