快速入门：在本地将 SQL MCP Server 与 Visual Studio Code 配合使用

本快速入门使用数据 API 生成器 CLI 在没有 Aspire 的情况下在本地运行 SQL MCP 服务器。 创建数据库、配置配置文件、启动 SQL MCP Server，并使用自定义工具从 Visual Studio Code（VS Code）连接到它。 此路径是浏览没有容器或托管框架的 SQL MCP Server 的最简单方法。

先决条件

在开始之前安装这些工具。

.NET 9+

可能已安装此工具。 运行 dotnet --version 并确认它显示版本 9.0 或更高。 如果 .NET 已存在，则重新安装是安全的，并且只会刷新运行时。

SQL Server 2016+

需要访问 SQL Server 数据库。 以下任一工作：

• SQL Server （开发版或 Express）
• LocalDB （基于文件的 SQL Server）
• Docker 中的 SQL Server

安装数据 API 生成器 CLI

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

步骤 1：创建示例数据库

在此步骤中，你将创建一个名为 ProductsDb 的数据库，并用一个名为 Products 的表来填充它。

使用 SQLCMD、SQL Server Management Studio 或任何首选工具连接到 SQL 实例，然后运行：

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 服务器

运行要在其中创建 dab-config.json 文件的文件夹中的所有命令。

创建环境文件

创建工作目录中命名 .env 的文件并添加以下行（使用 SQL Server 信息进行自定义）：

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

当工作目录中存在时，数据 API 生成器可以从本地 .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 Server 已经完全配置。

步骤 3：启动 SQL MCP 服务器

在从 VS Code 进行连接之前，在单独的终端中启动 SQL MCP Server。

打开终端并运行

dab start --config dab-config.json

此命令启动 SQL MCP 服务器。 启动后，终端输出会显示侦听 URL。 本快速入门假定 MCP 终结点为 http://localhost:5000/mcp. 使此终端保持运行 - Visual Studio Code 连接到此 HTTP 终结点。

步骤 4：从 VS Code 进行连接

打开项目文件夹

1. 选择“ 文件>打开文件夹”。
2. 打开包含 dab-config.json 文件的文件夹。

创建 MCP 服务器定义

创建一个名为 .vscode/mcp.json 并添加以下内容的文件：

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

保存文件。 VS Code 应检测 MCP 服务器配置，并在指定的 HTTP 终结点连接到正在运行的 SQL MCP Server。 可能需要重新加载窗口（开发人员：从命令面板重新加载窗口 ）。

实体 Products 显示为 MCP 工具，如 describe_entities 和 read_records。 工具名称可能因配置而异。

尝试工具调用

打开 VS Code 聊天并尝试以下提示：

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

你应该能看到之前插入的玩具店数据。

相关内容

• SQL MCP Server 概述
• SQL MCP Server 中的数据操作工具
• 向 SQL MCP Server 添加语义说明