Краткое руководство: использование SQL MCP Server с Visual Studio Code локально

• Azure AI Foundry
• .NET Aspire
• Visual Studio Code
• Приложения контейнеров Azure

Это важно

SQL MCP Server находится в предварительной версии, и эта документация, и реализация подсистемы подлежит изменению в течение этого ознакомительного периода.

В этом кратком руководстве используется CLI Data API Builder для локального запуска SQL MCP Server без Aspire. Вы создаете базу данных, настраиваете файл конфигурации, запускаете SQL MCP Server и подключаетесь к ней из Visual Studio Code (VS Code) с помощью пользовательского средства. Это самый простой способ изучения SQL MCP Server без контейнеров или платформ размещения.

На этой схеме архитектуры показана локальная среда разработки, в которой GitHub Copilot подключается к контейнеру локального компьютера. Внутри контейнера три компонента расположены горизонтально: VS Code (оранжевый прямоугольник), сервер MCP (зеленый трехмерный прямоугольник) и база данных SQL (синий цилиндр). VS Code подключается к серверу MCP со стрелкой вправо, а сервер MCP имеет двунаправленное подключение к базе данных SQL. Эта настройка позволяет разработчикам использовать помощь искусственного интеллекта с помощью VS Code и GitHub Copilot для операций с базами данных во время локальной разработки, с сервером MCP, который выступает в качестве посредника, который преобразует запросы в запросы к базе данных.

Предпосылки

Установите эти средства перед началом работы.

.NET 9+

Возможно, у вас уже установлено это средство. Запустите dotnet --version и подтвердите, что он сообщает о версии 9.0 или более поздней. Если .NET уже присутствует, переустановка безопасна и обновляет среду выполнения.

SQL Server 2016+

Вам нужен доступ к базе данных SQL Server. Любая из следующих работ:

• SQL Server (разработчик или Экспресс)
• LocalDB (SQL Server на основе файлов)
• SQL Server в Docker

Установка интерфейса командной строки построителя API данных

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

Замечание

SQL MCP Server в настоящее время находится в предварительном выпуске. Использование флага --prerelease гарантирует, что вы получите последнюю версию конструктора API данных со всеми функциями, используемыми в этом кратком руководстве.

Шаг 1. Создание образца базы данных

На этом шаге вы создадите базу данных с именем ProductsDb и заполните ее единственной таблицей с именем Products.

Подключитесь к экземпляру SQL с помощью SQLCMD, SQL Server Management Studio или любого предпочтительного средства, а затем выполните следующую команду:

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

Пример базы данных готов.

Шаг 2. Настройка SQL MCP Server

Выполните все команды в папке, в которой нужно создать dab-config.json файл.

Создание файла среды

Создайте файл с именем .env в рабочем каталоге и добавьте следующую строку (настройте с помощью сведений SQL Server):

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

Замечание

Встроенная проверка подлинности (Trusted_Connection=True) работает в Windows. Для аутентификации SQL (обычно используется с Docker или в кроссплатформенных проектах) используйте Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True вместо этого, при условии, что ваш контейнер отображает порт 1433 на localhost.

Конструктор данных может считывать переменные из локального файла .env, если он присутствует в текущем рабочем каталоге. Если среда не поддерживает .env файлы, задайте MSSQL_CONNECTION_STRING переменную среды в сеансе терминала перед выполнением следующих команд.

Инициализация и настройка сервера

Выполните следующие команды:

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

При необходимости добавьте описания полей

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"

Сервер SQL MCP полностью настроен.

Шаг 3. Запуск SQL MCP Server

Перед подключением из VS Code запустите SQL MCP Server в отдельном терминале.

Открытие терминала и запуск

dab start --config dab-config.json

Эта команда запускает SQL MCP Server. После запуска выходные данные терминала отображают URL-адреса прослушивания. В этом кратком руководстве предполагается, что конечная точка MCP — http://localhost:5000/mcp. Продолжайте работу этого терминала. Visual Studio Code подключается к этой конечной точке HTTP.

Замечание

Вы можете настроить порт, изменив параметры времени выполнения в dab-config.json или установив такие переменные среды, как ASPNETCORE_URLS.

Шаг 4. Подключение из VS Code

Это важно

Рабочая область — это корневая папка, которую VS Code обрабатывает как проект. Параметры и определения сервера MCP применяются только внутри этой папки. Если открыть один файл, вы не находитесь в рабочем пространстве. Необходимо открыть папку.

Открытие папки проекта

1. Выберите Файл>Открыть папку.
2. Откройте папку, содержащую dab-config.json файл.

Создание определения сервера MCP

Создайте файл с именем .vscode/mcp.json и добавьте следующее содержимое:

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

Сохраните файл. VS Code должен обнаруживать конфигурацию сервера MCP и подключаться к работающему СЕРВЕРУ SQL MCP в указанной конечной точке HTTP. Может потребоваться перезагрузить окно (разработчик: перезагрузить окно из палитры команд).

Сущность Products отображается как средства MCP, такие как describe_entities и read_records. Имена инструментов могут отличаться в зависимости от конфигурации.

Замечание

Поддержка VS Code MCP развивается. Схема конфигурации может измениться в будущих выпусках. Последние инструкции см. в документации по VS Code для интеграции MCP.

Попробуйте вызвать средство

Откройте чат VS Code и попробуйте сделать следующее:

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

Вы должны увидеть данные магазина игрушек, которые вы вставили ранее.

Связанный контент

• Обзор SQL MCP Server
• Средства обработки данных в SQL MCP Server
• Добавление семантических описаний в SQL MCP Server