Szybki start: lokalne używanie programu SQL MCP Server z programem Visual Studio Code

• Azure AI Foundry
• .NET Aspire
• Visual Studio Code
• Azure Container Apps

Ważne

Program SQL MCP Server jest w wersji zapoznawczej, a ta dokumentacja i implementacja silnika może zostać zmieniona w tym okresie oceny.

Szybki start używa konsoli CLI Data API Builder do uruchomienia lokalnie serwera SQL MCP bez Aspire. Utworzysz bazę danych, skonfigurujesz plik konfiguracji, uruchom program SQL MCP Server i połączysz się z nią z poziomu programu Visual Studio Code (VS Code) przy użyciu narzędzia niestandardowego. Ta ścieżka jest najprostszym sposobem eksplorowania programu SQL MCP Server bez kontenerów ani struktur hostingowych.

Ten diagram architektury przedstawia lokalne środowisko programistyczne, w którym narzędzie GitHub Copilot łączy się z kontenerem komputera lokalnego. Wewnątrz kontenera trzy składniki są rozmieszczone w poziomie: VS Code (pomarańczowa skrzynka), serwer MCP (Model Context Protocol) (zielone pudełko 3D) i baza danych SQL (niebieski cylinder). Program VS Code łączy się z serwerem MCP strzałką w prawo, a serwer MCP ma dwukierunkowe połączenie z bazą danych SQL. Ta konfiguracja umożliwia deweloperom wykorzystanie pomocy w zakresie sztucznej inteligencji za pośrednictwem programu VS Code i narzędzia GitHub Copilot na potrzeby operacji bazy danych podczas programowania lokalnego, a serwer MCP działający jako pośrednik, który tłumaczy żądania na zapytania bazy danych.

Wymagania wstępne

Przed rozpoczęciem zainstaluj te narzędzia.

.NET 9+

Być może to narzędzie jest już zainstalowane. Uruchom dotnet --version i potwierdź, że raportuje wersję 9.0 lub nowszą. Jeśli platforma .NET jest już obecna, ponowna instalacja jest bezpieczna i odświeża tylko środowisko uruchomieniowe.

SQL Server 2016+

Potrzebujesz dostępu do bazy danych programu SQL Server. Dowolna z następujących czynności:

• SQL Server (Deweloper lub Express)
• LocalDB (program SQL Server oparty na plikach)
• Program SQL Server na platformie Docker

Zainstaluj narzędzie linii poleceń do budowy API danych

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

Uwaga / Notatka

Program SQL MCP Server jest obecnie w wersji wstępnej. Użycie flagi --prerelease zapewnia uzyskanie najnowszej wersji konstruktora API danych ze wszystkimi funkcjami używanymi w tej szybkiej konfiguracji.

Krok 1. Tworzenie przykładowej bazy danych

W tym kroku utworzysz bazę danych o nazwie ProductsDb i zaimkuj ją pojedynczą tabelą o nazwie Products.

Połącz się z wystąpieniem SQL, używając SQLCMD, SQL Server Management Studio lub dowolnego preferowanego narzędzia, a następnie uruchom SQLCMD:

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

Przykładowa baza danych jest gotowa.

Krok 2. Konfigurowanie programu SQL MCP Server

Uruchom wszystkie polecenia w folderze, w którym chcesz utworzyć plik dab-config.json.

Utwórz plik środowiska

Utwórz plik o nazwie .env w katalogu roboczym i dodaj następujący wiersz (dostosuj przy użyciu informacji o programie SQL Server):

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

Uwaga / Notatka

Zintegrowane uwierzytelnianie (Trusted_Connection=True) działa w systemie Windows. W przypadku uwierzytelniania SQL, występującego często z Dockerem lub w środowiskach międzyplatformowych, użyj Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True zamiast tego, przy założeniu, że kontener mapuje port 1433 na localhost.

Konstruktor API danych może odczytywać zmienne z lokalnego pliku .env, kiedy znajduje się on w katalogu roboczym. Jeśli środowisko nie obsługuje .env plików, ustaw MSSQL_CONNECTION_STRING jako zmienną środowiskową w sesji terminalu przed uruchomieniem następujących poleceń.

Inicjowanie i konfigurowanie serwera

Uruchom następujące polecenia:

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

Opcjonalnie dodaj opisy pól

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"

Serwer MCP SQL jest w pełni skonfigurowany.

Krok 3. Uruchamianie programu SQL MCP Server

Przed nawiązaniem połączenia z programu VS Code uruchom program SQL MCP Server w osobnym terminalu.

Otwieranie terminalu i uruchamianie

dab start --config dab-config.json

To polecenie uruchamia serwer SQL MCP. Po uruchomieniu dane wyjściowe terminalu zawierają adresy URL nasłuchiwania. W tym przewodniku szybkiego startu zakłada się, że punktem końcowym MCP jest http://localhost:5000/mcp. Zachowaj działanie tego terminalu — program Visual Studio Code łączy się z tym punktem końcowym HTTP.

Uwaga / Notatka

Port można dostosować, konfigurując ustawienia środowiska uruchomieniowego w programie dab-config.json lub ustawiając zmienne środowiskowe, takie jak ASPNETCORE_URLS.

Krok 4. Nawiązywanie połączenia z poziomu programu VS Code

Ważne

Obszar roboczy to folder główny, który program VS Code traktuje jako projekt. Ustawienia i definicje serwera MCP mają zastosowanie tylko w tym folderze. Jeśli otworzysz pojedynczy plik, nie jesteś w obszarze roboczym. Musisz otworzyć folder.

Otwieranie folderu projektu

1. Wybierz Plik>Otwórz folder.
2. Otwórz folder zawierający dab-config.json plik.

Tworzenie definicji serwera MCP

Utwórz plik o nazwie .vscode/mcp.json i dodaj następującą zawartość:

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

Zapisz plik. Program VS Code powinien wykryć konfigurację serwera MCP i nawiązać połączenie z uruchomionym programem SQL MCP Server w określonym punkcie końcowym HTTP. Może być konieczne ponowne załadowanie okna (deweloper: załaduj ponownie okno z palety poleceń).

Jednostka Products pojawia się jako narzędzia MCP, takie jak describe_entities i read_records. Nazwy narzędzi mogą się różnić w zależności od konfiguracji.

Uwaga / Notatka

Obsługa programu VS Code MCP ewoluuje. Schemat konfiguracji może ulec zmianie w przyszłych wersjach. Aby uzyskać najnowsze wskazówki, zobacz dokumentację programu VS Code dotyczącą integracji z programem MCP.

Wypróbuj wywołanie narzędzia

Otwórz czat programu VS Code i spróbuj wykonać ten monit:

@sql-mcp-server Which products have an inventory under 30?

Powinieneś zobaczyć dane sklepu z zabawkami, które wstawiłeś wcześniej.

Treści powiązane

• Omówienie programu SQL MCP Server
• Narzędzia do manipulowania danymi w programie SQL MCP Server
• Dodawanie opisów semantycznych do programu SQL MCP Server