SQL Server MCP (Windows)

io.github.TharanaBope由 GitHub 账号 TharanaBope 发布v1.0.4更新于 Oct 27, 2026

SQL Server MCP with RAG capabilities for Windows (native ODBC support)

已验证STDIO仅桌面数据库数据与分析

概览

AI 生成的概览

本地 MCP 服务器,让 AI 助手在 Windows 上浏览和查询 Microsoft SQL Server 数据库,支持架构搜索与只读 SELECT 查询。

可以做什么
  • 列出并描述数据库、表、视图、存储过程及数据库统计信息
  • 梳理外键关系,查找与某张表直接关联的表
  • 在表、列、视图和存储过程中搜索架构,并定位某列的使用位置
  • 执行带超时和行数限制的只读 SELECT 查询
  • 缓存架构元数据以加快重复查询
适用场景
当你使用 SQL Server 实例,希望助手无需手写 SQL 就能回答关于其结构、表间关系和数据内容的问题时适用。更适合探索和只读报表,而非修改架构。
运行要求
在 Windows 上通过 npx 作为本地进程运行,需要原生 ODBC 驱动和 msnodesqlv8 驱动。需要可访问的 SQL Server 实例,并通过环境变量提供连接设置:SQL_SERVER、SQL_DATABASE、SQL_PORT、SQL_USE_WINDOWS_AUTH,使用 SQL 身份验证时还需 SQL_USERNAME 和 SQL_PASSWORD。可选设置包括 QUERY_TIMEOUT、MAX_RESULT_ROWS、ENABLE_SCHEMA_CACHE 和 CACHE_TTL_MINUTES。
安装前请注意
SQL_PASSWORD 以明文形式写在助手的配置文件中,需妥善保护该文件。服务器默认只读,但 README 说明可显式开启写操作,届时助手将能修改数据。查询结果和架构信息会发送给你所使用的 AI 模型服务商。

安装

在 SourceWeft 中

  1. 打开 控制台中的 SQL Server MCP (Windows),将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

SQL Server MCP - Cross-Platform Database Integration for AI

[License: MIT] [TypeScript] [MCP] [npm version] [npm downloads]

A Model Context Protocol (MCP) server implementation for SQL Server that enables AI assistants to explore and query SQL Server databases through natural language. Built as a RAG (Retrieval-Augmented Generation) system optimized for database knowledge exploration.

🌟 Features

  • 🔍 Schema Exploration - List databases, tables, views, stored procedures
  • 🔗 Relationship Mapping - Discover foreign key relationships and table dependencies
  • 🔎 Search & Discovery - Global schema search across tables, columns, procedures
  • ⚡ Safe Query Execution - Read-only SELECT queries with automatic timeouts and row limits
  • 🗄️ Schema Caching - Fast retrieval with configurable TTL (default: 60 minutes)
  • 🔐 Security First - Read-only by default, SQL injection prevention, query validation
  • 🖥️ Cross-Platform - Native Windows Authentication & macOS Docker support

🎥 Demo

See SQL Server MCP in action with AI assistant integration:

[SQL Server MCP Demo]

Note: Watch how natural language queries instantly explore database schemas, find relationships, and retrieve data - all without leaving your AI assistant!

🚀 Quick Start

This repository contains two platform-specific implementations:

Windows Version → sql-server-mcp/

  • ✅ Windows Authentication (ODBC Driver 17)
  • ✅ SQL Server Authentication
  • ✅ Native msnodesqlv8 driver for optimal performance
  • 📖 Windows Setup Guide

macOS Version → sql-server-mcp-mac/

  • ✅ SQL Server Authentication (Docker required)
  • ✅ Pure JavaScript mssql driver (no native dependencies)
  • 📖 macOS Setup Guide

📦 Installation

🎉 Now Available on MCP Registry!

This server is officially published in the Model Context Protocol Registry:

  • Windows: io.github.TharanaBope/sql-server-mcp
  • macOS: io.github.TharanaBope/sql-server-mcp-macos

🚀 Quick Start (Recommended)

No installation needed! Just add to your AI assistant's configuration:

Claude Desktop (Windows)

Config Location: %APPDATA%\Claude\claude_desktop_config.json

json
{  "mcpServers": {    "sql-server": {      "command": "npx",      "args": ["-y", "@tharanabopearachchi/sql-server-mcp@latest"],      "env": {        "SQL_SERVER": "localhost",        "SQL_DATABASE": "master",        "SQL_USE_WINDOWS_AUTH": "true"      }    }  }}
Claude Desktop (macOS)

Config Location: ~/Library/Application Support/Claude/claude_desktop_config.json

json
{  "mcpServers": {    "sql-server": {      "command": "npx",      "args": ["-y", "@tharanabopearachchi/sql-server-mcp-macos@latest"],      "env": {        "SQL_SERVER": "localhost",        "SQL_DATABASE": "master",        "SQL_USE_WINDOWS_AUTH": "false",        "SQL_USERNAME": "sa",        "SQL_PASSWORD": "your_password"      }    }  }}
LM Studio Configuration

Config Location: Varies by platform

  • Windows: %USERPROFILE%\.lmstudio\config.json
  • macOS: ~/.lmstudio/config.json
json
{  "mcpServers": {    "sql-server": {      "command": "npx",      "args": ["-y", "@tharanabopearachchi/sql-server-mcp@latest"],      "env": {        "SQL_SERVER": "localhost",        "SQL_DATABASE": "master",        "SQL_USE_WINDOWS_AUTH": "true",        "SQL_USERNAME": "",        "SQL_PASSWORD": ""      }    }  }}
VS Code with Continue Extension

