Schnellstart: Lokales Verwenden von SQL MCP Server mit Visual Studio Code

• Azure AI Foundry
• .NET Aspire
• Visual Studio Code
• Azure-Container-Apps

Von Bedeutung

SQL MCP Server befindet sich in der Vorschau, und diese Dokumentation und die Modulimplementierung kann während dieses Auswertungszeitraums geändert werden.

Diese Schnellstartanleitung verwendet die Data API Builder CLI, um einen SQL MCP Server lokal ohne Aspire auszuführen. Sie erstellen eine Datenbank, konfigurieren eine Konfigurationsdatei, starten SQL MCP Server und stellen mithilfe eines benutzerdefinierten Tools eine Verbindung mit der Datenbank aus Visual Studio Code (VS Code) her. Dieser Pfad ist die einfachste Möglichkeit, SQL MCP Server ohne Container oder Hostingframeworks zu erkunden.

Dieses Architekturdiagramm veranschaulicht eine lokale Entwicklungsumgebung, in der GitHub Copilot eine Verbindung mit einem Container "Lokaler Computer" herstellt. Innerhalb des Containers werden drei Komponenten horizontal angeordnet: VS Code (orange box), ein MCP(Model Context Protocol)-Server (grünes 3D-Feld) und eine SQL-Datenbank (blauer Zylinder). VS Code stellt eine Verbindung mit dem MCP-Server mit einem Pfeil nach rechts und der MCP-Server verfügt über eine bidirektionale Verbindung mit der SQL-Datenbank. Mit diesem Setup können Entwickler KI-Unterstützung über VS Code und GitHub Copilot für Datenbankvorgänge während der lokalen Entwicklung nutzen, wobei der MCP-Server als Vermittler fungiert, der Anforderungen in Datenbankabfragen übersetzt.

Voraussetzungen

Installieren Sie diese Tools, bevor Sie beginnen.

.NET 9+

Möglicherweise ist dieses Tool bereits installiert. Führen Sie dotnet --version aus, und bestätigen Sie, dass es Version 9.0 oder höher meldet. Wenn .NET bereits vorhanden ist, ist die erneute Installation sicher und aktualisiert nur Ihre Laufzeit.

SQL Server 2016+

Sie benötigen Zugriff auf eine SQL Server-Datenbank. Eine der folgenden Arbeiten:

• SQL Server (Entwickler oder Express)
• LocalDB (dateibasierter SQL Server)
• SQL Server in Docker

Installieren des Daten-API-Generators CLI

dotnet new tool-manifest
dotnet tool install microsoft.dataapibuilder --prerelease
dotnet tool restore

Hinweis

SQL MCP Server befindet sich derzeit in der Vorabversion. Durch die Verwendung des --prerelease Flags wird sichergestellt, dass Sie die neueste Version des Daten-API-Generators mit allen features erhalten, die in dieser Schnellstartanleitung verwendet werden.

Schritt 1: Erstellen der Beispieldatenbank

In diesem Schritt erstellen Sie eine Datenbank namens ProductsDb und seeden sie mit einer einzigen Tabelle mit dem Namen Products.

Stellen Sie eine Verbindung mit Ihrer SQL-Instanz mithilfe von SQLCMD, SQL Server Management Studio oder einem beliebigen bevorzugten Tool her, und führen Sie dann Folgendes aus:

CREATE DATABASE ProductsDb;
GO

USE ProductsDb;
GO

CREATE TABLE dbo.Products (
    Id INT PRIMARY KEY,
    Name NVARCHAR(100) NOT NULL,
    Inventory INT NOT NULL,
    Price DECIMAL(10,2) NOT NULL,
    Cost DECIMAL(10,2) NOT NULL
);

INSERT INTO dbo.Products (Id, Name, Inventory, Price, Cost)
VALUES
    (1, 'Action Figure', 40, 14.99, 5.00),
    (2, 'Building Blocks', 25, 29.99, 10.00),
    (3, 'Puzzle 500 pcs', 30, 12.49, 4.00),
    (4, 'Toy Car', 50, 7.99, 2.50),
    (5, 'Board Game', 20, 34.99, 12.50),
    (6, 'Doll House', 10, 79.99, 30.00),
    (7, 'Stuffed Bear', 45, 15.99, 6.00),
    (8, 'Water Blaster', 35, 19.99, 7.00),
    (9, 'Art Kit', 28, 24.99, 8.00),
    (10,'RC Helicopter', 12, 59.99, 22.00);

Ihre Beispieldatenbank ist bereit.

Schritt 2: Konfigurieren des SQL MCP-Servers

Führen Sie alle Befehle im Ordner aus, in dem Sie Ihre dab-config.json Datei erstellen möchten.

Erstellen der Umgebungsdatei

