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

• Fundição de IA do Azure
• .NET Aspire
• Código do Visual Studio
• Aplicativos de Contêiner do Azure

Importante

O SQL MCP Server está em versão prévia e esta documentação e a implementação do mecanismo estão sujeitas a alterações durante esse período de avaliação.

Este início rápido usa a CLI do construtor de API de Dados para executar um SQL MCP Server 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.

Este diagrama de arquitetura ilustra um ambiente de desenvolvimento local em que o GitHub Copilot se conecta a um contêiner do Computador Local. Dentro do contêiner, três componentes são organizados horizontalmente: VS Code (caixa laranja), um servidor MCP (Protocolo de Contexto de Modelo) (caixa 3D verde) e um banco de dados SQL (cilindro azul). O VS Code conecta-se ao servidor MCP com uma seta para a direita e o servidor MCP tem uma conexão bidirecional com o banco de dados SQL. Essa configuração permite que os desenvolvedores aproveitem a assistência de IA por meio do VS Code e do GitHub Copilot para operações de banco de dados durante o desenvolvimento local, com o servidor MCP atuando como um intermediário que converte solicitações em consultas de banco de dados.

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 o .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 do SQL Server. Qualquer um dos seguintes trabalhos:

• SQL Server (Desenvolvedor ou Express)
• LocalDB (SQL Server baseado em arquivo)
• SQL Server em 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. O uso do --prerelease sinalizador garante que você obtenha a versão mais recente do construtor de API de Dados com todos os recursos usados neste início rápido.

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 o SQLCMD, o 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 nomeado .env em seu diretório de trabalho e adicione a seguinte linha (personalize com suas informações do 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 (supondo que seu contêiner mapeia a porta 1433 para localhost).

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

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 – o Visual Studio Code se conecta a esse ponto de extremidade HTTP.

Observação

Você pode personalizar a porta configurando as configurações de runtime no seu dab-config.json ou definindo variáveis de ambiente, como ASPNETCORE_URLS.

Etapa 4: Conectar-se do VS Code

Importante

Um workspace é a pasta raiz que o VS Code trata como seu projeto. As configurações e as definições do servidor MCP só se aplicam dentro dessa pasta. Se você abrir um único arquivo, não estará em um workspace (ambiente de trabalho). Você deve abrir uma pasta.

Abrir a pasta do projeto

1. SelecioneAbrir Pasta de >.
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 seguinte conteúdo:

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

Salve o arquivo. O VS Code deve detectar a configuração do servidor MCP e conectar-se ao SQL MCP Server em execução no ponto de extremidade HTTP especificado. Talvez seja necessário recarregar a janela (Desenvolvedor: Recarregar Janela da Paleta de Comandos).

A Products entidade aparece como ferramentas MCP, como describe_entities e read_records. Os nomes de ferramentas podem variar de acordo com sua configuração.

Observação

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

Experimentar uma chamada de ferramenta

Abra o chat do VS Code e tente este prompt:

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

Você deve ver os dados da loja de brinquedos que você inseriu anteriormente.

Conteúdo relacionado

• Visão geral do SQL MCP Server
• Ferramentas de manipulação de dados no SQL MCP Server
• Adicionando descrições semânticas ao SQL MCP Server