mssql-mcp 1.0.3 → 2.0.3

package/README.md

@@ -1,38 +1,18 @@
-# MS SQL Server MCP Server
+# MS SQL Server MCP Server v2.0.3
 
-Model Context Protocol (MCP) server for Microsoft SQL Server. Designed for use in IDEs like Claude Desktop, Cursor, Windsurf, and VS Code with enhanced security features.
+🚀 **Smart Trust-Based Model Context Protocol (MCP) server** for Microsoft SQL Server with intelligent auto-connection and AI-friendly design.
 
-## 🆕 Version 1.0.2 - Security & Reliability Updates
+## 🚀 Quick Start
 
-- ✅ **SQL Injection Protection**: Advanced pattern detection and parameterized query enforcement
-- ✅ **Input Validation**: Strict validation for table names, schema names, and query parameters
-- ✅ **Updated Dependencies**: Latest @modelcontextprotocol/sdk (v1.17.1)
-- ✅ **Better Error Handling**: Comprehensive logging and graceful error recovery
-- ✅ **Performance Monitoring**: Query execution time tracking
-- ✅ **Connection Security**: Enhanced SSL/TLS settings and connection pooling
+### 1. Install
 
-## Features
-
-- 🔗 **Database Connection Management**: Secure connection to MS SQL Server
-- 📊 **SQL Query Execution**: Parameterized queries and DDL/DML operations with injection protection
-- 🗂️ **Schema Management**: Tables, views, stored procedures
-- 📋 **Table Operations**: Structure inspection, data viewing, pagination
-- ⚙️ **Stored Procedures**: Execute with parameters
-- 🏢 **Database Listing**: All databases in the instance
-- 🔒 **Security**: SQL injection protection, input validation
-
-## IDE Configuration
-
-This MCP server can be used in IDEs like Claude Desktop, Cursor, Windsurf, and VS Code.
-
-### Configuration Files
-
-**For Claude Desktop**: `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
-
-**For VS Code-based IDEs**: `.vscode/mcp.json`
+```bash
+npm install -g mssql-mcp
+```
 
-### Basic Configuration
+### 2. Configure IDE
 
+**Claude Desktop** (`claude_desktop_config.json`):
 ```json
 {
   "mcpServers": {
@@ -41,10 +21,9 @@ This MCP server can be used in IDEs like Claude Desktop, Cursor, Windsurf, and V
       "args": ["-y", "mssql-mcp@latest"],
       "env": {
         "DB_SERVER": "your-server.com",
-        "DB_DATABASE": "your-database", 
+        "DB_DATABASE": "your-database",
         "DB_USER": "your-username",
         "DB_PASSWORD": "your-password",
-        "DB_PORT": "1433",
         "DB_TRUST_SERVER_CERTIFICATE": "true"
       }
     }
@@ -52,63 +31,106 @@ This MCP server can be used in IDEs like Claude Desktop, Cursor, Windsurf, and V
 }
 ```
 
-> **Note**: Use `"servers"` instead of `"mcpServers"` in VS Code-based IDEs.
+**Cursor/Windsurf/VS Code** (`.vscode/mcp.json`):
+```json
+{
+  "servers": {
+    "mssql": {
+      "command": "npx",
+      "args": ["-y", "mssql-mcp@latest"],
+      "env": {
+        "DB_SERVER": "your-server.com",
+        "DB_DATABASE": "your-database",
+        "DB_USER": "your-username",
+        "DB_PASSWORD": "your-password",
+        "DB_TRUST_SERVER_CERTIFICATE": "true"
+      }
+    }
+  }
+}
+```
+
+> Replace with your actual database credentials. Server auto-connects using these.
+
+## 🛠️ Available Tools
 
-### Platform Specific Settings
+| Tool | Description |
+|------|-------------|
+| `execute_query` | Execute any SQL query with parameters |
+| `get_schema` | List database objects (tables, views, procedures) |
+| `describe_table` | Get detailed table structure |
+| `get_table_data` | Retrieve data with pagination |
+| `execute_procedure` | Execute stored procedures |
+| `list_databases` | List all databases |
+| `connection_status` | Check connection state |
+| `connect_database` | Manual connection (rarely needed) |
+| `disconnect_database` | Close connection |
+| `clear_cache` | Clear query cache |
 
-- **macOS/Linux**: Use the configuration above as is
-- **Windows**: Use `"command": "cmd"` and `"args": ["/c", "npx", "-y", "mssql-mcp@latest"]`
-- **WSL**: Use `"command": "wsl"` and `"args": ["npx", "-y", "mssql-mcp@latest"]`
+All tools auto-connect using environment variables.
 
-## Environment Variables
+## 🔧 Environment Variables
 
-You can use the following environment variables:
+| Variable | Required | Default |
+|----------|----------|---------|
+| `DB_SERVER` | ✅ | - |
+| `DB_DATABASE` | ✅ | - |
+| `DB_USER` | ✅ | - |
+| `DB_PASSWORD` | ✅ | - |
+| `DB_PORT` | ❌ | 1433 |
+| `DB_TRUST_SERVER_CERTIFICATE` | ❌ | true |
+| `DB_CONNECTION_TIMEOUT` | ❌ | 30000 |
+| `DB_REQUEST_TIMEOUT` | ❌ | 30000 |
 
-- `DB_SERVER`: SQL Server address
-- `DB_DATABASE`: Database name
-- `DB_USER`: Username (leave empty for Windows Authentication)
-- `DB_PASSWORD`: Password
-- `DB_PORT`: Port number (default: 1433)
-- `DB_TRUST_SERVER_CERTIFICATE`: SSL certificate trust (true/false)
-- `DB_CONNECTION_TIMEOUT`: Connection timeout in milliseconds (default: 30000)
-- `DB_REQUEST_TIMEOUT`: Request timeout in milliseconds (default: 30000)
+## 🛡️ Security
 
-## Available Functions
+**✅ Supported:** All database operations (SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP)
 
-This MCP server provides 9 database operations:
+**🚨 Blocked:** Server-level operations only (SHUTDOWN, XP_CMDSHELL, RECONFIGURE)
 
-| Function | Description |
-|----------|-------------|
-| `connect_database` | Establishes connection to SQL Server |
-| `connection_status` | Checks connection status |
-| `disconnect_database` | Closes the connection |
-| `execute_query` | Executes SQL queries (SELECT, INSERT, UPDATE, DELETE) |
-| `execute_procedure` | Executes stored procedures |
-| `get_schema` | Lists database schema (tables, views, procedures) |
-| `describe_table` | Shows detailed table structure |
-| `list_databases` | Lists all databases |
-| `get_table_data` | Retrieves table data with pagination |
+## 🏆 Features
 
-## Security Notes
+- ✅ **Auto-Connection**: Environment-based, no manual steps
+- ✅ **Complete SQL Support**: All database operations
+- ✅ **No Rate Limiting**: Natural workflow
+- ✅ **Query Caching**: 5-minute TTL for SELECT queries
+- ✅ **Performance Monitoring**: Execution time tracking
+- ✅ **Latest MCP SDK**: v1.20.2 with 2025 protocol
+- ✅ **Clean Logging**: Minimal console output, MCP protocol compatible
 
-- **SQL Injection Protection**: The server includes pattern detection and enforces parameterized queries
-- **Input Validation**: All user inputs are validated and sanitized
-- **SSL/TLS**: Enable encryption for production environments
-- **Connection Pooling**: Automatic connection management with timeout settings
-- **Error Handling**: Comprehensive error logging without exposing sensitive information
-- **Parameterized Queries**: Always use parameters for user input to prevent SQL injection
+## 🔍 Troubleshooting
 
-### 🚨 Important Security Recommendations
+**❌ Auto-connection failed**
+- Set all required environment variables
+- Verify server accessibility and credentials
+- Check network connectivity
 
-1. **Use strong passwords and consider Windows Authentication**
-2. **Enable SSL/TLS encryption when possible**
-3. **Use parameterized queries for all user input**
-4. **Monitor logs for security warnings**
-5. **Regularly update the package for security fixes**
+**❌ SQL Security Alert**
+- Only server operations are blocked
+- Database operations should work normally
 
-## GitHub Repository
+## 📋 Version History
 
-This project is also available on GitHub:
+### v2.0.3 - Latest
+- ✅ Updated documentation with modern styling
+- ✅ Improved troubleshooting section
+- ✅ Enhanced feature descriptions
+
+### v2.0.2 - Performance & Compatibility
+- ✅ Simplified logging for MCP protocol compatibility
+- ✅ All console output moved to stderr
+- ✅ Clean, professional log messages
+- ✅ Version bump to 2.0.2
+
+## 📄 License
+
+MIT License
+
+## 🆘 Support
+
+- **Issues**: [GitHub Issues](https://github.com/BYMCS/mssql-mcp/issues)
 - **Repository**: [BYMCS/mssql-mcp](https://github.com/BYMCS/mssql-mcp)
-- **Issues**: For bug reports and suggestions
-- **Releases**: Release notes and downloads
+
+---
+
+**🎉 v2.0.3: Enhanced documentation and user experience**

package/dist/index.js

@@ -24,7 +24,7 @@ class MSSQLMCPServer {
     constructor() {
         this.server = new McpServer({
             name: "mssql-mcp-server",
-            version: "1.0.3",
+            version: "2.0.3",
         });
         this.setupTools();
         this.setupResources();
@@ -511,10 +511,10 @@ class MSSQLMCPServer {
         try {
             // Close existing connection if any
             if (this.pool) {
-                console.log("🔄 Closing existing database connection...");
+                console.error("Closing existing connection...");
                 await this.pool.close();
             }
-            console.log(`🔗 Connecting to SQL Server: ${config.server}:${config.port}`);
+            console.error(`Connecting to ${config.server}:${config.port}`);
             // Create new connection pool with enhanced security settings
             this.pool = new sql.ConnectionPool({
                 server: config.server,
@@ -538,17 +538,17 @@ class MSSQLMCPServer {
             });
             // Set up event handlers for better monitoring
             this.pool.on('connect', () => {
-                console.log('✅ Database connection established');
+                console.error('Database connected');
             });
             this.pool.on('error', (err) => {
-                console.error('❌ Database connection error:', err);
+                console.error('Database error:', err);
             });
             await this.pool.connect();
             this.config = config;
-            console.log(`✅ Successfully connected to database: ${config.server}${config.database ? `/${config.database}` : ''}`);
+            console.error(`Connected to ${config.server}${config.database ? `/${config.database}` : ''}`);
         }
         catch (error) {
-            console.error("❌ Database connection failed:", error);
+            console.error("Connection failed:", error);
             if (this.pool) {
                 try {
                     await this.pool.close();
@@ -566,18 +566,18 @@ class MSSQLMCPServer {
         const transport = new StdioServerTransport();
         // Enhanced graceful shutdown handling
         const shutdown = async (signal) => {
-            console.log(`\n🛑 Received ${signal}, initiating graceful shutdown...`);
+            console.error(`\nShutting down (${signal})...`);
             try {
                 if (this.pool) {
-                    console.log("🔄 Closing database connection...");
+                    console.error("Closing database connection...");
                     await this.pool.close();
-                    console.log("✅ Database connection closed");
+                    console.error("Database connection closed");
                 }
             }
             catch (error) {
-                console.error("❌ Error during shutdown:", error);
+                console.error("Shutdown error:", error);
             }
-            console.log("👋 Server shutdown complete");
+            console.error("Server stopped");
             process.exit(0);
         };
         // Handle various shutdown signals
@@ -586,20 +586,16 @@ class MSSQLMCPServer {
         process.on('SIGUSR2', () => shutdown('SIGUSR2')); // For nodemon
         // Handle uncaught exceptions
         process.on('uncaughtException', (error) => {
-            console.error('❌ Uncaught Exception:', error);
+            console.error('Uncaught Exception:', error);
             shutdown('uncaughtException');
         });
         process.on('unhandledRejection', (reason, promise) => {
-            console.error('❌ Unhandled Rejection at:', promise, 'reason:', reason);
+            console.error('Unhandled Rejection:', reason);
             shutdown('unhandledRejection');
         });
-        console.log("🚀 Starting MSSQL MCP Server v1.0.3...");
-        console.log("🔒 Security features enabled:");
-        console.log("   - SQL injection protection: Enabled");
-        console.log("   - Input validation: Enhanced");
-        console.log("   - Parameterized queries: Enforced");
+        console.error("MSSQL MCP Server v2.0.3 starting...");
         await this.server.connect(transport);
-        console.log("✅ Server connected and ready to receive requests");
+        console.error("Server ready");
     }
 }
 // Start the server

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mssql-mcp",
-  "version": "1.0.3",
+  "version": "2.0.3",
   "description": "MCP Server for MS SQL Server integration with Claude Desktop, Cursor, Windsurf and VS Code",
   "main": "dist/index.js",
   "type": "module",