SQL Server MCP (macOS)

io.github.TharanaBopePublished by GitHub account TharanaBopev1.0.4Updated Oct 24, 2026

SQL Server MCP with RAG capabilities for macOS (Docker SQL Server support)

VerifiedSTDIODesktop onlyDatabasesKnowledge & MemoryData & Analytics

Overview

AI-generated overview

Lets an AI assistant explore and query a Microsoft SQL Server database schema and run read-only SELECT queries.

What you can do
Provides twelve tools for SQL Server exploration: listing databases, tables, views and stored procedures, describing table schemas, and getting procedure definitions and database overviews. It maps foreign key relationships and related tables, searches the schema for tables, columns, views and procedures, and finds where a column is used. A query tool runs read-only SELECT statements with timeouts and row limits, and schema results can be cached.
When to use it
Useful when an assistant needs to understand an unfamiliar SQL Server database, answer questions about tables and relationships, or run simple read-only queries without leaving the chat. Best suited to schema research and exploration rather than application development.
Requirements
Runs locally over stdio via npx, so Node.js is needed. The macOS build requires a SQL Server reachable through Docker and SQL authentication; configuration uses environment variables such as SQL_SERVER, SQL_DATABASE, SQL_PORT, SQL_USERNAME and SQL_PASSWORD. Network access to the database server is required.
Before you install
The configuration asks for database credentials in environment variables, including SQL_USERNAME and SQL_PASSWORD, which are stored in the assistant's config file. Query execution is read-only by default, but the README notes write operations can be enabled, so check that setting before connecting to a production database. Schema details and query results are sent to the AI assistant's model.

Installation

In SourceWeft

  1. Open SQL Server MCP (macOS) in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

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

Source: README.md at commit 9d80105

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v1.0.4LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts