クイック スタート: Visual Studio Codeで SQL MCP Server をローカルで使用する

このクイック スタートでは、Data API Builder CLI を使用して、アスパイアなしで SQL モデル コンテキスト プロトコル (MCP) サーバーをローカルで実行します。 カスタム ツールを使用して、データベースの作成、構成ファイルの構成、SQL MCP Server の起動、Visual Studio (VS) コードからの接続を行います。 このパスは、コンテナーやホスティング フレームワークを使用せずに SQL MCP Server を探索する最も簡単な方法です。

[前提条件]

開始する前に、これらのツールをインストールします。

.NET 9+

このツールは既にインストールされている可能性があります。 を実行し、バージョン 9.0 以降が報告されたことを確認します。 .NETが既に存在する場合、再インストールは安全であり、ランタイムのみを更新します。

SQL Server 2016 以降

SQL Server データベースにアクセスする必要があります。 次のいずれかの作業を行います。

• SQL Server (デベロッパーまたは Express)
• LocalDB (ファイルベースのSQL Server)
• Docker でのSQL Server

Data API Builder CLI をインストールする

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

手順 1: サンプル データベースを作成する

この手順では、 という名前のデータベースを作成し、 という名前の 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 サーバーを構成する

ファイルを作成するフォルダー内のすべてのコマンドを実行します。

環境ファイルを作成する

作業ディレクトリに .env という名前のファイルを作成し、次の行を追加します (SQL Server情報を使用してカスタマイズします)。

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

データ API ビルダーは、作業ディレクトリに存在する場合、ローカル ファイルから変数を読み取ることができます。 環境で ファイルがサポートされていない場合は、次のコマンドを実行する前に、ターミナル セッションで を環境変数として設定します。

サーバーを初期化して構成する

次のコマンドを実行してください:

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 サーバーを起動する

SQL MCP Server では、2 つのトランスポート モードがサポートされています。 ワークフローに適合するものを選択します。

オプション A: HTTP トランスポート (サーバーは個別に実行されます)

HTTP モードでは、DAB をターミナルで実行時間の長いプロセスとして開始し、VS Code はローカル HTTP エンドポイント経由でそれに接続します。

VS Code から接続する前に、別のターミナルで SQL MCP サーバーを起動します。

ターミナルを開いて実行する

dab start --config dab-config.json

このコマンドは、SQL MCP サーバーを起動します。 起動後、ターミナル出力にリッスン URL が表示されます。 このクイック スタートでは、MCP エンドポイントが されていることを前提としています。 このターミナルを実行したままにします。Visual Studio Codeはこの HTTP エンドポイントに接続します。

オプション B: stdio トランスポート (VS Code がプロセスを管理)

モードでは、DAB は VS Code によって直接管理される子プロセスとして起動します。 ターミナルでを実行する必要はありません。VS Code は、ワークスペースを開いたときに DAB を自動的に開始および停止します。

このモードは、ローカル開発に推奨されます。 管理する HTTP ポートはなく、実行を続けるターミナル プロセスもありません。

手順 4 に進み、選択したトランスポートの VS Code MCP サーバー定義を構成します。

手順 4: VS Code から接続する

プロジェクト フォルダーを開く

1. 「ファイルを選択してフォルダを開く」を選択します。
2. ファイルを含むフォルダーを開きます。

MCP サーバー定義を作成する

という名前のファイルを作成し、選択したトランスポートのコンテンツを追加します。

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

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

ファイルを保存します。 VS Code は、MCP サーバー構成を自動的に検出します。 ウィンドウを再読み込みする必要がある場合があります (開発者: コマンド パレットからウィンドウを再読み込み します)。

MCP サーバー接続を開始する

1. コマンド パレットを開きます (macOS の場合は Ctrl + Shift + P または Cmd + Shift + P )。
2. MCP を実行する: サーバーを一覧表示して、使用可能なサーバーを表示します。
3. sql-mcp-server を選択し、[接続の開始] を選択します。

接続されると、 エンティティは、 や などの MCP ツールとして表示されます。 ツール名は、構成によって異なる場合があります。

ツール呼び出しを試す

VS Code Copilot チャットを開き、次のプロンプトを試します。

Which products have an inventory under 30?

関連コンテンツ

• SQL MCP Server の概要
• SQL MCP Server のトランスポート
• SQL MCP Server のデータ操作ツール
• SQL MCP Server へのセマンティック記述の追加