SQL Preview MCP 服务器

使用说明（Markdown 格式）

• 项目简介

  • 该仓库实现了一系列基于 MCP（Model Context Protocol）的服务器端组件，用于将数据库查询能力暴露给 AI 助手（如 Claude Desktop、Cursor 等）作为工具，LLM 可以通过工具调用执行 SQL、获取表结构、列信息等上下文数据。

• 主要功能点

  • 为多种数据库后端提供 MCP 服务端实现，统一暴露工具接口（如执行查询、列出表、描述表等）。
  • 支持通过 MCP 的工具调用模式与 AI 实例进行交互，返回查询结果的分页数据以及列信息。
  • 提供不同数据库的连接实现（如 MSSQL、MySQL、Postgres、DuckDB、Snowflake、BigQuery、Trino、SQLite），便于在同一 MCP 服务中对接多种数据源。
  • 以本地标准输入/输出（stdio）传输或其他传输方式与 MCP 客户端通信，确保 AI 助手在受控环境中访问数据库数据。
  • 与数据库驱动/连接器解耦，服务器端仅聚焦工具注册、请求处理与结果包装。

• 安装步骤

  • 在本地使用 Node.js/npm 环境，安装依赖并构建各数据库的 MCP 服务端组件（对应各数据库的包夹）。
  • 按需启动某个数据库的 MCP 服务端，可选择以 stdio 传输方式启动（也可实现其他传输方式以适配不同前端客户端）。
  • 服务器将自动暴露工具清单和工具实现，AI 客户端即可通过 MCP 客户端与服务器交互。

• 服务器配置

  • MCP 服务器配置用于 MCP 客户端创建连接，不需要在客户端提供具体实现信息。以下为示例配置，便于理解要素：
  • serverName: sql-preview-mssql
  • command: node
  • args: [ "<path-to-built-cli.js>", "--mcp" ] 说明：
  • serverName 用于标识服务器实例，command/args 指定在客户端启动时要执行的命令及参数，path 需替换为实际打包后的 MCP 服务器入口路径（通常是在构建输出中的入口脚本）。
  • 注：具体的构建路径和执行命令会随部署方式变化，请将上述字段中的路径替换为实际可执行的 MCP 服务器入口。

• 基本使用方法

  • 将 MCP 客户端配置为连接该 MCP 服务器（指定服务器名称、启动命令与参数）。
  • 通过客户端请求工具列表（例如执行 SQL 的工具）并执行查询，获取分页数据、表结构信息等。
  • 若需要调试，可使用服务器自带的调试入口与 inspector，查看工具列表、调用结果及错误信息。

• 说明要点

  • 该仓库中的 MCP 服务器实现覆盖多种数据库后端，核心是将数据库连接、查询封装为 MCP 的工具接口，供 AI 助手按需调用。
  • MCP 客户端不需要了解数据库实现细节，只需调用暴露出的工具即可获得结果。