CM

c0h1b4/mssql-mcp-server

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

15 stars 13 forks 质量 79 趋势 29MIT

用于连接到Microsoft SQL 服务器数据库的模型背景协议(MCP)服务器. 这个服务器提供了执行SQL查询和管理数据库连接的工具.

概览

用于连接到Microsoft SQL 服务器数据库的模型背景协议(MCP)服务器. 这个服务器提供了执行SQL查询和管理数据库连接的工具. 这个项目已经升级到使用模型背景协议SDK 1.9.0. 详情见UPGRADE.md. 通过 Smithery 为 Claude 桌面自动安装 MSSQL MCP 服务器 : 将服务器添加到您的 MCP 设置配置文件 : 在 MSSQL 数据库中执行 SQL 查询 。 - 连接String(字符串,可选):完整连接字符串(对单个参数的替代) - 主机(字符串,可选): 数据库服务器主机名 - 端口( 数字, 可选) : 数据库服务器端口( 默认: 1433) - 数据库( 字符串, 可选) : 数据库名称( 默认: 主机) - 用户名( 字符串, 可选) : 数据库用户名 - 密码( 字符串, 可选) : 数据库密码 - 查询( 字符串, 需要): SQL 查询执行 - 加密( 布尔, 可选): 启用加密( 默认: 虚假) - 信任Server证书( 布尔, 可选): 信任...

概述(AI 翻译)

用于连接到Microsoft SQL 服务器数据库的模型背景协议(MCP)服务器. 这个服务器提供了执行SQL查询和管理数据库连接的工具.

** 现行通知:** 这个项目已经升级到使用模型背景协议SDK 1.9.0. 详情见UPGRADE.md.

□ 安装

通过 Smithery 安装

通过 Smithery 为 Claude 桌面自动安装 MSSQL MCP 服务器 :

手动安装

□ 使用量

将服务器添加到您的 MCP 设置配置文件 :

□ 工具

QQ 查询

在 MSSQL 数据库中执行 SQL 查询 。

参数

  • [[T0] (字符串,可选): 完全连接字符串( 单个参数的替代)
  • [[T1] (字符串,可选): 数据库服务器主机名
  • [T2: 数据库服务器端口( 默认为 1433)
  • database (字符串,可选): 数据库名称( 默认: master)
  • [[T4] (字符串,可选): 数据库用户名
  • [[T5] (字符串,可选): 数据库密码
  • [[T6] (字符串, 需要): 要执行的 SQL 查询
  • encrypt(boolean,可选):启用加密(默认:虚假)
  • trustServerCertificate(布尔,可选): 信任服务器证书( 默认: 真)

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

MSSQL MCP Server

A Model Context Protocol (MCP) server for connecting to Microsoft SQL Server databases. This server provides tools for executing SQL queries and managing database connections.

Version Notice: This project has been upgraded to use Model Context Protocol SDK 1.9.0. See UPGRADE.md for details.

Installation

Installing via Smithery

To install MSSQL MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @c0h1b4/mssql-mcp-server --client claude

Manual Installation

npm install mssql-mcp-server

Usage

Add the server to your MCP settings configuration file:

{
  "mcpServers": {
    "mssql": {
      "command": "mssql-mcp-server",
      "env": {
        "MSSQL_CONNECTION_STRING": "Server=localhost;Database=master;User Id=sa;Password=yourpassword;",
        // Or individual connection parameters:
        "MSSQL_HOST": "localhost",
        "MSSQL_PORT": "1433",
        "MSSQL_DATABASE": "master",
        "MSSQL_USER": "sa",
        "MSSQL_PASSWORD": "yourpassword",
        "MSSQL_ENCRYPT": "false",
        "MSSQL_TRUST_SERVER_CERTIFICATE": "true"
      }
    }
  }
}

Tools

query

Execute a SQL query on a MSSQL database.

Parameters

  • connectionString (string, optional): Full connection string (alternative to individual parameters)
  • host (string, optional): Database server hostname
  • port (number, optional): Database server port (default: 1433)
  • database (string, optional): Database name (default: master)
  • username (string, optional): Database username
  • password (string, optional): Database password
  • query (string, required): SQL query to execute
  • encrypt (boolean, optional): Enable encryption (default: false)
  • trustServerCertificate (boolean, optional): Trust server certificate (default: true)

Either connectionString OR (host + username + password) must be provided.

Example

const result = await use_mcp_tool({
  server_name: 'mssql',
  tool_name: 'query',
  arguments: {
    host: 'localhost',
    username: 'sa',
    password: 'yourpassword',
    query: 'SELECT * FROM Users',
  },
});

Running the Server

Local Development

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build
npm run build

# Run the built server
npm start

Using Docker

# Build and start services (SQL Server + MCP server)
docker-compose up

# Or just build the Docker image
docker build -t mssql-mcp-server .

Testing

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

Running evals

在 GitHub 查看完整 README

安装

npx -y @smithery/cli install @c0h1b4/mssql-mcp-server --client claude
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "mssql": { "command": "mssql-mcp-server", "env": { "MSSQL_CONNECTION_STRING": "Server=localhost;Database=master;User Id=sa;Password=yourpassword;", // Or individual connection parameters: "MSSQL_HOST": "localhost", "MSSQL_PORT": "1433", "MSSQL_DATABASE": "master", "MSSQL_USER": "sa", "MSSQL_PASSWORD": "yourpassword", "MSSQL_ENCRYPT": "false", "MSSQL_TRUST_SERVER_CERTIFICATE": "true" } } } }