Compartir a través de


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

Diagrama que muestra un servidor MCP de SQL local conectado a Visual Studio Code.

Importante

Sql Model Context Protocol (MCP) Server está disponible en Data API Builder versión 1.7 y posteriores.

En este inicio rápido se usa la CLI del Generador de API de datos para ejecutar un servidor de SQL Model Context Protocol (MCP) 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 (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.

Prerrequisitos

Instale estas herramientas antes de empezar.

.NET 9+

Es posible que ya tenga instalada esta herramienta. Ejecute 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 tiempo 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
dotnet tool restore

Nota:

Las características de SQL MCP Server están disponibles en data API Builder versión 1.7 y posteriores.

Paso 1: Crear la base de datos de ejemplo

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

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 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 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 cuando está presente en el directorio de trabajo. Si el entorno no admite archivos, establezca 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

SQL MCP Server admite dos modos de transporte. Elija la que se adapte al flujo de trabajo.

Opción A: transporte HTTP (el servidor se ejecuta por separado)

En el modo HTTP, inicia DAB como un proceso de ejecución prolongada en un terminal y VS Code se conecta a él a través de un punto de conexión HTTP local.

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 . Mantenga 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 o estableciendo variables de entorno como .

Opción B: transporte stdio (VS Code administra el proceso)

En modo, DAB se inicia como un proceso secundario administrado directamente por VS Code. No es necesario ejecutar en un terminal: VS Code se inicia y detiene DAB automáticamente al abrir el área de trabajo.

Este modo se recomienda para el desarrollo local. No hay ningún puerto HTTP para administrar y ningún proceso de terminal para seguir ejecutándose.

Nota:

El transporte requiere detalles específicos en la sección correspondiente de su formulario. Para obtener detalles completos, consulte la sección de transporte de SQL MCP Server.

Saltar al paso 4 para configurar la definición del servidor de VS Code MCP para el transporte elegido.

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 ArchivoAbrir carpeta.
  2. Abra la carpeta que contiene el archivo.

Creación de la definición del servidor MCP

Cree un archivo denominado y agregue el contenido para el transporte elegido.

  • transporte (opción B: recomendado para desarrollo local)
  • Transporte HTTP (opción A)

En el modo, VS Code inicia DAB como un subproceso. No necesita un terminal en ejecución: VS Code administra el ciclo de vida del proceso.

{
  "servers": {
    "sql-mcp-server": {
      "type": "stdio",
      "command": "dab",
      "args": [
        "start",
        "--mcp-stdio",
        "role:anonymous",
        "--config",
        "${workspaceFolder}/dab-config.json"
      ]
    }
  }
}

Reemplace por un rol definido en los permisos de entidad si desea restringir o expandir el acceso. Para obtener más información sobre los roles y las opciones de transporte, consulte transporte para SQL MCP Server.

Guarde el archivo. VS Code detecta automáticamente la configuración del servidor MCP. Es posible que tenga que volver a cargar la ventana (Desarrollador: Volver a cargar ventana desde la paleta de comandos).

Iniciar la conexión del servidor MCP

  1. Abra la paleta de comandos (Ctrl+Mayús+P o Cmd+Mayús+P en macOS).
  2. Ejecutar MCP: Enumerar servidores para ver los servidores disponibles.
  3. Seleccione sql-mcp-server y elija Iniciar para conectarse.

Una vez conectado, la entidad aparece como herramientas de MCP como y . 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 vs Code Copilot Chat y pruebe este mensaje:

Which products have an inventory under 30?
  • Información general sobre SQL MCP Server
  • transporte para el Servidor SQL MCP
  • Herramientas de manipulación de datos en SQL MCP Server
  • Adición de descripciones semánticas a SQL MCP Server