sql-mcp-server

sql-mcp-server

site icon
2025.04.21 0
TypeScript数据库管理SQL Server 交互数据库
sql-mcp-server 是一个基于 mcp-framework 构建的 Model Context Protocol (MCP) 服务器,专门用于与 SQL Server 数据库进行交互。它提供了一系列工具和服务,帮助开发者高效地管理和查询 SQL Server 数据库。
View on GitHub

Overview

基本能力

产品定位

sql-mcp-server 是一个专门用于 SQL Server 数据库交互的 MCP 服务器,旨在简化数据库操作,提高开发效率。

核心功能

  1. 数据库列表查询:列出 SQL Server 上可用的数据库。
  2. 数据库模式检索:获取指定数据库的模式信息。
  3. 执行 SELECT 查询:运行参数化的 SELECT 查询。
  4. SQL 服务:提供连接字符串创建和查询执行的核心功能。

适用场景

  1. 需要快速查询 SQL Server 数据库的应用开发。
  2. 需要自动化数据库管理的场景。
  3. 需要集成 SQL Server 查询功能的 LLM 应用。

工具列表

  1. get-databases-tool:列出 SQL Server 上可用的数据库。
  2. get-database-schema-tool:检索指定数据库的模式信息。
  3. execute-select-query-tool:运行参数化的 SELECT 查询。

常见问题解答

  1. 如何配置数据库连接?
  2. .env 文件中配置数据库连接信息。
  3. 如何创建只读用户?
  4. 使用 SQL 命令创建只读用户并添加到 db_datareader 角色。
  5. 如何调试?
  6. 使用 mcp-debug 工具进行调试。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 安装项目依赖: bash npm install

安装教程

  1. 克隆项目或下载源代码。
  2. 安装依赖: bash npm install
  3. 构建项目: bash npm run build
  4. 启动服务器: bash npm start

调试方式

  1. 启动服务器: bash npm start
  2. 在另一个终端运行调试工具: bash npx mcp-debug
  3. 使用 mcp-debug 工具进行调试。

许可证

该项目遵循 None 开源许可条款。