Important
SQL モデル コンテキスト プロトコル (MCP) サーバーはプレビュー段階であり、このドキュメントとエンジンの実装が変更される可能性があります。 Data API Builder バージョン 1.7 はプレビュー段階ですが、MCP 機能がまだ 1.7.83-rc タグに含まれていないため、プレリリース バージョン (:latest など) を明示的に使用する必要があります。
このクイック スタートでは、Data API Builder CLI を使用して、Hive なしで 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 (Developer または Express)
- LocalDB (ファイル ベースの SQL Server)
- Docker の SQL Server
Data API Builder CLI をインストールする
dotnet new tool-manifest
dotnet tool install microsoft.dataapibuilder --prerelease
dotnet tool restore
注
SQL MCP Server は現在プレリリース中です。
--prerelease フラグを使用すると、このクイック スタートで使用されるすべての機能を使用して、最新バージョンの Data API ビルダーを取得できます。
手順 1: サンプル データベースを作成する
この手順では、 ProductsDb という名前のデータベースを作成し、 Productsという名前の 1 つのテーブルでシード処理します。
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
注
統合認証 (Trusted_Connection=True) は Windows で動作します。 SQL 認証 (Docker またはクロスプラットフォームで共通) の場合は、代わりに Server=localhost,1433;Database=ProductsDb;User Id=sa;Password=<YourPassword>;TrustServerCertificate=True を使用します (コンテナーがポート 1433 を localhost にマップすると仮定)。
データ 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 サーバーが完全に構成されています。
手順 3: SQL MCP サーバーを起動する
VS Code から接続する前に、別のターミナルで SQL MCP サーバーを起動します。
ターミナルを開いて実行する
dab start --config dab-config.json
このコマンドは、SQL MCP サーバーを起動します。 起動後、ターミナル出力にリッスン URL が表示されます。 このクイック スタートでは、MCP エンドポイントが http://localhost:5000/mcpされていることを前提としています。 このターミナルを実行したままにします。Visual Studio Code はこの HTTP エンドポイントに接続します。
注
ポートをカスタマイズするには、 dab-config.json でランタイム設定を構成するか、 ASPNETCORE_URLSなどの環境変数を設定します。
手順 4: VS Code から接続する
Important
ワークスペースは、VS Code がプロジェクトとして扱うルート フォルダーです。 設定と MCP サーバー定義は、そのフォルダー内にのみ適用されます。 1 つのファイルを開くと、ワークスペースにはいない状態です。 フォルダーを開く必要があります。
プロジェクト フォルダーを開く
- [>。
-
dab-config.jsonファイルを含むフォルダーを開きます。
MCP サーバー定義を作成する
.vscode/mcp.jsonという名前のファイルを作成し、次の内容を追加します。
{
"servers": {
"sql-mcp-server": {
"type": "http",
"url": "http://localhost:5000/mcp"
}
}
}
ファイルを保存します。 VS Code は、MCP サーバー構成を自動的に検出します。 ウィンドウを再読み込みする必要がある場合があります (開発者: コマンド パレットからウィンドウを再読み込み します)。
MCP サーバー接続を開始する
- コマンド パレットを開きます (macOS の場合は Ctrl + Shift + P または Cmd + Shift + P )。
- MCP を実行する: サーバーを一覧表示して、使用可能なサーバーを表示します。
- sql-mcp-server を選択し、[接続の開始] を選択します。
接続されると、 Products エンティティは、 describe_entities や read_recordsなどの MCP ツールとして表示されます。 ツール名は、構成によって異なる場合があります。
注
VS Code MCP のサポートは進化しています。 構成スキーマは、今後のリリースで変更される可能性があります。 最新のガイダンスについては、MCP 統合に関する VS Code のドキュメントを参照してください。
ツール呼び出しを試す
VS Code Copilot チャットを開き、次のプロンプトを試します。
Which products have an inventory under 30?