Bagikan melalui

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

Diagram yang memperlihatkan SQL MCP Server lokal yang tersambung ke Visual Studio Code.

Penting

Server Protokol Konteks Model SQL (MCP) sedang dalam pratinjau, dan dokumentasi ini serta implementasi mesin dapat berubah. Saat Data API Builder versi 1.7 dalam pratinjau, Anda harus menggunakan versi prarilis secara eksplisit (misalnya, 1.7.83-rc) karena fitur MCP belum disertakan dalam tag :latest.

Panduan cepat ini menggunakan CLI Data API Builder untuk menjalankan SQL MCP Server secara lokal tanpa 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, instal 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 --prerelease
dotnet tool restore

Nota

SQL MCP Server saat ini sedang dalam prarilis. Menggunakan tanda --prerelease memastikan Anda mendapatkan versi terbaru dari Data API Builder dengan semua fitur yang digunakan dalam panduan cepat ini.

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

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.

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 berikut:

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

Simpan file tersebut. Visual Studio Code mendeteksi konfigurasi server MCP secara otomatis. Anda mungkin perlu memuat ulang jendela (Pengembang: Jendela Muat Ulang dari Palet Perintah).

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 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 VS Code Copilot Chat dan coba prompt ini:

Which products have an inventory under 30?

Konten terkait

  • Last updated on