Mssql MCP Server

🚀 SQL Server MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with SQL Server databases. This server allows Large Language Models (LLMs) to query and inspect SQL Server databases through a standardized protocol.

🚀 Quick Start

Prerequisites

• .NET 8.0 SDK or a later version
• A SQL Server instance (either local or remote)

Installation

# Clone the repository
git clone https://github.com/Popplywop/mssql-mcp-server 
cd mssql-mcp-server

# Build the project
dotnet build

Running the Server

The server can be run by using a direct connection string or referencing an environment variable:

# Use a direct connection string
dotnet run --dsn "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"

# Use an environment variable
dotnet run --env-var "SQL_CONNECTION_STRING"

MCP Server Configuration

To work with Claude or other LLMs that support the Model Context Protocol, you need to configure it in the MCP configuration. Here is an example JSON configuration:

{
  "servers": [
    {
      "name": "SqlServerMcp",
      "command": "path/to/mssql-mcp-server.exe",
      "args": [
        "--dsn",
        "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"
      ]
    }
  ]
}

Replace the path and connection string with actual values. This configuration can be used for Claude's MCP integration or other LLM platforms that support the Model Context Protocol.

✨ Features

• Database Querying: Execute SQL queries and retrieve results.
• Schema Inspection: List tables, views, stored procedures, and examine table structures.

📚 Documentation

Command-Line Options

• --dsn or -d: SQL Server connection string.
• --env-var or -e: Name of the environment variable containing the connection string.

Available MCP Tools

Query Tools

• ExecuteQuery: Execute an SQL query and return the results.
  • Parameters:
    • query: The SQL query to be executed.
    • commandTimeout: Optional command timeout in seconds.
    • maxRows: Optional maximum number of rows.

Schema Tools

• ListTables: List all tables in the database.
• GetTableSchema: Get the structure of a specific table.
  • Parameters:
    • tableName: The name of the table.
• ListViews: List all views in the database.
• ListStoredProcedures: List all stored procedures in the database.
• GetDatabaseInfo: Get information about the connected database.

🔧 Technical Details

Security Considerations

• Use a SQL Server account and grant appropriate permissions (follow the principle of least privilege).
• Store the connection string securely (not in the source code).
• Consider using environment variables to store the connection string.
• Enable TLS/SSL for database connections.

💻 Usage Examples

Querying Data

ExecuteQuery:
  query: "SELECT TOP 10 * FROM MyTable"
  maxRows: 100

📄 License

This project is released under the MIT License. Please refer to the LICENSE.md file for specific details.

The MIT License is a permissive license that allows anyone to reuse the software with minimal restrictions. You are free to use, modify, and distribute the code, but you must include the original copyright notice and the license notice in the distributed work.