Erstellen Sie eine Datei mit dem Namen .env in Ihrem Arbeitsverzeichnis, und fügen Sie die folgende Zeile hinzu (passen Sie die SQL Server-Informationen an):

MSSQL_CONNECTION_STRING=Server=localhost;Database=ProductsDb;Trusted_Connection=True;TrustServerCertificate=True

Hinweis

Die integrierte Authentifizierung (Trusted_Connection=True) funktioniert unter Windows. Verwenden Sie stattdessen Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True für die SQL-Authentifizierung, die häufig mit Docker oder plattformübergreifend verwendet wird, vorausgesetzt, Ihr Container ordnet Port 1433 localhost zu.

Der Daten-API-Generator kann Variablen aus einer lokalen .env Datei lesen, wenn sie im Arbeitsverzeichnis vorhanden sind. Bevor Sie die folgenden Befehle ausführen, legen Sie .env in Ihrer Terminalsitzung als Umgebungsvariable fest, wenn Ihre Umgebung die Dateien MSSQL_CONNECTION_STRING nicht unterstützt.

Initialisieren und Konfigurieren des Servers

Führen Sie die folgenden Befehle aus:

dab init --database-type mssql --connection-string "@env('MSSQL_CONNECTION_STRING')" --host-mode Development --config dab-config.json

dab add Products --source dbo.Products --permissions "anonymous:read" --description "Toy store products with inventory, price, and cost."

Feldbeschreibungen optional hinzufügen

dab update Products --fields.name Id --fields.primary-key true --fields.description "Product Id"
dab update Products --fields.name Name --fields.description "Product name"
dab update Products --fields.name Inventory --fields.description "Units in stock"
dab update Products --fields.name Price --fields.description "Retail price"
dab update Products --fields.name Cost --fields.description "Store cost"

Ihr SQL MCP Server ist vollständig konfiguriert.

Schritt 3: Starten des SQL MCP-Servers

Starten Sie vor dem Herstellen einer Verbindung von VS Code den SQL MCP-Server in einem separaten Terminal.

Öffnen eines Terminals und Ausführen

dab start --config dab-config.json

Mit diesem Befehl wird der SQL MCP-Server gestartet. Nach dem Start zeigt die Terminalausgabe die Zuhör-URLs an. In dieser Schnellstartanleitung wird davon ausgegangen, dass der MCP-Endpunkt ist http://localhost:5000/mcp. Führen Sie dieses Terminal aus– Visual Studio Code stellt eine Verbindung mit diesem HTTP-Endpunkt bereit.

Hinweis

Sie können den Port anpassen, indem Sie entweder die Laufzeiteinstellungen in Ihrem dab-config.json konfigurieren oder Umgebungsvariablen wie z. B. ASPNETCORE_URLS festlegen.

Schritt 4: Herstellen einer Verbindung mit VS-Code

Von Bedeutung

Ein Arbeitsbereich ist der Stammordner, den VS Code als Projekt behandelt. Einstellungen und MCP-Serverdefinitionen gelten nur innerhalb dieses Ordners. Wenn Sie eine einzelne Datei öffnen, befinden Sie sich nicht in einem Arbeitsbereich. Sie müssen einen Ordner öffnen.

Öffnen des Projektordners

1. Wählen Sie Datei>Ordner öffnen aus.
2. Öffnen Sie den Ordner, der Ihre dab-config.json Datei enthält.

Erstellen der MCP-Serverdefinition

Erstellen Sie eine Datei mit dem Namen .vscode/mcp.json , und fügen Sie den folgenden Inhalt hinzu:

{
  "servers": {
    "sql-mcp-server": {
      "type": "http",
      "url": "http://localhost:5000/mcp"
    }
  }
}

Speichern Sie die Datei. VS Code sollte die MCP-Serverkonfiguration erkennen und eine Verbindung mit dem ausgeführten SQL MCP Server am angegebenen HTTP-Endpunkt herstellen. Möglicherweise müssen Sie das Fenster erneut laden (Entwickler: Fenster aus der Befehlspalette neu laden).

Die Products Entität erscheint als MCP-Tools wie describe_entities und read_records. Die Toolnamen können je nach Konfiguration variieren.

Hinweis

VS Code MCP-Unterstützung entwickelt sich weiter. Das Konfigurationsschema kann sich in zukünftigen Versionen ändern. Die neuesten Anleitungen finden Sie in der VS Code-Dokumentation für die MCP-Integration.

Testen eines Toolaufrufs

Öffnen Sie den VS Code-Chat, und probieren Sie diese Eingabeaufforderung aus:

@sql-mcp-server Which products have an inventory under 30?

Sie sollten die zuvor eingefügten Toyspeicherdaten sehen.

Verwandte Inhalte

• Übersicht über SQL MCP Server
• Datenmanipulationstools in SQL MCP Server
• Hinzufügen von semantischen Beschreibungen zu SQL MCP Server