SerenaHangSinclair/mcp-mssql-server

MCP MS SQL Server

A Model Context Protocol (MCP) server for Microsoft SQL Server that provides tools for database operations, data analysis, and visualization generation.

Table of Contents

• Features
• Quick Start
• Installation
• Configuration
• Usage
• Tools Overview
• Security
• Troubleshooting
• Development
• License

Features

8 Powerful Database Tools - Query execution, schema exploration, and data analysis
Interactive Visualizations - Bar charts, scatter plots, heatmaps, and more
Jupyter Notebook Generation - Automated analysis code creation
Power BI Integration - Export data in Power BI compatible formats
Security Controls - Granular permissions for write operations
Connection Pooling - Optimized performance with configurable pools

Quick Start

1. Install the package

   pip install mcp-mssql-server
   

2. Create configuration

   # Create .env file
   DB_TYPE=mssql
   MSSQL_SERVER=tcp:your-server.database.windows.net
   MSSQL_USER=your-username
   MSSQL_PASSWORD=your-password
   MSSQL_DATABASE=your-database
   

3. Run the server

   uv run python mssql.py
   or
   uv run python main.py
   

Installation

Option 1: Using pip

pip install mcp-mssql-server

Option 2: Using uv

uv pip install mcp-mssql-server

Option 3: From source

git clone https://github.com/SerenaHangSinclair/mcp-mssql-server.git
cd mcp-mssql-server
pip install -e .

Configuration

Create a .env file in your project root with the basic required settings:

# Database Connection (Required)
DB_TYPE=mssql
MSSQL_SERVER=tcp:your-server.database.windows.net
MSSQL_PORT=1433
MSSQL_USER=your-username
MSSQL_PASSWORD=your-password
MSSQL_DATABASE=your-database

# Security (Recommended)
ALLOW_WRITE_OPERATIONS=false

# Database Type (mssql)
DB_TYPE=mssql

# SQL Server Configuration
MSSQL_SERVER=tcp:your-server.database.windows.net
MSSQL_PORT=1433
MSSQL_USER=your-username
MSSQL_PASSWORD=your-password
MSSQL_DATABASE=your-database
MSSQL_ENCRYPT=true
MSSQL_TRUST_SERVER_CERTIFICATE=true

# Security Settings
ALLOW_WRITE_OPERATIONS=false
ALLOW_INSERT_OPERATION=false
ALLOW_UPDATE_OPERATION=false
ALLOW_DELETE_OPERATION=false

# Performance Settings
CONNECTION_POOL_MIN=1
CONNECTION_POOL_MAX=10
QUERY_TIMEOUT=30000

Usage

Running the MCP Server

Suggest to use uv to create a sperate virtual environment for the MCP construction. Remember to install uv/:

Windows

    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

MacOS/Linux

    curl -LsSf https://astral.sh/uv/install.sh | sh

    uv venv

Running the MCP Server

Basic usage:

uv run python main.py or uv run python mssql.py 

With logging enabled:

uv run python main.py --log

Using with Claude Desktop

Add this configuration to your Claude Desktop settings:

{
  "mcp-mssql-server": {
    "command": "uv",
    "args": ["run", "python", "/path/to/mcp-mssql-server/main.py"]
  }
}

Tools Overview

{
  "query": "SELECT TOP 10 * FROM users WHERE status = 'active'"
}

{
  "schema": "dbo"
}

{
  "table_name": "users",
  "schema": "dbo"
}

{
  "query": "SELECT category, SUM(amount) as total FROM sales GROUP BY category",
  "viz_type": "bar",
  "title": "Sales by Category"
}

{
  "query": "SELECT * FROM sales_data WHERE date >= '2024-01-01'",
  "output_file": "sales_analysis.ipynb"
}

Security

🔒 Built-in Security Features:

• Write operations disabled by default - All INSERT, UPDATE, DELETE operations are blocked
• Granular permissions - Enable specific operations via environment variables
• Encrypted connections - Uses TLS encryption by default
• Credential protection - Database credentials stored in .env file (excluded from git)

To enable write operations:

# Enable specific operations as needed
ALLOW_INSERT_OPERATION=true
ALLOW_UPDATE_OPERATION=true
ALLOW_DELETE_OPERATION=true

Troubleshooting

Connection Issues

Problem: Cannot connect to SQL Server

#  Check server address format
MSSQL_SERVER=tcp:your-server.database.windows.net  # For Azure SQL

#  Verify firewall settings allow your IP
#  Ensure SQL Server authentication is enabled
#  Double-check credentials in .env file

Permission Errors

Problem: Access denied or operation not allowed

#  Check security settings
ALLOW_WRITE_OPERATIONS=true  # If you need write access

#  Verify database user permissions
#  Ensure user has appropriate SQL Server roles

Visualization Errors

Problem: Charts not generating correctly

• Ensure query returns data suitable for the visualization type
• Bar/pie charts need categorical columns
• Scatter/line charts need numeric columns
• Check that query returns at least one row

Common Error Messages

Development

Extending the Server

File Structure:

• mssql.py - Database tools implementation
• main.py - MCP server interface
• .env - Configuration file

Adding New Tools:

1. Create method in MSSQLTools class
2. Add tool definition in list_tools()
3. Add handler in call_tool()

Output Files

The tools generate various output files in your working directory:

• Jupyter Notebooks: .ipynb files with analysis code
• Visualizations: .html files with interactive charts
• Power BI Data: .csv and .json files for import

License

MIT License - see the file for details.