Inicio rápido: Uso de SQL MCP Server con Visual Studio Code localmente

• Azure AI Foundry
• .NET Aspire
• Visual Studio Code
• Azure Container Apps

Importante

SQL MCP Server está en versión preliminar y esta documentación y la implementación del motor está sujeta a cambios durante este período de evaluación.

En este inicio rápido se usa la CLI del Generador de API de datos para ejecutar un servidor MCP de SQL localmente sin Aspire. Cree una base de datos, configure un archivo de configuración, inicie SQL MCP Server y conéctese a ella desde Visual Studio Code (VS Code) mediante una herramienta personalizada. Esta ruta de acceso es la manera más fácil de explorar SQL MCP Server sin contenedores ni marcos de hospedaje.

En este diagrama de arquitectura se muestra un entorno de desarrollo local donde GitHub Copilot se conecta a un contenedor de máquinas locales. Dentro del contenedor, se organizan horizontalmente tres componentes: VS Code (cuadro naranja), un servidor MCP (Protocolo de contexto de modelo) (cuadro verde 3D) y una base de datos SQL (cilindro azul). VS Code se conecta al servidor MCP con una flecha hacia la derecha y el servidor MCP tiene una conexión bidireccional a la base de datos SQL. Esta configuración permite a los desarrolladores aprovechar la asistencia de inteligencia artificial a través de VS Code y GitHub Copilot para las operaciones de base de datos durante el desarrollo local, con el servidor MCP que actúa como intermediario que traduce las solicitudes en consultas de base de datos.

Prerrequisitos

Instale estas herramientas antes de empezar.

.NET 9+

Es posible que ya tenga instalada esta herramienta. Ejecute dotnet --version y confirme que informa de la versión 9.0 o posterior. Si .NET ya está presente, la reinstalación es segura y solo actualiza el entorno de ejecución.

SQL Server 2016+

Necesita acceso a una base de datos de SQL Server. Cualquiera de los siguientes trabajos:

• SQL Server (Desarrollador o Express)
• LocalDB (SQL Server basado en archivos)
• SQL Server en Docker

Instalación de la CLI de Data API Builder

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

Nota:

SQL MCP Server se encuentra actualmente en versión preliminar. El uso de la --prerelease marca garantiza que obtiene la versión más reciente de Data API Builder con todas las características que se usan en este inicio rápido.

Paso 1: Crear la base de datos de ejemplo

En este paso, creará una base de datos denominada ProductsDb y la inicializará con una sola tabla denominada Products.

Conéctese a la instancia de SQL mediante SQLCMD, SQL Server Management Studio o cualquier herramienta preferida y, a continuación, ejecute lo siguiente:

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

La base de datos de ejemplo está lista.

Paso 2: Configurar SQL MCP Server

Ejecute todos los comandos de la carpeta donde desea crear el dab-config.json archivo.

Creación del archivo de entorno

Cree un archivo denominado .env en el directorio de trabajo y agregue la siguiente línea (personalice con la información de SQL Server):

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

Nota:

La autenticación integrada (Trusted_Connection=True) funciona en Windows. Para la autenticación de SQL (común con Docker o multiplataforma), use Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True en su lugar (suponiendo que el puerto 1433 del contenedor se asigna a localhost).

El generador de API de datos puede leer variables de un archivo local .env cuando está presente en el directorio de trabajo. Si el entorno no admite .env archivos, establezca MSSQL_CONNECTION_STRING como una variable de entorno en la sesión de terminal antes de ejecutar los comandos siguientes.

Inicialización y configuración del servidor

Ejecute los comandos siguientes:

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, agregue descripciones 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"

El servidor MCP de SQL está totalmente configurado.

Paso 3: Iniciar SQL MCP Server

Antes de conectarse desde VS Code, inicie SQL MCP Server en un terminal independiente.

Apertura de un terminal y ejecución

dab start --config dab-config.json

Este comando inicia el servidor MCP de SQL. Después del inicio, la salida del terminal muestra las direcciones URL de escucha. En este inicio rápido se supone que el punto de conexión de MCP es http://localhost:5000/mcp. Mantener este terminal en ejecución: Visual Studio Code se conecta a este punto de conexión HTTP.

Nota:

Puede personalizar el puerto mediante la configuración del entorno de ejecución en dab-config.json o estableciendo variables de entorno como ASPNETCORE_URLS.

Paso 4: Conexión desde VS Code

Importante

Un área de trabajo es la carpeta raíz que VS Code trata como proyecto. La configuración y las definiciones de servidor MCP solo se aplican dentro de esa carpeta. Si abre un solo archivo, no está en un espacio de trabajo. Debe abrir una carpeta.

Abra la carpeta del proyecto.

1. Seleccione Archivo>Abrir carpeta.
2. Abra la carpeta que contiene el dab-config.json archivo.

Creación de la definición del servidor MCP

Cree un archivo denominado .vscode/mcp.json y agregue el siguiente contenido:

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

Guarde el archivo. VS Code debe detectar la configuración del servidor MCP y conectarse al servidor DE SQL MCP en ejecución en el punto de conexión HTTP especificado. Es posible que tenga que volver a cargar la ventana (Desarrollador: Volver a cargar ventana desde la paleta de comandos).

La Products entidad aparece como herramientas de MCP como describe_entities y read_records. Los nombres de herramientas pueden variar en función de la configuración.

Nota:

La compatibilidad con MCP de VS Code está evolucionando. El esquema de configuración puede cambiar en futuras versiones. Para obtener las instrucciones más recientes, consulte la documentación de VS Code para la integración de MCP.

Prueba una herramienta llamada

Abra el chat de VS Code y pruebe este mensaje:

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

Debería ver los datos de la tienda de juguetes que insertó anteriormente.

Contenido relacionado

• Información general sobre SQL MCP Server
• Herramientas de manipulación de datos en SQL MCP Server
• Adición de descripciones semánticas a SQL MCP Server