Skip to main content

A Model Context Protocol (MCP) server that enables secure interaction with Microsoft SQL Server databases.

Project description

Microsoft SQL Server MCP Server

A Model Context Protocol (MCP) server that enables secure interaction with Microsoft SQL Server databases. This server allows AI assistants to list tables, read data, and execute SQL queries through a controlled interface, making database exploration and analysis safer and more structured.

Features

  • List available SQL Server tables as resources
  • Read table contents
  • Execute SQL queries with proper error handling
  • Secure database access through environment variables
  • Comprehensive logging
  • Automatic system dependency installation

Installation

The package will automatically install required system dependencies (like FreeTDS) when installed through MCP:

pip install mssql-mcp-server

Configuration

Set the following environment variables:

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

Usage

With Claude Desktop

Add this to your 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"
      }
    }
  }
}

As a standalone server

# Install dependencies
pip install -r requirements.txt

# Run 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 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 minimal required permissions
  • Consider implementing query whitelisting for production use
  • Monitor and log all database operations

Security Best Practices

This MCP server requires database access to function. For security:

  1. Create a dedicated SQL Server login with minimal permissions
  2. Never use sa credentials or administrative accounts
  3. Restrict database access to only necessary operations
  4. Enable logging for audit purposes
  5. Regular security reviews of database access

See SQL Server Security Configuration Guide for detailed instructions on:

  • Creating a restricted SQL Server login
  • Setting appropriate permissions
  • Monitoring database access
  • Security best practices

⚠️ IMPORTANT: Always follow the principle of least privilege when configuring database access.

License

MIT License - see LICENSE file for details.

Contributing

  1. Fork the repository
  2. Create your 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_mssql_mcp_server-0.1.0.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_mssql_mcp_server-0.1.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file mseep_mssql_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: mseep_mssql_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_mssql_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 577dbc4cc2e935e4f57453ee4712c11540cd482728632d04c39680a6f61213ed
MD5 3e8fbce59ab73ebf063335a473dc9a18
BLAKE2b-256 cd7e1790447dcf0b355927df2f3136a8e77fa1df9c3d625e458ab043bad7aed0

See more details on using hashes here.

File details

Details for the file mseep_mssql_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mseep_mssql_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 984a49a7bce37119edd9b7aa028dbfd7cc4527ca5ff3500f1a17de5e2a91cd13
MD5 98cf7f47baeb4a7d5a4c8e0a37e73030
BLAKE2b-256 2b82a767dba1123b9811ce9dd761f04cefe904075e58d553f720d0f52ae81012

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page