Sdílet prostřednictvím


Rychlý start: Místní použití SQL MCP Serveru se sadou Visual Studio Code

Diagram znázorňující místní SQL MCP Server připojený k editoru Visual Studio Code

Důležité

Sql Model Context Protocol (MCP) Server je ve verzi Preview a tato dokumentace a implementace modulu se může změnit. I když je Tvůrce rozhraní API pro Data ve verzi 1.7 v režimu Preview, musíte explicitně použít předběžnou verzi (například 1.7.83-rc), protože funkce MCP ještě nejsou součástí značky :latest.

Tento rychlý návod používá CLI Data API builderu ke spuštění SQL MCP Serveru lokálně bez Aspire. Vytvoříte databázi, nakonfigurujete konfigurační soubor, spustíte SQL MCP Server a připojíte se k ní z editoru Visual Studio Code (VS Code) pomocí vlastního nástroje. Tato cesta představuje nejjednodušší způsob, jak prozkoumat SQL MCP Server bez kontejnerů nebo hostitelských architektur.

Požadavky

Než začnete, nainstalujte tyto nástroje.

.NET 9 nebo novější

Tento nástroj už možná máte nainstalovaný. Spusťte dotnet --version a zkontrolujte, jestli hlásí verzi 9.0 nebo vyšší. Pokud už rozhraní .NET existuje, přeinstalace je bezpečná a aktualizuje pouze modul runtime.

SQL Server 2016+

Potřebujete přístup k databázi SQL Serveru. Libovolná z následujících prací:

  • SQL Server (vývojář nebo Express)
  • LocalDB (souborový SQL Server)
  • SQL Server na Dockeru

Instalovat Data API builder CLI

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

Poznámka:

SQL MCP Server je aktuálně v předběžné verzi. Použití příznaku --prerelease zajišťuje, že získáte nejnovější verzi Tvůrce rozhraní Data API se všemi funkcemi použitými v tomto rychlém startu.

Krok 1: Vytvoření ukázkové databáze

V tomto kroku vytvoříte databázi s názvem ProductsDb a založíte ji jedinou tabulkou s názvem Products.

Připojte se k instanci SQL pomocí nástroje SQLCMD, SQL Server Management Studio nebo libovolného upřednostňovaného nástroje a spusťte:

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

Vaše ukázková databáze je připravená.

Krok 2: Konfigurace SQL MCP Serveru

Ve složce, ve které chcete vytvořit svůj soubor dab-config.json, spusťte všechny příkazy.

Vytvoření souboru prostředí

Vytvořte soubor s názvem .env v pracovním adresáři a přidejte následující řádek (přizpůsobte si informace o SQL Serveru):

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

Poznámka:

Integrované ověřování (Trusted_Connection=True) funguje ve Windows. Pro ověřování SQL (běžné u Dockeru nebo napříč platformami) použijte Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True místo toho (za předpokladu, že kontejner mapuje port 1433 na localhost).

Tvůrce rozhraní Data API může číst proměnné z místního .env souboru, když je v pracovním adresáři. Pokud vaše prostředí nepodporuje .env soubory, před spuštěním následujících příkazů nastavte MSSQL_CONNECTION_STRING v relaci terminálu jako proměnnou prostředí.

Inicializace a konfigurace serveru

Spusťte následující příkazy:

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

Volitelně můžete přidat popisy polí.

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"

Server SQL MCP je plně nakonfigurovaný.

Krok 3: Spuštění SQL MCP Serveru

Před připojením z nástroje VS Code spusťte SQL MCP Server v samostatném terminálu.

Otevření terminálu a spuštění

dab start --config dab-config.json

Tento příkaz spustí SQL MCP Server. Po spuštění se ve výstupu terminálu zobrazí adresy URL naslouchání. V tomto rychlém startu se předpokládá, že koncový bod MCP je http://localhost:5000/mcp. Nechte tento terminál spuštěný – Visual Studio Code se připojí k tomuto koncovému bodu HTTP.

Poznámka:

Port můžete přizpůsobit konfigurací nastavení modulu runtime ve vašem dab-config.json nebo nastavením proměnných prostředí, jako je ASPNETCORE_URLS.

Krok 4: Připojení z VS Code

Důležité

Pracovní prostor je kořenová složka, se kterou VS Code pracuje jako s vaším projektem. Definice nastavení a serveru MCP platí jenom v této složce. Pokud otevřete jeden soubor, nejste v pracovním prostoru. Musíte otevřít složku.

Otevření složky projektu

  1. Vyberte Soubor>Otevřít složku.
  2. Otevřete složku, která obsahuje váš dab-config.json soubor.

Vytvoření definice serveru MCP

Vytvořte soubor s názvem .vscode/mcp.json a přidejte následující obsah:

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

Uložte soubor. VS Code automaticky detekuje konfiguraci serveru MCP. Možná budete muset znovu načíst okno (Vývojář: Znovu načíst okno z palety příkazů).

Spuštění připojení k serveru MCP

  1. Otevřete paletu příkazů (Ctrl+Shift+P nebo Cmd+Shift+P v macOS).
  2. Spusťte MCP: Zobrazte seznam serverů a zobrazte dostupné servery.
  3. Vyberte sql-mcp-server a zvolte Spustit pro připojení.

Po připojení se entita Products zobrazí jako nástroje MCP, například describe_entities a read_records. Názvy nástrojů se můžou lišit v závislosti na vaší konfiguraci.

Poznámka:

Vyvíjí se podpora VS Code MCP. Schéma konfigurace se může v budoucích verzích změnit. Nejnovější pokyny najdete v dokumentaci k nástroji VS Code pro integraci MCP.

Zkuste volání nástroje

Otevřete chat VS Code Copilot a zkuste tuto výzvu:

Which products have an inventory under 30?