Jegyzet
Az oldalhoz való hozzáférés engedélyezést igényel. Próbálhatod be jelentkezni vagy könyvtárat váltani.
Az oldalhoz való hozzáférés engedélyezést igényel. Megpróbálhatod a könyvtár váltását.
Fontos
Az SQL Model Context Protocol (MCP) kiszolgáló előzetes verzióban érhető el, és ez a dokumentáció és a motor implementációja változhat. Bár a Data API Builder 1.7-es verziója előzetes verzióban érhető el, kifejezetten az előzetes verziót kell használnia (például 1.7.83-rc), mert az MCP-funkciók még nem szerepelnek a :latest címkében.
Ez a rövid útmutató a Data API builder parancssori felületét használja egy SQL MCP-kiszolgáló helyi, Aspire nélküli futtatásához. 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 a .NET már létezik, az újratelepítés biztonságos, és csak a futtatókörnyezetet frissíti.
SQL Server 2016+
Hozzá kell férnie egy SQL Server-adatbázishoz. Az alábbi munkák bármelyike:
- SQL Server (Fejlesztő vagy Express)
- LocalDB (fájlon alapuló SQL Server)
- SQL Server Docker környezetben
A Data API builder parancssori felületének telepítése
dotnet new tool-manifest
dotnet tool install microsoft.dataapibuilder --prerelease
dotnet tool restore
Megjegyzés:
Az SQL MCP Server jelenleg előzetes verzióban van.
--prerelease A jelző használata biztosítja, hogy a Data API Builder legújabb verzióját szerezze be az ebben a rövid útmutatóban használt összes funkcióval.
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 az SQLCMD, az 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 fájlt .env a munkakönyvtárban, és adja hozzá a következő sort (testreszabás az SQL Server-adatokkal):
MSSQL_CONNECTION_STRING=Server=localhost;Database=ProductsDb;Trusted_Connection=True;TrustServerCertificate=True
Megjegyzés:
Az integrált hitelesítés (Trusted_Connection=True) Windows rendszeren 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 megadása opcionálisan
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
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. Futtassa ezt a terminált – a Visual Studio Code ehhez a HTTP-végponthoz csatlakozik.
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.
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
- Válassza a Fájl>Mappa megnyitása.
- Nyissa meg a fájlt tartalmazó
dab-config.jsonmappá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 következő tartalmat:
{
"servers": {
"sql-mcp-server": {
"type": "http",
"url": "http://localhost:5000/mcp"
}
}
}
Mentse a fájlt. A VS Code automatikusan észleli az MCP-kiszolgáló konfigurációját. Előfordulhat, hogy újra kell betöltenie az ablakot (Fejlesztőeszközök: Az ablak újratöltése a parancskatalógusból).
Az MCP-kiszolgáló kapcsolatának indítása
- Nyissa meg a parancskatalógust (Ctrl+Shift+P vagy Cmd+Shift+P macOS rendszeren).
- Futtassa az MCP:List Servers parancsot az elérhető kiszolgálók megtekintéséhez.
- Válassza ki az sql-mcp-servert , és válassza a Csatlakozás indítása lehetőséget.
A csatlakozás után az Products entitás MCP-eszközökként jelenik meg, például describe_entities és read_records. Az eszköznevek a konfigurációtól függően változhatnak.
Megjegyzés:
A VS Code MCP támogatása folyamatosan fejlődik. A konfigurációs séma a jövőbeli kiadásokban változhat. A legújabb útmutatásért tekintse meg az MCP-integráció VS Code-dokumentációját.
Eszközhívás kipróbálása
Nyissa meg a VS Code Copilot-csevegést, és próbálja ki ezt a kérdést:
Which products have an inventory under 30?