Config Location: ~/.continue/config.json

json
{  "experimental": {    "modelContextProtocolServers": [      {        "transport": {          "type": "stdio",          "command": "npx",          "args": ["-y", "@tharanabopearachchi/sql-server-mcp@latest"]        },        "env": {          "SQL_SERVER": "localhost",          "SQL_DATABASE": "master",          "SQL_USE_WINDOWS_AUTH": "true"        }      }    ]  }}
Cursor IDE

Config Location: Cursor Settings → Features → Model Context Protocol

json
{  "mcpServers": {    "sql-server": {      "command": "npx",      "args": ["-y", "@tharanabopearachchi/sql-server-mcp@latest"],      "env": {        "SQL_SERVER": "localhost",        "SQL_DATABASE": "master",        "SQL_USE_WINDOWS_AUTH": "true"      }    }  }}
Cline (VS Code Extension)

Config Location: VS Code Settings → Cline → MCP Settings

json
{  "mcpServers": {    "sql-server": {      "command": "npx",      "args": ["-y", "@tharanabopearachchi/sql-server-mcp@latest"],      "env": {        "SQL_SERVER": "localhost",        "SQL_DATABASE": "master",        "SQL_USE_WINDOWS_AUTH": "true"      }    }  }}

Restart your AI assistant and you're ready to go!

🛠️ Development Setup

For development or local modifications:

Windows
bash
cd sql-server-mcpnpm installnpm run build

👉 Complete Windows Setup Instructions

macOS
bash
cd sql-server-mcp-macnpm installnpm run build

👉 Complete macOS Setup Instructions

🛠️ Available MCP Tools

The server provides 12 powerful tools for database exploration:

Schema Exploration

  • list_databases - Discover all available databases
  • list_tables - View tables with row counts
  • describe_table - Get detailed schema (columns, types, constraints, indexes)
  • list_views - List all views
  • list_stored_procedures - List stored procedures with metadata
  • get_procedure_definition - Get full SQL definition
  • get_database_overview - High-level statistics

Relationship Mapping

  • get_table_relationships - Get foreign key relationships (incoming & outgoing)
  • get_related_tables - Find directly connected tables

Search & Discovery

  • search_schema - Search across tables, columns, views, procedures
  • find_column_usage - Find all tables containing a specific column

Query Execution

  • execute_query - Execute read-only SELECT queries safely

💬 Example Usage

Once configured, you can ask your AI assistant:

"What databases are available on this server?"
"Show me all tables in the Sales database"
"What's the schema of the Orders table?"
"Find all tables that reference the Customers table"
"Search for any columns related to 'email'"
"Execute: SELECT TOP 10 * FROM Products ORDER BY Price DESC"

⚙️ Configuration

Both versions use environment variables for configuration:

env
SQL_SERVER=localhostSQL_DATABASE=masterSQL_PORT=1433SQL_USE_WINDOWS_AUTH=true          # Windows onlySQL_USERNAME=                       # For SQL AuthSQL_PASSWORD=                       # For SQL AuthQUERY_TIMEOUT=30MAX_RESULT_ROWS=1000ENABLE_SCHEMA_CACHE=trueCACHE_TTL_MINUTES=60

See platform-specific READMEs for detailed configuration instructions.

🔐 Security Features

  • ✅ Read-only by default - Write operations disabled unless explicitly enabled
  • ✅ Query validation - Only SELECT statements allowed by default
  • ✅ Automatic timeouts - Prevents long-running queries
  • ✅ Row limits - Prevents memory exhaustion
  • ✅ SQL injection prevention - Query sanitization and validation
  • ✅ Database whitelisting - Optional restriction to specific databases

🏗️ Architecture

MCP/├── sql-server-mcp/              # Windows implementation│   ├── src/│   │   ├── index.ts             # MCP server entry point│   │   ├── database/            # Connection, caching, queries│   │   ├── tools/               # 12 MCP tools│   │   └── types/               # TypeScript interfaces│   ├── dist/                    # Compiled output│   ├── package.json│   └── README.md                # Windows documentation│├── sql-server-mcp-mac/          # macOS implementation│   ├── src/                     # Same structure as Windows│   └── README.md                # macOS documentation│├── LICENSE                      # MIT License└── README.md                    # This file

🎯 Use Cases

Database Exploration

  • "What tables exist in this database?"
  • "Show me the structure of the Users table"
  • "List all stored procedures"

Schema Research

  • "Find all tables with an 'email' column"
  • "Search for anything related to 'invoice'"
  • "What views are available?"

Relationship Analysis

  • "How are Orders and Customers related?"
  • "Show me all tables that reference Products"
  • "What are the foreign key relationships for this table?"

Data Queries

  • "Get the top 10 most expensive products"
  • "Show me recent orders"
  • "What's the total count of records in each table?"

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

📚 Resources

🌐 Platform-Specific Documentation

PlatformDirectoryKey Features
Windowssql-server-mcp/Windows Auth, ODBC Driver, Native performance
macOSsql-server-mcp-mac/Docker SQL Server, Pure JS, No native deps

Made with ❤️ for the MCP community

⭐ Star this repo if you find it useful! 🐛 Report bugs via Issues 💬 Questions? Check the Discussions

来源:README.md,提交 9d80105

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.4最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分