tsql-mcp-server

🚧 WORK IN PROGRESS 🚧

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.

Features

• Database Querying: Execute SQL queries and retrieve results
• Schema Inspection: List tables, views, stored procedures, and examine table schemas
• SQL Injection Prevention: Built-in validation to prevent SQL injection attacks
• Resource Caching: Metadata caching for improved performance

Getting Started

Prerequisites

• .NET 8.0 SDK or later
• SQL Server instance (local or remote)

Installation

Option 1: Install as a .NET Tool (Recommended)

Install globally as a .NET tool:

dotnet tool install --global tsql-mcp-server

To update to the latest version:

dotnet tool update --global tsql-mcp-server

Option 2: Build from Source

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

# Build the project
dotnet build

Running the Server

Using the .NET Tool

If installed as a .NET global tool:

# Using a direct connection string
tsql-mcp-server --dsn "Server=your-server;Database=your-database;User Id=your-username;Password=your-password;TrustServerCertificate=True;"

# Using an environment variable
tsql-mcp-server --env-var "SQL_CONNECTION_STRING"

Using Source Code

If building from source:

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

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

MCP Server Configuration

To use this server with Claude or other LLMs that support the Model Context Protocol, you'll need to configure it in your MCP configuration file.

If Installed as a .NET Tool

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

If Built from Source

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

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

Using Environment Variables for Sensitive Information

For better security, you can use environment variables for your connection string:

{
  "servers": [
    {
      "name": "SqlServerMcp",
      "command": "tsql-mcp-server",
      "args": [
        "--env-var",
        "SQL_CONNECTION_STRING"
      ]
    }
  ]
}

Command Line Options

• --dsn or -d: SQL Server connection string
• --env-var or -e: Environment variable name containing the connection string

Available MCP Tools

Query Tools

• ExecuteQuery: Executes a SQL query against the database and returns the results
  • Parameters:
    • query: The SQL query to execute
    • commandTimeout: Optional command timeout in seconds
    • maxRows: Optional maximum number of rows to return

Database Resources

The server provides database schema information through a resource-based approach. Resources are accessed via URIs and are lazy-loaded with caching for improved performance.

Resource URI	Description	Loading Behavior
sqlserver://schemas/{schema_name}	Information about a specific schema	Loaded on first request, cached for 10 minutes
sqlserver://schemas/{schema_name}/tables	List of tables in a schema	Loaded on first request, cached for 10 minutes
sqlserver://schemas/{schema_name}/views	List of views in a schema	Loaded on first request, cached for 10 minutes
sqlserver://schemas/{schema_name}/procedures	List of stored procedures in a schema	Loaded on first request, cached for 10 minutes
sqlserver://schemas/{schema_name}/tables/{table_name}	Detailed information about a specific table	Loaded on first request, cached for 10 minutes
sqlserver://schemas/{schema_name}/views/{view_name}	Detailed information about a specific view	Loaded on first request, cached for 10 minutes
sqlserver://schemas/{schema_name}/procedures/{procedure_name}	Detailed information about a specific procedure	Loaded on first request, cached for 10 minutes

Resources are automatically discovered by the MCP client and can be accessed directly without requiring specific tool calls.

Security Considerations

• Use a SQL Server account with appropriate permissions (principle of least privilege)
• Store connection strings securely (not in source control)
• Consider using environment variables for connection strings
• Enable TLS/SSL for database connections
• SQL injection validation prevents dangerous operations and protects against common attack vectors

Example Usage

Querying Data

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

Accessing Database Resources

Resources can be accessed directly via their URIs:

# List all schemas
GET sqlserver://schemas

# Get information about a specific schema
GET sqlserver://schemas/dbo

# List all tables in a schema
GET sqlserver://schemas/dbo/tables

# Get detailed information about a specific table
GET sqlserver://schemas/dbo/tables/Customers

The resource-based approach provides a RESTful way to explore and interact with the database schema.

License

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

The MIT License is a permissive license that allows for reuse with minimal restrictions. It permits anyone to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to the condition that the original copyright notice and permission notice appear in all copies.