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

Diagram zobrazující místní server SQL MCP připojený k Visual Studio Code.

Důležité

Server MCP (SQL Model Context Protocol) je k dispozici v Tvůrci rozhraní Data API verze 1.7. Nejnovější možnosti a opravy chyb najdete ve verzi 2.0 Preview.

Tento rychlý start používá rozhraní příkazového řádku tvůrce dat ke spuštění serveru MCP (SQL Model Context Protocol) místně 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 a více

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ž .NET existuje, přeinstalace je bezpečná a aktualizuje se jenom modul runtime.

SQL Server 2016+

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

  • SQL Server (vývojář nebo Express)
  • LocalDB (SQL Server založený na souboru)
  • SQL Server ve Dockeru

Instalovat Data API builder CLI

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

Poznámka:

Funkce SQL MCP Serveru jsou k dispozici v Tvůrci rozhraní Data API verze 1.7 a novější.

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í 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í

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

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

Poznámka:

Integrované ověřování (Trusted_Connection=True) funguje na 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."

Přidání popisů polí

Warning

Bez popisů polí agenti vidí jenom názvy entit a můžou nesprávně uhodnout názvy sloupců. Pro užitečné chování agenta vždy přidejte metadata 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

SQL MCP Server podporuje dva režimy přenosu. Zvolte ten, který odpovídá vašemu pracovnímu postupu.

Možnost A: Přenos HTTP (server běží samostatně)

V režimu HTTP spustíte DAB jako dlouhotrvající proces v terminálu a VS Code se k němu připojí přes místní koncový bod HTTP.

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.

Možnost B: stdio přenos (VS Code spravuje proces)

V stdio režimu se DAB spustí jako podřízený proces spravovaný přímo nástrojem VS Code. Nemusíte spouštět dab start v terminálu – VS Code se spustí a automaticky zastaví DAB při otevření pracovního prostoru.

Tento režim se doporučuje pro místní vývoj. Není k dispozici žádný port HTTP ke správě a žádný proces terminálu, který by zůstal spuštěný.

Poznámka:

Doprava stdio vyžaduje "mcp": { "enabled": true } v runtime části vašeho dab-config.json. Úplné podrobnosti najdete stdio v přenosu pro SQL MCP Server.

Přejděte ke kroku 4 a nakonfigurujte definici serveru VS Code MCP pro zvolený přenos.

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 obsah pro vybraný přenos.

V stdio režimu VS Code spustí DAB jako podřízený proces. Spuštěný terminál nepotřebujete – VS Code spravuje životní cyklus procesu.

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

Pokud chcete nainstalovat tuto přesnou konfiguraci, použijte následující tlačítko.

Snímek obrazovky znázorňující přidání serveru MCP

Poznámka:

Pokud chcete omezit nebo rozšířit přístup, nahraďte role:anonymous rolí definovanou v oprávněních entity. Další informace o rolích a možnostech přenosu najdete v tématustdio Přenos pro SQL MCP Server.

  • Last updated on