Mulai Cepat: Menggunakan SQL MCP Server dengan Visual Studio Code secara lokal

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

Penting

Server Protokol Konteks Model SQL (MCP) tersedia di pembuat API Data versi 1.7 dan yang lebih baru.

Panduan cepat ini menggunakan builder API Data CLI untuk menjalankan Server Model Context Protocol (MCP) SQL secara lokal tanpa menggunakan Aspire. Anda membuat database, mengonfigurasi file konfigurasi, memulai SQL MCP Server, dan menyambungkannya dari Visual Studio Code (VS Code) menggunakan alat kustom. Jalur ini adalah cara term mudah untuk menjelajahi SQL MCP Server tanpa kontainer atau kerangka kerja hosting.

Prasyarat

Instal alat-alat ini sebelum Anda memulai.

.NET 9+

Anda mungkin sudah menginstal alat ini. Jalankan dotnet --version dan konfirmasikan laporan versi 9.0 atau yang lebih baru. Jika .NET sudah ada, menginstal ulang aman dan hanya me-refresh runtime Anda.

SQL Server 2016+

Anda memerlukan akses ke database SQL Server. Salah satu pekerjaan berikut:

• SQL Server (Pengembang atau Ekspres)
• LocalDB (SQL Server berbasis file)
• SQL Server di Docker

Menginstal pembangun API Data CLI

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

Nota

Fitur SQL MCP Server tersedia di pembuat API Data versi 1.7 dan yang lebih baru.

Langkah 1: Buat database sampel Anda

Dalam langkah ini, Anda membuat database bernama ProductsDb dan menyemainya dengan satu tabel bernama Products.

Sambungkan ke instans SQL Anda menggunakan SQLCMD, SQL Server Management Studio, atau alat pilihan apa pun, lalu jalankan:

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

Database sampel Anda sudah siap.

Langkah 2: Mengonfigurasi SQL MCP Server

Jalankan semua perintah di folder tempat Anda ingin membuat dab-config.json file.

Buat file lingkungan

Buat file bernama .env di direktori kerja Anda dan tambahkan baris berikut (sesuaikan dengan informasi SQL Server Anda):

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

Nota

Autentikasi terintegrasi (Trusted_Connection=True) berfungsi pada Windows. Untuk autentikasi SQL (umum dengan Docker atau lintas platform), gunakan Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True sebagai gantinya (dengan asumsi port peta kontainer Anda 1433 ke localhost).

Penyusun API Data dapat membaca variabel dari file lokal .env saat ada di direktori kerja. Jika lingkungan Anda tidak mendukung .env file, atur MSSQL_CONNECTION_STRING sebagai variabel lingkungan di sesi terminal Anda sebelum menjalankan perintah berikut.

Menginisialisasi dan mengonfigurasi server

Jalankan perintah berikut:

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

Secara opsional tambahkan deskripsi bidang

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 Anda sepenuhnya dikonfigurasi.

Langkah 3: Mulai SQL MCP Server

SQL MCP Server mendukung dua mode transportasi. Pilih yang sesuai dengan alur kerja Anda.

Opsi A: Transportasi HTTP (server berjalan secara terpisah)

Dalam mode HTTP, Anda memulai DAB sebagai proses jangka panjang di terminal dan Visual Studio Code terhubung ke dalamnya melalui titik akhir HTTP lokal.

Sebelum menyambungkan dari VS Code, mulai SQL MCP Server di terminal terpisah.

Buka terminal dan jalankan

dab start --config dab-config.json

Perintah ini memulai SQL MCP Server. Setelah dinyalakan, output terminal menunjukkan URL yang sedang dipantau. Panduan memulai cepat ini mengasumsikan bahwa titik akhir MCP adalah http://localhost:5000/mcp. Biarkan terminal ini tetap berjalan - Visual Studio Code tersambung ke titik akhir HTTP ini.

Nota

Anda dapat menyesuaikan port dengan mengonfigurasi pengaturan runtime di Anda dab-config.json atau dengan mengatur variabel lingkungan seperti ASPNETCORE_URLS.

Opsi B: stdio transportasi (Visual Studio Code mengelola proses)

Dalam stdio mode, DAB diluncurkan sebagai proses anak yang dikelola langsung oleh Visual Studio Code. Anda tidak perlu menjalankan dab start di terminal—VS Code akan memulai dan menghentikan DAB secara otomatis saat Anda membuka area kerja.

Mode ini direkomendasikan untuk pengembangan lokal. Tidak ada port HTTP untuk dikelola dan tidak ada proses terminal untuk terus berjalan.

Nota

Transport stdio memerlukan "mcp": { "enabled": true } di bagian runtime dari dab-config.json Anda. Untuk detail selengkapnya, lihat stdio transpor untuk SQL MCP Server.

Lewati ke Langkah 4 untuk mengonfigurasi definisi server VS Code MCP untuk transportasi yang Anda pilih.

Langkah 4: Sambungkan dari Visual Studio Code

Penting

Ruang kerja adalah folder akar yang diperlakukan VS Code sebagai proyek Anda. Pengaturan dan definisi server MCP hanya berlaku di dalam folder tersebut. Jika Anda membuka satu file, Anda tidak berada di ruang kerja. Anda harus membuka folder.

Buka folder proyek Anda

1. Pilih Buka File>Folder.
2. Buka folder yang berisi file Anda dab-config.json .

Membuat definisi server MCP Anda

Buat file bernama .vscode/mcp.json dan tambahkan konten untuk transportasi yang Anda pilih.

stdio transport (Opsi B—direkomendasikan untuk pengembangan lokal)

Dalam stdio modus, VS Code meluncurkan DAB sebagai proses turunan. Anda tidak memerlukan terminal yang sedang berjalan—Visual Studio Code mengelola siklus hidup proses.

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

Untuk menginstal konfigurasi yang tepat ini, gunakan tombol berikut.

Nota

Ganti role:anonymous dengan peran yang ditentukan dalam izin entitas Anda jika Anda ingin membatasi atau memperluas akses. Untuk informasi selengkapnya tentang peran dan opsi transportasi, lihat stdio transportasi untuk SQL MCP Server.

Transportasi HTTP (Opsi A)

Dalam mode HTTP, Visual Studio Code tersambung ke server DAB yang Anda mulai di Langkah 3. Jaga agar terminal Anda dab start tetap berjalan.

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

Untuk menginstal konfigurasi yang tepat ini, gunakan tombol berikut.

Memulai koneksi server MCP

1. Buka Palet Perintah (Ctrl+Shift+P atau Cmd+Shift+P di macOS).
2. Jalankan MCP: Daftar Server untuk melihat server yang tersedia.
3. Pilih sql-mcp-server (atau apa pun nama Anda) dan pilih Mulai untuk menyambungkan.

Setelah tersambung, Products entitas muncul sebagai alat MCP seperti describe_entities dan read_records. Nama alat dapat bervariasi berdasarkan konfigurasi Anda.

Nota

Dukungan VS Code MCP berkembang. Skema konfigurasi dapat berubah dalam rilis mendatang. Untuk panduan terbaru, lihat dokumentasi Visual Studio Code untuk integrasi MCP.

Coba panggilan alat

Buka Visual Studio Code Copilot Chat dan coba perintah ini:

Which products have an inventory under 30?

Konten terkait

• Gambaran Umum SQL MCP Server
• stdio transportasi untuk SQL MCP Server
• Alat manipulasi data di SQL MCP Server
• Menambahkan deskripsi semantik ke SQL MCP Server