Quickstart: SQL MCP Server gebruiken met Visual Studio Code lokaal

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

Belangrijk

SQL MCP Server bevindt zich in de preview-fase en deze documentatie en de implementatie van de engine kan tijdens deze evaluatieperiode worden aangepast.

In deze quickstart wordt de DATA API Builder CLI gebruikt om een SQL MCP Server lokaal uit te voeren zonder Aspire. U maakt een database, configureert een configuratiebestand, start SQL MCP Server en maakt er verbinding mee vanuit Visual Studio Code (VS Code) met behulp van een aangepast hulpprogramma. Dit pad is de eenvoudigste manier om SQL MCP Server zonder containers of hostingframeworks te verkennen.

Dit architectuurdiagram illustreert een lokale ontwikkelomgeving waarbij GitHub Copilot verbinding maakt met een lokale machinecontainer. In de container worden drie onderdelen horizontaal gerangschikt: VS Code (oranje doos), een MCP-server (Model Context Protocol) (groen 3D-vak) en een SQL-database (blauwe cilinder). VS Code maakt verbinding met de MCP-server met een pijl naar rechts en de MCP-server heeft een bidirectionele verbinding met de SQL-database. Met deze installatie kunnen ontwikkelaars gebruikmaken van AI-hulp via VS Code en GitHub Copilot voor databasebewerkingen tijdens lokale ontwikkeling, waarbij de MCP-server fungeert als intermediair waarmee aanvragen worden omgezet in databasequery's.

Vereiste voorwaarden

Installeer deze hulpprogramma's voordat u begint.

.NET 9+

Mogelijk is dit hulpprogramma al geïnstalleerd. Voer dotnet --version en bevestig dat versie 9.0 of hoger wordt gerapporteerd. Als .NET al aanwezig is, is opnieuw installeren veilig en wordt uw runtime alleen vernieuwd.

SQL Server 2016+

U hebt toegang nodig tot een SQL Server-database. Een van de volgende werkzaamheden:

• SQL Server (Developer ofwel Express)
• LocalDB (op bestanden gebaseerde SQL Server)
• SQL Server in Docker

De DATA API Builder CLI installeren

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

Opmerking

SQL MCP Server bevindt zich momenteel in voorlopige versie. Door de --prerelease vlag te gebruiken, krijgt u de nieuwste versie van Data API Builder met alle functies die in deze quickstart worden gebruikt.

Stap 1: Uw voorbeelddatabase maken

In deze stap maakt u een database met de naam ProductsDb en seedt u deze met één tabel met de naam Products.

Maak verbinding met uw SQL-exemplaar met behulp van SQLCMD, SQL Server Management Studio of een gewenst hulpprogramma en voer vervolgens het volgende uit:

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);

Uw voorbeelddatabase is gereed.

Stap 2: SQL MCP-server configureren

Voer alle opdrachten uit in de map waarin u het dab-config.json bestand wilt maken.

Uw omgevingsbestand maken

Maak een bestand met de naam .env in uw werkmap en voeg de volgende regel toe (pas deze aan met uw SQL Server-gegevens):

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

Opmerking

Geïntegreerde verificatie (Trusted_Connection=True) werkt in Windows. Voor SQL-verificatie (algemeen met Docker of platformoverschrijdend) gebruikt u Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True in plaats daarvan (ervan uitgaande dat uw container poort 1433 naar localhost toewijst).

Data API Builder kan variabelen uit een lokaal .env bestand lezen wanneer deze aanwezig zijn in de werkmap. Als uw omgeving geen ondersteuning biedt voor .env bestanden, stelt u MSSQL_CONNECTION_STRING deze in als een omgevingsvariabele in uw terminalsessie voordat u de volgende opdrachten uitvoert.

De server initialiseren en configureren

Voer de volgende opdrachten uit:

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."

Desgewenst veldbeschrijvingen toevoegen

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"

Uw SQL MCP-server is volledig geconfigureerd.

Stap 3: SQL MCP Server starten

Voordat u verbinding maakt vanuit VS Code, start u de SQL MCP-server in een afzonderlijke terminal.

Een terminal openen en uitvoeren

dab start --config dab-config.json

Met deze opdracht wordt de SQL MCP-server gestart. Na het opstarten toont de terminaluitvoer de luister-URL's. In deze quickstart wordt ervan uitgegaan dat het MCP-eindpunt is http://localhost:5000/mcp. Houd deze terminal actief- Visual Studio Code maakt verbinding met dit HTTP-eindpunt.

Opmerking

U kunt de poort aanpassen door de runtime-instellingen in uw dab-config.json of door omgevingsvariabelen in te stellen, zoals ASPNETCORE_URLS.

Stap 4: Verbinding maken vanuit VS Code

Belangrijk

Een werkruimte is de hoofdmap die VS Code als uw project behandelt. Instellingen en MCP-serverdefinities zijn alleen van toepassing in die map. Als u één bestand opent, bevindt u zich niet in een werkruimte. U moet een map openen.

De projectmap openen

1. Selecteer Bestand>Map openen.
2. Open de map die het dab-config.json bestand bevat.

Uw MCP-serverdefinitie maken

Maak een bestand met de naam .vscode/mcp.json en voeg de volgende inhoud toe:

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

Sla het bestand op. VS Code moet de MCP-serverconfiguratie detecteren en verbinding maken met de actieve SQL MCP-server op het opgegeven HTTP-eindpunt. Mogelijk moet u het venster opnieuw laden (Developer: Reload Window from the Command Palette).

De Products entiteit wordt weergegeven als MCP-hulpprogramma's zoals describe_entities en read_records. Namen van hulpprogramma's kunnen variëren op basis van uw configuratie.

Opmerking

VS Code MCP-ondersteuning ontwikkelt zich. Het configuratieschema kan in toekomstige releases worden gewijzigd. Zie de VS Code-documentatie voor MCP-integratie voor de nieuwste richtlijnen.

Een hulpprogramma-aanroep proberen

Open de VS Code-chat en probeer deze prompt:

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

U zou de gegevens van de speelgoedwinkel moeten zien die u eerder hebt ingevoerd.

Verwante inhoud

• Overzicht van SQL MCP Server
• Hulpprogramma's voor gegevensmanipulatie in SQL MCP Server
• Semantische beschrijvingen toevoegen aan SQL MCP Server