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

Este início rápido utiliza a CLI do Data API Builder para executar um servidor MCP (Protocolo de Contexto de Modelo SQL) localmente sem o Aspire. Crie um banco de dados, configure um arquivo de configuração, inicie o SQL MCP Server e conecte-se a ele por meio do VS Code (Visual Studio Code) usando uma ferramenta personalizada. Esse caminho é a maneira mais fácil de explorar o SQL MCP Server sem contêineres ou estruturas de hospedagem.

Pré-requisitos

Instale essas ferramentas antes de começar.

.NET 9+

Talvez você já tenha essa ferramenta instalada. Execute dotnet --version e confirme que ele informe a versão 9.0 ou posterior. Se .NET já estiver presente, a reinstalação será segura e atualizará apenas o runtime.

SQL Server 2016+

Você precisa de acesso a um banco de dados SQL Server. Qualquer um dos seguintes trabalhos:

• SQL Server (Desenvolvedor ou Express)
• LocalDB (SQL Server baseado em arquivo)
• 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

Etapa 1: Criar seu banco de dados de exemplo

Nesta etapa, você cria um banco de dados nomeado ProductsDb e o propaga com uma única tabela chamada Products.

Conecte-se à instância do SQL usando SQLCMD, SQL Server Management Studio ou qualquer ferramenta preferencial e 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);

Seu banco de dados de exemplo está pronto.

Etapa 2: Configurar o SQL MCP Server

Execute todos os comandos na pasta em que você deseja criar seu dab-config.json arquivo.

Criar seu arquivo de ambiente

Crie um arquivo chamado .env em seu diretório de trabalho e adicione a seguinte linha (personalize com suas informações de SQL Server):

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

O construtor de API de dados pode ler variáveis de um arquivo local .env quando estiver presente no diretório de trabalho. Se o ambiente não der suporte .env a arquivos, defina MSSQL_CONNECTION_STRING como uma variável de ambiente em sua sessão de terminal antes de executar os comandos a seguir.

Inicializar e configurar o servidor

Execute os comandos a seguir:

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, adicione descrições de campo

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 SQL MCP Server está totalmente configurado.

Etapa 3: Iniciar o SQL MCP Server

O SQL MCP Server dá suporte a dois modos de transporte. Escolha aquele que se ajuste ao fluxo de trabalho.

Opção A: transporte HTTP (o servidor é executado separadamente)

No modo HTTP, você inicia o DAB como um processo em execução contínua no terminal, e o VS Code se conecta a ele por meio de um ponto de extremidade HTTP local.

Antes de se conectar do VS Code, inicie o SQL MCP Server em um terminal separado.

Abrir um terminal e executar

dab start --config dab-config.json

Esse comando inicia o SQL MCP Server. Após a inicialização, a saída do terminal mostra as URLs de escuta. Este início rápido pressupõe que o ponto de extremidade do MCP seja http://localhost:5000/mcp. Mantenha esse terminal em execução - Visual Studio Code se conecta a esse ponto de extremidade HTTP.

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

No stdio modo, o DAB é iniciado como um processo filho gerenciado diretamente pelo VS Code. Você não precisa iniciar dab start no terminal; o VS Code inicia e interrompe o DAB automaticamente quando você abre o espaço de trabalho.

Esse modo é recomendado para desenvolvimento local. Não há nenhuma porta HTTP para gerenciar e nenhum processo de terminal para continuar em execução.

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

Etapa 4: Conectar-se do VS Code

Abrir a pasta do projeto

1. Selecione Arquivo>Abrir Pasta.
2. Abra a pasta que contém o dab-config.json arquivo.

Criar sua definição de servidor MCP

Crie um arquivo nomeado .vscode/mcp.json e adicione o conteúdo para o 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?