Supports configuration through environment variables loaded from .env files, allowing customization of connection settings, security parameters, timeouts, and caching behavior.
Enables deployment of the MCP server using Docker containers, with configuration via environment variables and docker-compose for simplified setup and management.
Provides access to the repository for cloning and installation, with documentation and setup instructions accessible through GitHub.
Dies ist ein Model Context Protocol (MCP)-Server für SQL Server-Interaktionen. Er ermöglicht Large Language Models (LLMs) die Ausführung von SQL-Abfragen, die Ausführung gespeicherter Prozeduren und die Untersuchung von Datenbankschemata mit erhöhter Sicherheit und Robustheit.
SELECT Abfragen für SQL Server-Datenbanken aus. Alle Abfragen werden analysiert und validiert, um sicherzustellen, dass nur SELECT -Anweisungen ausgeführt werden.SELECT -Only-Whitelist.SQL_ALLOWED_DATABASES , um zugängliche Datenbanken auf die Whitelist zu setzen.pino -Logger für detaillierte und strukturierte Anwendungsprotokolle.Vollständige Anweisungen zur Einrichtung von Docker finden Sie in der Docker-README-Datei .
Der Server wird mithilfe von Umgebungsvariablen konfiguriert. Erstellen Sie eine .env Datei im Stammverzeichnis (Sie können .env.example kopieren), um diese Werte festzulegen.
Eine ausführliche Anleitung zu allen Konfigurationsoptionen und deren Einrichtung finden Sie unter CONFIG .
| Kategorie | Variable | Beschreibung | Standard (aus config.js) |
|---|---|---|---|
| Verbindung | SQL_SERVER | SQL Server-Hostname oder IP | localhost |
SQL_PORT | SQL Server-Port | 1433 | |
SQL_USER | SQL Server-Benutzername | sa | |
SQL_PASSWORD | SQL Server-Kennwort | Erforderlich | |
SQL_DATABASE | Standarddatenbankname für die Verbindung | master | |
| Sicherheit | SQL_ENCRYPT | Verschlüsselung aktivieren (zum Deaktivieren auf false setzen) | true |
SQL_TRUST_SERVER_CERT | Serverzertifikat vertrauen (zum Deaktivieren auf false setzen) | true | |
SQL_ALLOWED_DATABASES | Komma-getrennte Liste der Datenbanken, auf die der Server zugreifen darf. Wenn diese Liste leer ist, ist der Zugriff weniger eingeschränkt (abhängig von den DB-Benutzerberechtigungen). | [] (leere Liste) | |
| Timeouts und Wiederholungsversuche | SQL_CONNECTION_TIMEOUT | Verbindungs-Timeout (ms) | 30000 |
SQL_REQUEST_TIMEOUT | Anforderungstimeout für Abfragen (ms) | 30000 | |
SQL_MAX_RETRIES | Maximale Anzahl von Wiederholungsversuchen für erste Verbindungsversuche | 3 | |
SQL_INITIAL_RETRY_DELAY | Anfängliche Verzögerung (ms) vor dem erneuten Versuch einer fehlgeschlagenen Verbindung | 1000 | |
SQL_MAX_RETRY_DELAY | Maximale Verzögerung (ms) für Verbindungswiederholungen (verwendet exponentielles Backoff) | 30000 | |
| Verbindungspool | SQL_POOL_MAX | Maximale Verbindungen im Pool | 10 |
SQL_POOL_MIN | Mindestanzahl an Verbindungen im Pool | 0 | |
SQL_POOL_IDLE_TIMEOUT | Leerlauf-Timeout für Verbindungen im Pool (ms) | 30000 | |
| Zwischenspeichern | SQL_SCHEMA_CACHE_TTL | Time-To-Live für Schema-Cache (ms) | 300000 (5 Minuten) |
| MCP-Server | MCP_SERVER_NAME | Name des MCP-Servers | MSSQL Server |
MCP_SERVER_VERSION | Version des MCP-Servers | 1.0.0 | |
| Protokollierung | LOG_LEVEL | Protokollebene für Pino-Logger (z. B. fatal , error , warn , info , debug , trace , silent ). Dies wird direkt aus process.env in server.ts gelesen und ist nicht Teil von config.js . | info |
So fügen Sie diesen MCP-Server zur Claude CLI hinzu:
Im Gespräch mit Claude können Sie:
SELECT -Abfragen aus:database ist optional, wenn mit der Standard SQL_DATABASE gearbeitet wird oder wenn SQL_ALLOWED_DATABASES eine einzelne Auswahl impliziert.)YourDatabaseName weggelassen wird, wird standardmäßig die in den Umgebungsvariablen angegebene SQL_DATABASE verwendet.)Dieser MCP-Server verwendet einen globalen, robusten Verbindungspool (integriertes Pooling der mssql Bibliothek), der vom DatabaseService verwaltet wird.
execute_query Aufrufe) vom LLM genau dieselbe zugrunde liegende Datenbankverbindung verwenden. Daher sind sitzungsspezifische Zustände wie temporäre Tabellen oder Sitzungsvariablen, die in einem Aufruf erstellt wurden, möglicherweise in einem anderen Aufruf nicht verfügbar. Jeder Aufruf sollte aus Sicht des Sitzungsstatus als atomar betrachtet werden. Der Befehl USE [database] wird innerhalb jeder Operation ausgeführt, wenn die Zieldatenbank von der Standarddatenbank des Pools abweicht, um den Kontext für diese spezifische Operation sicherzustellen.SELECT : Der Server erzwingt strikt, dass nur SELECT -Abfragen über das Tool execute_query unter Verwendung von SQL-Parsing ausgeführt werden können. DML- (INSERT, UPDATE, DELETE) und DDL-Anweisungen werden blockiert.SQL_ALLOWED_DATABASES , um die Datenbanken einzuschränken, mit denen der Server interagieren kann. Eine ausführliche Erläuterung dieser Funktion und ihrer Interaktion mit SQL_DATABASE finden Sie DATABASE_WHITELISTING.md .sp_ , xp_ ) und Befehle wie RECONFIGURE oder WAITFOR DELAY über execute_query wird blockiert. Für legitime Systeminteraktionen sollten gespeicherte Prozeduren verwendet werden.mssql Bibliothek verarbeitet, die sie normalerweise parametrisiert, um SQL-Injection zu verhindern.Wenn Probleme auftreten:
docker logs mssql-mcp (bei Verwendung von Docker)..env Datei richtig eingestellt sind, insbesondere SQL_PASSWORD , SQL_SERVER , SQL_USER und SQL_DATABASE .SQL_ALLOWED_DATABASES aufgeführt sind, wenn Sie diese Variable festgelegt haben.test-mcp.sh , test-session-persistence.sh ) müssen möglicherweise überprüft/aktualisiert werden.Ausführliche Informationen zur Fehlerbehebung bei Docker finden Sie in der Docker-README-Datei .
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Ein Model Context Protocol-Server, der es großen Sprachmodellen wie Claude ermöglicht, SQL-Abfragen auszuführen, Datenbankschemata zu untersuchen und dauerhafte Verbindungen zu SQL Server-Datenbanken aufrechtzuerhalten.