Partilhar via

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

Diagrama que mostra um servidor local SQL MCP ligado ao Visual Studio Code.

Importante

O SQL Model Context Protocol (MCP) Server está em pré-visualização, e esta documentação e a implementação do motor podem mudar. Embora a versão 1.7 do Data API builder esteja em pré-visualização, deve usar explicitamente a versão pré-lançamento (por exemplo, 1.7.83-rc) porque as funcionalidades MCP ainda não estão incluídas na :latest etiqueta.

Este quickstart utiliza a CLI Data API builder para correr um servidor SQL MCP localmente 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 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 --prerelease
dotnet tool restore

Observação

O SQL MCP Server está atualmente em pré-lançamento. Usar o --prerelease flag garante que obtém a versão mais recente do Data API builder com todas as funcionalidades usadas neste quickstart.

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 nomeado .env no seu diretório de trabalho e adicione a seguinte linha (personalize com a informação do seu SQL Server):

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

Observação

A autenticação integrada (Trusted_Connection=True) funciona no Windows. Para autenticação SQL (comum com Docker ou multiplataforma), use Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True em vez disso (assumindo que o seu contentor mapeia a porta 1433 para localhost).

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

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 conecta-se a este endpoint HTTP.

Observação

Pode personalizar a porta configurando as definições de runtime no seu dab-config.json ou definindo variáveis de ambiente como ASPNETCORE_URLS.

Passo 4: Liga-te a partir do VS Code

Importante

Um espaço de trabalho é a pasta raiz que o VS Code trata como o seu projeto. Definições e servidores MCP só se aplicam dentro dessa pasta. Se abrires um único ficheiro, não estás num espaço de trabalho. Tens de abrir uma pasta.

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

Crie um ficheiro com nome .vscode/mcp.json e adicione o seguinte conteúdo:

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

Salve o arquivo. O VS Code deteta automaticamente a configuração do servidor MCP. Pode ser necessário recarregar a janela (Desenvolvedor: Recarregar a janela a partir da Paleta de Comandos).

Iniciar a ligação ao servidor MCP

  1. Abra a paleta de comandos (Ctrl+Shift+P ou Cmd+Shift+P no macOS).
  2. Execute MCP: Servidores de Listas para visualizar os servidores disponíveis.
  3. Seleciona sql-mcp-server e escolhe Iniciar para ligar.

Uma vez ligada, a Products entidade aparece como ferramentas MCP como describe_entities e read_records. Os nomes das ferramentas podem variar consoante a sua configuração.

Observação

O suporte ao MCP do VS Code está a evoluir. O esquema de configuração pode mudar em versões futuras. Para as orientações mais recentes, consulte a documentação do VS Code para integração com MCP.

Experimente uma ferramenta chamada Call

Abra o chat do VS Code Copilot e experimente este prompt:

Which products have an inventory under 30?

Conteúdo relacionado

  • Last updated on