Início rápido: Usar SQL MCP Server com Visual Studio Code localmente

Este quickstart utiliza a CLI do Data API builder para executar localmente um servidor SQL Model Context Protocol (MCP) sem o Aspire. Crias uma base de dados, configuras um ficheiro de configuração, inicias o SQL MCP Server e ligas-te a ele a partir do Visual Studio Code (VS Code) usando uma ferramenta personalizada. Este caminho é a mais fácil de explorar o SQL MCP Server sem containers ou frameworks de alojamento.

Pré-requisitos

Instale estas ferramentas antes de começar.

.NET 9+

Talvez já tenha esta ferramenta instalada. Executa dotnet --version e confirma que reporta a versão 9.0 ou posterior. Se o .NET já estiver presente, reinstalar é seguro e só atualiza o tempo de execução.

SQL Server 2016+

Precisas de acesso a uma base de dados do SQL Server. Qualquer um dos seguintes trabalhos:

• SQL Server (Desenvolvedor ou Express)
• LocalDB (SQL Server baseado em ficheiros)
• SQL Server no Docker

Instalar a CLI do construtor de API de dados

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

Passo 1: Crie a sua base de dados de exemplos

Neste passo, cria-se uma base de dados com o nome ProductsDb e coloca-se uma única tabela chamada Products.

Ligue-se à sua instância SQL usando SQLCMD, SQL Server Management Studio ou qualquer ferramenta preferida, e depois execute:

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

A tua base de dados de exemplos está pronta.

Passo 2: Configurar SQL MCP Server

Executa todos os comandos na pasta onde queres criar o teu dab-config.json ficheiro.

Crie o seu ficheiro de ambiente

Crie um ficheiro chamado .env no seu diretório de trabalho e adicione a seguinte linha (personalize com a sua informação de SQL Server):

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

O Data API Builder pode ler variáveis de um ficheiro local .env quando estão presentes no diretório de trabalho. Se o teu ambiente não suportar .env ficheiros, define MSSQL_CONNECTION_STRING como variável de ambiente na tua sessão de terminal antes de executares os seguintes comandos.

Inicializar e configurar o servidor

Execute os seguintes comandos:

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

Opcionalmente, adicionar descrições de campos

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"

O seu servidor SQL MCP está totalmente configurado.

Passo 3: Iniciar SQL MCP Server

O SQL MCP Server suporta dois modos de transporte. Escolhe aquele que se adequa ao teu fluxo de trabalho.

Opção A: Transporte HTTP (servidor funciona separadamente)

No modo HTTP, inicia-se o DAB como um processo de longa duração num terminal e o VS Code liga-se a ele através de um endpoint HTTP local.

Antes de ligar a partir do VS Code, inicie o SQL MCP Server num terminal separado.

Abrir um terminal e executar

dab start --config dab-config.json

Este comando inicia o SQL MCP Server. Após o arranque, a saída do terminal mostra os URLs de escuta. Este quickstart assume que o endpoint MCP é http://localhost:5000/mcp. Mantenha este terminal em execução – o Visual Studio Code liga-se a este endpoint HTTP.

Opção B: stdio transporte (o VS Code gere o processo)

No modo stdio, o DAB é lançado como um processo filho gerido diretamente pelo VS Code. Não precisa de executar dab start num terminal — o VS Code inicia e desativa o DAB automaticamente quando abre a área de trabalho.

Este modo é recomendado para desenvolvimento local. Não há porta HTTP para gerir nem um processo terminal para continuar a correr.

Salta para o Passo 4 para configurar a definição do servidor MCP do VS Code para o transporte escolhido.

Passo 4: Liga-te a partir do VS Code

Abra a pasta do seu projeto

1. Selecione Ficheiro>Abrir Pasta.
2. Abra a pasta que contém o seu dab-config.json ficheiro.

Crie a definição do seu servidor MCP

Cria um ficheiro com nome .vscode/mcp.json e adiciona o conteúdo do transporte escolhido.

{
  "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?