Snabbstart: Använda SQL MCP Server med Visual Studio Code lokalt

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

Viktigt!

SQL MCP Server är en förhandsversion och den här dokumentationen och motorimplementeringen kan komma att ändras under den här utvärderingsperioden.

Den här snabbstarten använder DATA API Builder CLI för att köra en SQL MCP-server lokalt utan Aspire. Du skapar en databas, konfigurerar en konfigurationsfil, startar SQL MCP Server och ansluter till den från Visual Studio Code (VS Code) med ett anpassat verktyg. Den här sökvägen är det enklaste sättet att utforska SQL MCP Server utan containrar eller värdramverk.

Det här arkitekturdiagrammet illustrerar en lokal utvecklingsmiljö där GitHub Copilot ansluter till en container för lokal dator. I containern ordnas tre komponenter vågrätt: VS Code (orange ruta), en MCP-server (Model Context Protocol) (grön 3D-ruta) och en SQL-databas (blå cylinder). VS Code ansluter till MCP-servern med en högerpil och MCP-servern har en dubbelriktad anslutning till SQL-databasen. Med den här konfigurationen kan utvecklare använda AI-hjälp via VS Code och GitHub Copilot för databasåtgärder under lokal utveckling, där MCP-servern fungerar som en mellanhand som översätter begäranden till databasfrågor.

Förutsättningar

Installera dessa verktyg innan du börjar.

.NET 9+

Du kanske redan har det här verktyget installerat. Kör dotnet --version och bekräfta att den rapporterar version 9.0 eller senare. Om .NET redan finns, är det tryggt att installera om och det uppdaterar bara din .NET-runtime.

SQL Server 2016+

Du behöver åtkomst till en SQL Server-databas. Något av följande arbete:

• SQL Server (utvecklare eller Express)
• LocalDB (filbaserad SQL Server)
• SQL Server i Docker

Installera CLI för Data API-builder

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

Anmärkning

SQL MCP Server är för närvarande i förhandsversion. --prerelease Med hjälp av flaggan får du den senaste versionen av Data API Builder med alla funktioner som används i den här snabbstarten.

Steg 1: Skapa exempeldatabasen

I det här steget skapar du en databas med namnet ProductsDb och skapar den med en enda tabell med namnet Products.

Anslut till din SQL-instans med SQLCMD, SQL Server Management Studio eller valfritt verktyg och kör sedan:

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

Exempeldatabasen är klar.

Steg 2: Konfigurera SQL MCP Server

Kör alla kommandon i mappen där du vill skapa dab-config.json filen.

Skapa din miljöfil

Skapa en fil med namnet .env i arbetskatalogen och lägg till följande rad (anpassa med din SQL Server-information):

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

Anmärkning

Integrerad autentisering (Trusted_Connection=True) fungerar i Windows. För SQL-autentisering (vanligt med Docker eller plattformsoberoende) använder du Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True i stället (förutsatt att containern mappar port 1433 till localhost).

Data-API-byggare kan läsa variabler från en lokal .env fil när de finns i arbetskatalogen. Om din miljö inte stöder .env filer anger du MSSQL_CONNECTION_STRING som en miljövariabel i terminalsessionen innan du kör följande kommandon.

Initiera och konfigurera servern

Kör följande kommandon:

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

Du kan också lägga till fältbeskrivningar

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"

SQL MCP-servern är helt konfigurerad.

Steg 3: Starta SQL MCP Server

Starta SQL MCP-servern i en separat terminal innan du ansluter från VS Code.

Öppna en terminal och kör

dab start --config dab-config.json

Det här kommandot startar SQL MCP Server. Efter start visar terminalutdata lyssnings-URL:er. Den här snabbstarten förutsätter att MCP-slutpunkten är http://localhost:5000/mcp. Håll den här terminalen igång – Visual Studio Code ansluter till den här HTTP-slutpunkten.

Anmärkning

Du kan anpassa porten genom att konfigurera körningsinställningarna i din dab-config.json eller genom att ange miljövariabler som ASPNETCORE_URLS.

Steg 4: Anslut från VS Code

Viktigt!

En arbetsyta är den rotmapp som VS Code behandlar som ditt projekt. Inställningar och MCP-serverdefinitioner gäller endast i den mappen. Om du öppnar en enda fil finns du inte på en arbetsyta. Du måste öppna en mapp.

Öppna projektmappen

1. Välj Arkiv>Öppna mapp.
2. Öppna mappen som innehåller dab-config.json filen.

Skapa din MCP-serverdefinition

Skapa en fil med namnet .vscode/mcp.json och lägg till följande innehåll:

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

Spara filen. VS Code bör identifiera MCP-serverkonfigurationen och ansluta till sql MCP-servern som körs vid den angivna HTTP-slutpunkten. Du kan behöva läsa in fönstret igen (Utvecklare: Läs in fönstret igen från kommandopaletten).

Entiteten Products visas som MCP-verktyg som describe_entities och read_records. Verktygsnamnen kan variera beroende på din konfiguration.

Anmärkning

Stöd för VS Code MCP utvecklas och förbättras. Konfigurationsschemat kan ändras i framtida versioner. Den senaste vägledningen finns i VS Code-dokumentationen för MCP-integrering.

Prova ett verktygsanrop

Öppna VS Code-chatten och prova den här uppmaningen:

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

Du bör se leksakslagringsdata som du infogade tidigare.

Relaterat innehåll

• Översikt över SQL MCP Server
• Verktyg för datamanipulering i SQL MCP Server
• Lägga till semantiska beskrivningar i SQL MCP Server