Aracılığıyla paylaş


Hızlı Başlangıç: Visual Studio Code ile SQL MCP Server'ı yerel olarak kullanma

Visual Studio Code'a bağlı yerel bir SQL MCP Sunucusunu gösteren diyagram.

Önemli

SQL Model Bağlam Protokolü (MCP) Sunucusu önizleme aşamasındadır ve bu belgeler ve altyapı uygulaması değişebilir. Veri API oluşturucusu sürüm 1.7 önizleme aşamasındayken, MCP özellikleri henüz etikete dahil 1.7.83-rc edilmediğinden yayın öncesi sürümü açıkça kullanmanız gerekir (örneğin, :latest).

Bu hızlı başlangıçta, Bir SQL MCP Sunucusunu Aspire olmadan yerel olarak çalıştırmak için Veri API'sini oluşturucu CLI kullanılır. Özel bir araç kullanarak bir veritabanı oluşturur, bir yapılandırma dosyası yapılandırıp SQL MCP Server'ı başlatır ve Visual Studio Code'dan (VS Code) bu veritabanına bağlanırsınız. Bu yol, kapsayıcılar veya barındırma çerçeveleri olmadan SQL MCP Server'ı keşfetmenin en kolay yoludur.

Önkoşullar

Başlamadan önce bu araçları yükleyin.

.NET 9+

Bu aracı zaten yüklemiş olabilirsiniz. komutunu çalıştırın dotnet --version ve sürüm 9.0 veya üzerini bildirdiğinden emin olun. .NET zaten varsa, yeniden yükleme güvenlidir ve yalnızca çalışma zamanınızı yeniler.

SQL Server 2016+

SQL Server veritabanına erişmeniz gerekir. Aşağıdaki çalışmalardan herhangi biri:

  • SQL Server (Geliştirici veya Express)
  • LocalDB (dosya tabanlı SQL Server)
  • Docker'da SQL Server

Veri API'sini oluşturucu CLI'yi yükleme

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

Uyarı

SQL MCP Server şu anda ön sürümdedir. bayrağını --prerelease kullanmak, bu hızlı başlangıçta kullanılan tüm özelliklerle Data API builder'ın en son sürümünü edinmenizi sağlar.

1. Adım: Örnek veritabanınızı oluşturma

Bu adımda adlı bir veritabanı oluşturacak ve adlı ProductsDbProductstek bir tabloyla bu veritabanının tohumlarını oluşturacaksınız.

SQLCMD, SQL Server Management Studio veya tercih edilen herhangi bir aracı kullanarak SQL örneğine bağlanın ve ardından şunu çalıştırın:

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

Örnek veritabanınız hazır.

2. Adım: SQL MCP Server'ı yapılandırma

Dosyanızı dab-config.json oluşturmak istediğiniz klasörde tüm komutları çalıştırın.

Ortam dosyanızı oluşturma

Çalışma dizininizde adlı .env bir dosya oluşturun ve aşağıdaki satırı ekleyin (SQL Server bilgilerinizle özelleştirin):

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

Uyarı

Tümleşik kimlik doğrulaması (Trusted_Connection=True) Windows üzerinde çalışır. SQL kimlik doğrulaması (Docker veya platformlar arası yaygın) için, localhost'a 1433 numaralı bağlantı noktasını eşlediğiniz varsayılarak, Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True yerine bunu kullanın.

Veri API oluşturucusu, çalışma dizininde mevcut olduğunda yerel .env bir dosyadan değişkenleri okuyabilir. Ortamınız dosyaları desteklemiyorsa .env , aşağıdaki komutları çalıştırmadan önce terminal oturumunuzda ortam değişkeni olarak ayarlayın MSSQL_CONNECTION_STRING .

Sunucuyu başlatma ve yapılandırma

Aşağıdaki komutları çalıştırın:

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

İsteğe bağlı olarak alan açıklamaları ekleme

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 Sunucunuz tamamen yapılandırılmıştır.

3. Adım: SQL MCP Server'ı başlatma

VS Code'dan bağlanmadan önce SQL MCP Server'ı ayrı bir terminalde başlatın.

Terminal açma ve çalıştırma

dab start --config dab-config.json

Bu komut SQL MCP Sunucusunu başlatır. Başlatma işleminden sonra terminal çıkışında dinleme URL'leri gösterilir. Bu hızlı başlangıçta MCP uç noktasının olduğu varsayılır http://localhost:5000/mcp. Bu terminali çalışır durumda tut - Visual Studio Code bu HTTP uç noktasına bağlanır.

Uyarı

Çalışma zamanı ayarlarını dab-config.json içinde yapılandırarak veya ASPNETCORE_URLS gibi ortam değişkenlerini ayarlayarak bağlantı noktasını özelleştirebilirsiniz.

4. Adım: VS Code'dan bağlanma

Önemli

Çalışma alanı, VS Code'un projeniz olarak ele alan kök klasördür. Ayarlar ve MCP sunucu tanımları yalnızca bu klasörün içinde geçerlidir. Tek bir dosya açarsanız, çalışma alanında değilsinizdir. Bir klasör açmanız gerekir.

Proje klasörünüzü açma

  1. Dosya>Klasör Aç'ı seçin.
  2. Dosyanızı dab-config.json içeren klasörü açın.

MCP sunucu tanımınızı oluşturma

adlı .vscode/mcp.json bir dosya oluşturun ve aşağıdaki içeriği ekleyin:

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

Dosyayı kaydedin. VS Code, MCP sunucu yapılandırmasını otomatik olarak algılar. Pencereyi yeniden yüklemeniz gerekebilir (Geliştirici: Komut Paleti'nden Pencereyi Yeniden Yükle ).

MCP sunucu bağlantısını başlatma

  1. Komut Paleti'ni açın (macOS'ta Ctrl+Shift+P veya Cmd+Shift+P ).
  2. Kullanılabilir sunucuları görüntülemek için MCP: Sunucuları Listele'yi çalıştırın.
  3. sql-mcp-server'ı seçin ve bağlanmak için Başlat'ı seçin.

Bağlandıktan sonra, Products varlığı read_records ve describe_entities gibi MCP araçları olarak görünür. Araç adları yapılandırmanıza göre farklılık gösterebilir.

Uyarı

VS Code MCP desteği gelişiyor. Yapılandırma şeması gelecek sürümlerde değişebilir. En son yönergeler için MCP tümleştirmesi için VS Code belgelerine bakın.

Bir araçla arama yapmayı deneyin

VS Code Copilot Sohbeti'ni açın ve şu istemi deneyin:

Which products have an inventory under 30?