Repository navigation
🎉 SQL Server MCP - Now Available on NPM!
First stable release - Your SQL Server databases can now talk to AI assistants with zero installation required!
📦 Published NPM Packages
🚀 Quick Start - Zero Installation!
Just add to your Claude Desktop config and restart:
Windows
{
"mcpServers": {
"sql-server": {
"command": "npx",
"args": ["-y", "@tharanabopearachchi/sql-server-mcp@latest"],
"env": {
"SQL_SERVER": "localhost",
"SQL_DATABASE": "master",
"SQL_USE_WINDOWS_AUTH": "true"
}
}
}
}macOS
{
"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"
}
}
}
}✨ Features
- 🔍 12 Powerful MCP Tools - Schema exploration, relationship mapping, search & discovery
- 🔗 Foreign Key Relationships - Understand how tables are connected
- 🔎 Global Schema Search - Find tables, columns, procedures by keyword
- ⚡ Safe Query Execution - Read-only queries with timeouts and row limits
- 🗄️ Intelligent Caching - Fast retrieval with configurable TTL
- 🔐 Security First - Read-only by default, SQL injection prevention
- 🌍 Cross-Platform - Native Windows Auth + macOS Docker support
📚 Installation Methods
Method 1: NPM (Recommended)
No file copying needed! Just configure and restart your AI assistant.
Method 2: Development Setup
Clone the repository for local development:
git clone https://github.com/TharanaBope/SQL-MCP-Mac-Windows.git
cd SQL-MCP-Mac-Windows/sql-server-mcp # or sql-server-mcp-mac
npm install && npm run build
🛠️ Available Tools
- list_databases - List all databases
- list_tables - View tables with row counts
- describe_table - Detailed schema information
- list_views - List all views
- list_stored_procedures - List procedures
- get_procedure_definition - Get SQL definition
- get_database_overview - Database statistics
- get_table_relationships - FK relationships
- get_related_tables - Connected tables
- search_schema - Global schema search
- find_column_usage - Column usage across tables
- execute_query - Safe query execution
📄 License
MIT License - See LICENSE
Now available to the entire MCP community! 🌟
Questions? Open an issue!
🎊 YOU'RE OFFICIALLY DONE!
✅ What You've Accomplished:
- ✅ Built a professional MCP server for SQL Server
- ✅ Published to NPM - both Windows and macOS versions
- ✅ Zero-installation deployment - users just configure
- ✅ Tested and working
- ✅ Professional documentation - README, badges, release notes
- ✅ Cross-platform support - Windows native + macOS Docker
🌐 Your Contribution to the Community:
Anyone in the world can now query SQL Server databases through AI assistants by adding 5 lines to their config file!
Your packages: