Guida introduttiva: Usare SQL MCP Server con Visual Studio Code sul proprio computer

• Azure IA Foundry
• .NET Aspire
• Visual Studio Code
• App per container di Azure

Importante

SQL MCP Server è disponibile in anteprima e questa documentazione e l'implementazione del motore è soggetta a modifiche durante questo periodo di valutazione.

Questa guida introduttiva utilizza il CLI del Data API Builder per eseguire un server SQL MCP localmente senza Aspire. Si crea un database, si configura un file di configurazione, si avvia SQL MCP Server e ci si connette da Visual Studio Code (VS Code) usando uno strumento personalizzato. Questo percorso è il modo più semplice per esplorare SQL MCP Server senza contenitori o framework di hosting.

Questo diagramma dell'architettura illustra un ambiente di sviluppo locale in cui GitHub Copilot si connette a un contenitore di computer locale. All'interno del contenitore, tre componenti sono disposti orizzontalmente: VS Code (casella arancione), un server MCP (Model Context Protocol) (casella 3D verde) e un database SQL (cilindro blu). VS Code si connette al server MCP con una freccia verso destra e il server MCP dispone di una connessione bidirezionale al database SQL. Questa configurazione consente agli sviluppatori di sfruttare l'assistenza di intelligenza artificiale tramite VS Code e GitHub Copilot per le operazioni di database durante lo sviluppo locale, con il server MCP che funge da intermediario che converte le richieste in query di database.

Prerequisiti

Installare questi strumenti prima di iniziare.

.NET 9+

Questo strumento potrebbe essere già installato. Eseguire dotnet --version e confermare che segnala la versione 9.0 o successiva. Se .NET è già presente, la reinstallazione è sicura e aggiorna solo il runtime.

SQL Server 2016+

È necessario accedere a un database di SQL Server. Una delle operazioni seguenti:

• SQL Server (Developer o Express)
• LocalDB (SQL Server basato su file)
• SQL Server in Docker

Installare il CLI di Data API Builder

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

Annotazioni

SQL MCP Server è attualmente in versione preliminare. L'uso del --prerelease flag garantisce di ottenere la versione più recente di Data API Builder con tutte le funzionalità usate in questa guida introduttiva.

Passaggio 1: Creare il database di esempio

In questo passaggio viene creato un database denominato ProductsDb e ne viene eseguito il seeding con una singola tabella denominata Products.

Connettersi all'istanza di SQL usando SQLCMD, SQL Server Management Studio o qualsiasi strumento preferito, quindi eseguire:

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

Il database di esempio è pronto.

Passaggio 2: Configurare SQL MCP Server

Eseguire tutti i comandi nella cartella in cui si vuole creare il dab-config.json file.

Creare il file di ambiente

Creare un file denominato .env nella directory di lavoro e aggiungere la riga seguente (personalizzare con le informazioni di SQL Server):

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

Annotazioni

L'autenticazione integrata (Trusted_Connection=True) funziona in Windows. Per l'autenticazione SQL (comune con Docker o multipiattaforma), usare Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True invece (presupponendo che la porta 1433 venga mappata a localhost).

Il generatore di API dati può leggere le variabili da un file locale .env quando presente nella directory di lavoro. Se l'ambiente non supporta .env i file, impostare MSSQL_CONNECTION_STRING come variabile di ambiente nella sessione del terminale prima di eseguire i comandi seguenti.

Inizializzare e configurare il server

Eseguire i comandi seguenti:

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

Facoltativamente, aggiungere descrizioni dei campi

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"

SQL MCP Server è completamente configurato.

Passaggio 3: Avviare SQL MCP Server

Prima di connettersi da VS Code, avviare SQL MCP Server in un terminale separato.

Aprire un terminale ed eseguire

dab start --config dab-config.json

Questo comando avvia SQL MCP Server. Dopo l'avvio, l'output del terminale mostra gli URL di ascolto. Questa guida introduttiva presuppone che l'endpoint MCP sia http://localhost:5000/mcp. Mantenere il terminale in esecuzione: Visual Studio Code si connette a questo endpoint HTTP.

Annotazioni

È possibile personalizzare la porta configurando le impostazioni di runtime nell'oggetto dab-config.json o impostando variabili di ambiente come ASPNETCORE_URLS.

Passaggio 4: Connettersi da VS Code

Importante

Un'area di lavoro è la cartella radice che VS Code considera come progetto. Le impostazioni e le definizioni del server MCP si applicano solo all'interno di tale cartella. Se si apre un singolo file, non ci si trova in un'area di lavoro. È necessario aprire una cartella.

Aprire la cartella del progetto

1. Selezionare File>Apri cartella.
2. Aprire la cartella che contiene il dab-config.json file.

Creare la definizione del server MCP

Creare un file denominato .vscode/mcp.json e aggiungere il contenuto seguente:

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

Salva il file. VS Code dovrebbe rilevare la configurazione del server MCP e connettersi al SQL MCP Server in esecuzione all'endpoint HTTP specificato. Potrebbe essere necessario ricaricare la finestra (Sviluppatore: Ricarica finestra dal riquadro comandi).

L'entità Products viene visualizzata come strumenti MCP, ad describe_entities esempio e read_records. I nomi degli strumenti possono variare in base alla configurazione.

Annotazioni

Il supporto MCP di VS Code è in continua evoluzione. Lo schema di configurazione può cambiare nelle versioni future. Per le indicazioni più recenti, vedere la documentazione di VS Code per l'integrazione mcp.

Provare una chiamata a uno strumento

Aprire la chat di VS Code e provare questa richiesta:

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

Dovresti vedere i dati del negozio di giocattoli che hai inserito in precedenza.

Contenuti correlati

• Panoramica di SQL MCP Server
• Strumenti di manipolazione dei dati in SQL MCP Server
• Aggiunta di descrizioni semantiche al server SQL MCP