Démarrage rapide : Utiliser SQL MCP Server avec Visual Studio Code localement

Ce guide de démarrage rapide utilise l’interface CLI du générateur d’API de données pour exécuter localement un serveur MCP (SQL Model Context Protocol) sans Aspire. Vous créez une base de données, configurez un fichier de configuration, démarrez SQL MCP Server et connectez-vous à celle-ci à partir de Visual Studio Code (VS Code) à l’aide d’un outil personnalisé. Ce chemin est le moyen le plus simple d’explorer SQL MCP Server sans conteneurs ni infrastructure d’hébergement.

Prerequisites

Installez ces outils avant de commencer.

.NET 9+

Vous avez peut-être déjà installé cet outil. Exécutez dotnet --version et vérifiez qu’il indique la version 9.0 ou ultérieure. Si .NET est déjà présent, la réinstallation est sécurisée et actualise uniquement votre runtime.

SQL Server 2016+

Vous devez accéder à une base de données SQL Server. L’un des travaux suivants :

• SQL Server (Développeur ou Express)
• LocalDB (SQL Server basé sur des fichiers)
• SQL Server dans Docker

Installer l’interface CLI du générateur d’API de données

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

Étape 1 : Créer votre exemple de base de données

Dans cette étape, vous créez une base de données nommée ProductsDb et la mettez en valeur avec une seule table nommée Products.

Connectez-vous à votre instance SQL à l’aide de SQLCMD, de SQL Server Management Studio ou d’un outil préféré, puis exécutez :

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

Votre exemple de base de données est prêt.

Étape 2 : Configurer SQL MCP Server

Exécutez toutes les commandes dans le dossier dans lequel vous souhaitez créer votre dab-config.json fichier.

Créer votre fichier d’environnement

Créez un fichier nommé .env dans votre répertoire de travail et ajoutez la ligne suivante (personnaliser avec vos informations de SQL Server) :

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

Le générateur d'API de données peut lire des variables à partir d'un fichier local .env lorsqu'il est présent dans le répertoire de travail. Si votre environnement ne prend pas en charge .env les fichiers, définissez MSSQL_CONNECTION_STRING comme variable d’environnement dans votre session de terminal avant d’exécuter les commandes suivantes.

Initialiser et configurer le serveur

Exécutez les commandes suivantes :

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

Ajouter éventuellement des descriptions de champ

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"

Votre serveur SQL MCP est entièrement configuré.

Étape 3 : Démarrer SQL MCP Server

SQL MCP Server prend en charge deux modes de transport. Choisissez celui qui correspond à votre flux de travail.

Option A : Transport HTTP (le serveur s’exécute séparément)

En mode HTTP, vous démarrez DAB en tant que processus de longue durée dans un terminal et VS Code le connecte via un point de terminaison HTTP local.

Avant de vous connecter à partir de VS Code, démarrez le serveur SQL MCP dans un terminal distinct.

Ouvrir un terminal et exécuter

dab start --config dab-config.json

Cette commande démarre le serveur SQL MCP. Après le démarrage, la sortie du terminal affiche les URL d’écoute. Ce guide de démarrage rapide suppose que le point de terminaison MCP est http://localhost:5000/mcp. Gardez ce terminal en cours d’exécution : Visual Studio Code se connecte à ce point de terminaison HTTP.

Option B : stdio transport (VS Code gère le processus)

En stdio mode, DAB démarre en tant que processus enfant géré directement par VS Code. Vous n’avez pas besoin d’exécuter dab start dans un terminal : VS Code démarre et arrête DAB automatiquement lorsque vous ouvrez l’espace de travail.

Ce mode est recommandé pour le développement local. Il n’existe aucun port HTTP à gérer et aucun processus de terminal pour continuer à s’exécuter.

Passez à l’étape 4 pour configurer la définition du serveur VS Code MCP pour votre transport choisi.

Étape 4 : Se connecter à partir de VS Code

Ouvrir votre dossier de projet

1. Sélectionnez Fichier>Ouvrir le dossier.
2. Ouvrez le dossier qui contient votre dab-config.json fichier.

Créer votre définition de serveur MCP

Créez un fichier nommé .vscode/mcp.json et ajoutez le contenu de votre transport choisi.

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

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

Which products have an inventory under 30?