Quickstart: SQL MCP Server gebruiken met Visual Studio Code lokaal

In deze quickstart wordt de DATA API Builder CLI gebruikt om lokaal een MCP-server (SQL Model Context Protocol) 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.

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 (Ontwikkelaar of 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
dotnet tool restore

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 informatie):

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

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

SQL MCP Server ondersteunt twee transportmodi. Kies de optie die past bij uw werkstroom.

Optie A: HTTP-transport (server wordt afzonderlijk uitgevoerd)

In de HTTP-modus start u DAB als een langlopend proces in een terminal en VS Code maakt er verbinding mee via een lokaal HTTP-eindpunt.

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.

Optie B: stdio transport (VS Code beheert het proces)

In stdio de modus wordt DAB gestart als een onderliggend proces dat rechtstreeks wordt beheerd door VS Code. U hoeft nietdab start in een terminal uit te voeren—VS Code start en stopt DAB automatisch wanneer u de werkruimte opent.

Deze modus wordt aanbevolen voor lokale ontwikkeling. Er is geen HTTP-poort om te beheren en er is geen terminalproces om actief te blijven.

Ga verder met stap 4 om de DEFINITIE van de VS Code MCP-server voor het gekozen transport te configureren.

Stap 4: Verbinding maken vanuit VS Code

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 inhoud voor het gekozen transport toe.

{
  "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?