Jexinsam Mssql MCP Server

🚀 MSSQL MCP Server

The MSSQL MCP Server is based on the Model Context Protocol (MCP), enabling secure and structured interactions with Microsoft SQL Server (MSSQL) databases. It allows AI assistants to perform operations like listing available tables, reading table contents, and executing controlled SQL queries, ensuring safer database exploration, strict permission enforcement, and logging of database interactions.

🚀 Quick Start

The MSSQL MCP Server provides a secure and structured way to interact with Microsoft SQL Server databases. It allows AI assistants to perform a series of operations on the database.

✨ Features

• Secure access to MSSQL databases through environment variables.
• Controlled query execution with error handling.
• Table listing and data retrieval capabilities.
• Comprehensive logging for monitoring.

📦 Installation

pip install mssql-mcp-server

📚 Documentation

Configuration

Set the following environment variables to configure database access:

MSSQL_DRIVERS=mssql_driver
MSSQL_HOST=localhost
MSSQL_USER=your_username
MSSQL_PASSWORD=your_password
MSSQL_DATABASE=your_database

Usage Examples

Integration with Claude Desktop

To integrate this configuration 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_DRIVER": "mssql_driver",
        "MSSQL_HOST": "localhost",
        "MSSQL_USER": "your_username",
        "MSSQL_PASSWORD": "your_password",
        "MSSQL_DATABASE": "your_database"
      }
    }
  }
}

Running 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/yourusername/mssql_mcp_server.git
cd mssql_mcp_server

# Set up a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

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

# Run tests
pytest

Security Considerations

⚠️ Important Note

• Use a dedicated MSSQL user with minimal privileges.
• Never use the root account or an account with full administrative privileges.
• Limit database access to only necessary operations.
• Keep comprehensive logs of database interactions.

Best Practices

💡 Usage Tip

1. Create a dedicated user: Always create a dedicated user with minimal privileges for database interactions instead of using an administrator account.
2. Avoid hard - coding credentials: Do not write passwords directly in the code. Consider using environment variables or secure secret management tools.
3. Enable logging and monitoring: Log all database activities and set up monitoring to detect abnormal behavior.
4. Regularly review permissions: Periodically check and update user access permissions to ensure no unused permissions remain.
5. Back up data: Regularly back up the database as a precaution.

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

🤝 Contribution Guidelines

To contribute to this project, follow these steps:

1. Fork the repository to your own GitHub account.
2. Create a feature branch for your changes: git checkout -b feature/your-feature-name.
3. Commit your changes: git commit -m 'Describe your changes'.
4. Push to the branch: git push origin feature/your-feature-name.
5. Open a Pull Request to the main branch.

❓ Help

If you have any questions or need assistance, feel free to submit an issue via GitHub Issues or contact the project maintainers.