Mssqlclient MCP Server

🚀 SQL Server MCP Client

The SQL Server MCP Client is a .NET-based program designed to connect to and operate on Microsoft SQL Server databases. It provides an interface for interacting with SQL Server by implementing the MCP (Microsoft Common Platform) protocol.

🚀 Quick Start

Prerequisites

1. Install the .NET runtime environment to ensure the program runs properly.
2. Make sure Docker is installed (if you want to run it via Docker).
3. Have a valid SQL Server database and the corresponding access rights.

Build Instructions

To build the project from source code, follow these steps:

1. Clone this repository to your local development environment.
2. Open a terminal or command prompt and navigate to the project's root directory.
3. Run the following command to build:

dotnet build --configuration Release

✨ Features

• Database Connection: Supports connecting to SQL Server via multiple authentication methods.
• Data Operations: Provides basic CRUD (Create, Read, Update, Delete) operation functions.
• Query Execution: Allows users to execute custom SQL queries and view result sets.
• Connection String Configuration: Can set database connection information through environment variables.

📦 Installation

Docker Support

Using Local Registry

Publish the project build results as a Docker image and run it using the following command:

docker run -it --rm -e "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;" YOUR_REGISTRY/mssqlclient:latest

Manual Docker Build

In the project's root directory, run the following command to build the Docker image:

docker build -t mssqlclient .

Then run the image using the following command:

docker run -it --rm -e "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;" mssqlclient

Docker Push

To push the image to a private or public registry, run:

docker push YOUR_REGISTRY/mssqlclient:latest

📚 Documentation

How to Use the MCP Protocol

Client Integration

There are two ways to configure the SQL Server MCP Client in the Claude desktop.

Local Installation

1. Add the server configuration to the Claude desktop's configuration file:

"mssql": {
  "command": "dotnet",
  "args": [
    "YOUR_PATH_TO_DLL\\Core.Infrastructure.McpServer.dll"
  ],
  "env": {
    "MSSQL_CONNECTIONSTRING": "Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;"
  }
}

2. Save the file and restart the Claude desktop.

Using Docker Containers

1. Add the following content to the Claude desktop configuration:

"mssql": {
  "command": "docker",
  "args": [
    "run",
    "--rm",
    "-i",
    "-e", "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;",
    "localhost:5000/mssqlclient-mcp-server:latest"
  ]
}

2. Save the file and restart the Claude desktop.

Configuration

Database Connection String

When configuring the SQL Server connection string, ensure it contains the following information:

• Server name or IP address
• Database name
• Authentication method
• Username and Password

Example connection string:

Server=my-server;Database=my-database;User Id=my-user;Password=my-password;TrustServerCertificate=True;

⚠️ Important Note

1. Ensure the security of all environment variables and configuration information to avoid exposing sensitive data.
2. Conduct thorough testing and verification before using it in a production environment.

📄 License

Refer to the project's LICENSE file for detailed licensing information.