Microsoft SQL Server (MSSQL)

🚀 Microsoft SQL Server MCP Server

A Model Context Protocol (MCP) server for securely interacting with Microsoft SQL Server databases. This server enables AI assistants to list tables, read data, and execute SQL queries with proper error handling. It allows for database exploration and analysis through a controlled interface, making the process more secure and structured.

🚀 Quick Start

This MCP server serves as a secure gateway for interacting with Microsoft SQL Server databases. It empowers AI assistants to perform various database operations while ensuring data security and structured access.

✨ Features

• List available SQL Server tables as resources.
• Read table contents.
• Execute SQL queries with proper error handling.
• Enable secure database access via environment variables.
• Provide comprehensive logging.
• Automatically install system dependencies.

📦 Installation

When installing via MCP, the required system dependencies (e.g., FreeTDS) will be automatically installed:

pip install mssql-mcp-server

📚 Documentation

Configuration

Set the following environment variables:

MSSQL_SERVER=localhost
MSSQL_USER=your_username
MSSQL_PASSWORD=your_password
MSSQL_DATABASE=your_database

Usage

Use with Claude Desktop

Add the following to claude_desktop_config.json:

{
  "mcpServers": {
    "mssql": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/mssql_mcp_server",
        "run",
        "mssql_mcp_server"
      ],
      "env": {
        "MSSQL_SERVER": "localhost",
        "MSSQL_USER": "your_username",
        "MSSQL_PASSWORD": "your_password",
        "MSSQL_DATABASE": "your_database"
      }
    }
  }
}

Run as an Independent Server

# Install dependencies
pip install -r requirements.txt

# Start the server
python -m mssql_mcp_server

Development

# Clone the repository
git clone https://github.com/RichardHan/mssql_mcp_server.git
cd mssql_mcp_server

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows

# Install development dependencies
pip install -r requirements-dev.txt

# Run tests
pytest

Security Considerations

• Never commit environment variables or credentials.
• Use a database user with the least privileges.
• Consider implementing a query whitelist in a production environment.
• Monitor and log all database operations.

Security Best Practices

This MCP server requires database access to operate. For security reasons:

1. Create a dedicated SQL Server login with minimal privileges.
2. Do not use sa credentials or administrative accounts.
3. Limit database access to only necessary operations.
4. Enable logging for auditing purposes.
5. Conduct regular security reviews of database access.

Refer to the SQL Server Security Configuration Guide for detailed instructions, including how to:

• Create a restricted SQL Server login.
• Set appropriate permissions.
• Monitor database access.
• Follow security best practices.

⚠️ Important Note

Always follow the principle of least privilege when configuring database access.

📄 License

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

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.