Gyors kezdés: Az SQL MCP Server használata helyi Visual Studio Code környezetben

Diagram egy helyi SQL MCP Serverről, amely csatlakozik a Visual Studio Code-hoz.

Fontos

Az SQL Model Context Protocol (MCP) kiszolgáló a Data API Builder 1.7-es verziójában érhető el. A legújabb képességekhez és hibajavításokhoz használja a 2.0 előzetes kiadást.

Ez a rövid útmutató a Data API builder parancssori felületét használja az SQL Model Context Protocol (MCP) kiszolgáló helyi, Aspire nélküli futtatására. Létrehoz egy adatbázist, konfigurál egy konfigurációs fájlt, elindítja az SQL MCP Servert, és egy egyéni eszközzel csatlakozik hozzá a Visual Studio Code-ból (VS Code). Ez az elérési út a legegyszerűbb módja annak, hogy tárolók vagy üzemeltetési keretrendszerek nélkül fedezze fel az SQL MCP Servert.

Előfeltételek

Mielőtt hozzákezd, telepítse ezeket az eszközöket.

.NET 9+

Lehet, hogy már telepítve van ez az eszköz. Futtassa dotnet --version, és erősítse meg, hogy az 9.0-s vagy újabb verziót jelent. Ha .NET már létezik, az újratelepítés biztonságos, és csak a futtatókörnyezetet frissíti.

SQL Server 2016+

Hozzáférésre van szüksége egy SQL Server-adatbázishoz. Az alábbi munkák bármelyike:

  • SQL Server (Fejlesztő vagy Express)
  • LocalDB (fájl alapú SQL Server)
  • SQL Server Docker konténerben

A Data API builder parancssori felületének telepítése

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

Megjegyzés:

Az SQL MCP Server funkciói a Data API Builder 1.7-es és újabb verziójában érhetők el.

1. lépés: A mintaadatbázis létrehozása

Ebben a lépésben létrehoz egy ProductsDb nevű adatbázist, és feltölti egy Products nevű táblával.

Csatlakozzon az SQL-példányhoz SQLCMD, SQL Server Management Studio vagy bármely előnyben részesített eszköz használatával, majd futtassa a következőt:

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

A mintaadatbázis készen áll.

2. lépés: Az SQL MCP Server konfigurálása

Futtassa az összes parancsot abban a mappában, amelyben létre szeretné hozni a dab-config.json fájlt.

A környezeti fájl létrehozása

Hozzon létre egy .env nevű fájlt a munkakönyvtárban, és adja hozzá a következő sort (testreszabás a SQL Server adataival):

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

Megjegyzés:

Az integrált hitelesítés (Trusted_Connection=True) a Windows alatt működik. Az SQL-hitelesítéshez (gyakori a Docker vagy platformfüggetlenség esetén) használja a Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True-t helyette, feltéve hogy a tároló leképezi a 1433-as portot a localhost-ra.

A Data API Builder képes változókat olvasni egy helyi .env fájlból, ha az megtalálható a munkakönyvtárban. Ha a környezet nem támogatja .env a fájlokat, állítsa be MSSQL_CONNECTION_STRING környezeti változóként a terminálmunkamenetben a következő parancsok futtatása előtt.

A kiszolgáló inicializálása és konfigurálása

Futtassa az alábbi parancsot:

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

Mezőleírások hozzáadása

Warning

Mezőleírások nélkül az ügynökök csak entitásneveket látnak, és helytelenül találhatják ki az oszlopneveket. Mindig adjon hozzá mezőmetaadatokat a megfelelő ügynökműködés érdekében.

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"

Az SQL MCP Server teljes mértékben konfigurálva van.

3. lépés: Az SQL MCP Server indítása

Az SQL MCP Server két átviteli módot támogat. Válassza ki a munkafolyamatnak megfelelőt.

A lehetőség: HTTP-átvitel (a kiszolgáló külön fut)

HTTP módban a DAB-t egy hosszú ideig futó folyamatként indítja el egy terminálon, és a VS Code egy helyi HTTP-végponton keresztül csatlakozik hozzá.

Mielőtt a VS Code-ból csatlakozik, indítsa el az SQL MCP Servert egy külön terminálon.

Terminál megnyitása és futtatása

dab start --config dab-config.json

Ez a parancs elindítja az SQL MCP Servert. Az indítás után a terminál kimenete megjeleníti a figyelési URL-címeket. Ez a rövid útmutató feltételezi, hogy az MCP végpont http://localhost:5000/mcp. Tartsa futásban ezt a terminált – a Visual Studio Code csatlakozik ehhez a HTTP-végponthoz.

Megjegyzés:

A port testreszabható a futtatókörnyezet beállításainak konfigurálásával dab-config.json, vagy olyan környezeti változók beállításával, mint például ASPNETCORE_URLS.

B lehetőség: stdio átvitel (a VS Code kezeli a folyamatot)

Módban stdio a DAB gyermekfolyamatként indul el, amelyet közvetlenül a VS Code kezel. Nem szükséges terminálban futtatnia dab start – a VS Code automatikusan elindítja és leállítja a DAB-t, amikor megnyitja a munkaterületet.

Ez a mód helyi fejlesztéshez ajánlott. Nincs kezelendő HTTP-port, és nincs terminálfolyamat, amely továbbra is fut.

Megjegyzés:

Az stdio átvitelhez szükség van a "mcp": { "enabled": true } az Ön runtime szakaszábandab-config.json. További részletekért lásd stdio az SQL MCP Server átvitelét.

Ugorjon a 4. lépésre a VS Code MCP-kiszolgálódefiníciójának konfigurálásához a választott átvitelhez.

4. lépés: Csatlakozás VS Code-ból

Fontos

A munkaterület az a gyökérmappa, amelyet a VS Code projektként kezel. A beállítások és az MCP-kiszolgálódefiníciók csak abban a mappában érvényesek. Ha egyetlen fájlt nyit meg, akkor nem munkaterületen van. Meg kell nyitnia egy mappát.

A projektmappa megnyitása

  1. Válassza a Fájl>Mappa megnyitása.
  2. Nyissa meg a fájlt tartalmazó dab-config.json mappát.

Az MCP-kiszolgáló definíciójának létrehozása

Hozzon létre egy elnevezett .vscode/mcp.json fájlt, és adja hozzá a kiválasztott átvitel tartalmát.

Módban stdio a VS Code gyermekfolyamatként indítja el a DAB-t. Nincs szükség futó terminálra – a VS Code kezeli a folyamat életciklusát.

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

A pontos konfiguráció telepítéséhez használja az alábbi gombot.

Képernyőkép az MCP kiszolgáló hozzáadásáról.

Megjegyzés:

Ha korlátozni vagy bővíteni szeretné a hozzáférést, cserélje le role:anonymous az entitásengedélyekben definiált szerepkörre. A szerepkörökről és az átviteli lehetőségekről további információt az SQL MCP Server átvitelében találstdio.

  • Last updated on