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

Den här snabbstarten använder DATA API Builder CLI för att köra en MCP-server (SQL Model Context Protocol) 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.

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 säkert att återinstallera och det uppdaterar bara din runtid.

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
dotnet tool restore

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 HJÄLP av 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

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

SQL MCP Server stöder två transportlägen. Välj den som passar ditt arbetsflöde.

Alternativ A: HTTP-transport (servern körs separat)

I HTTP-läge startar du DAB som en tidskrävande process i en terminal och VS Code ansluter till den via en lokal HTTP-slutpunkt.

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 terminalen igång – Visual Studio Code ansluter till den här HTTP-slutpunkten.

Alternativ B: stdio transport (VS Code hanterar processen)

I stdio läge startar DAB som en underordnad process som hanteras direkt av VS Code. Du behöver inte köra dab start i en terminal – VS Code startar och stoppar DAB automatiskt när du öppnar arbetsytan.

Det här läget rekommenderas för lokal utveckling. Det finns ingen HTTP-port att hantera och ingen terminalprocess att fortsätta köra.

Gå vidare till steg 4 för att konfigurera VS Code MCP-serverdefinitionen för den valda transporten.

Steg 4: Anslut från VS Code

Ö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 innehållet för den valda transporten.

{
  "servers": {
    "sql-mcp-server": {
      "type": "stdio",
      "command": "dab",
      "args": [
        "start",
        "--mcp-stdio",
        "role:anonymous",
        "--loglevel",
        "none",
        "--config",
        "${workspaceFolder}/dab-config.json"
      ]
    }
  }
}

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

Which products have an inventory under 30?