Sql MCP Server

🚀 SQL-MCP-Server

SQL-MCP-Serverは、MCPフレームワークに基づくSQLサーバーで、SQL Serverデータベースとの相互作用を可能にします。

🚀 クイックスタート

以下のコマンドを使用して、プロジェクトを迅速に起動できます。

# 依存関係のインストール
npm install

# プロジェクトのビルド
npm run build

# サービスの起動
npm start

📦 インストール

環境構成

.env ファイルでデータベースの接続情報を設定します。

DB_SERVER=localhost\SQLEXPRESS
DB_DATABASE=AdventureWorks2019
DB_USERNAME=readonly_user
DB_PASSWORD=StrongPassword!123
DB_PORT=1433

AdventureWorks サンプルデータベース

このプロジェクトではAdventureWorksサンプルデータベースを使用しています。以下のリンクからダウンロードしてインストールできます。

• Microsoft公式ドキュメント: AdventureWorksのインストールと構成

Microsoftのドキュメントに従ってデータベースのバックアップファイルをダウンロードし、SQL Serverインスタンスに復元してください。

読み取り専用ユーザーの作成

データを読み取るだけのユーザーを作成するには、以下のSQLコマンドを実行します。

-- masterデータベースで新しいログインアカウントとユーザーを作成
CREATE LOGIN readonly_user WITH PASSWORD = 'StrongPassword!123';
GO

-- ターゲットデータベースAdventureWorks2019に切り替える
USE AdventureWorks2019;
GO

-- MasterDBログイン用のデータベースユーザーを作成
CREATE USER readonly_user FOR LOGIN readonly_user;

-- ユーザーをdb_datareaderロールに追加して読み取り専用アクセスを実現
ALTER ROLE db_datareader ADD MEMBER readonly_user;
GO

⚠️ 重要提示

SQL Server Management Studioを使用するか、CREATE LOGIN コマンドを使用してmasterデータベースにログインアカウントを作成してから、上記のコマンドを実行する必要があります。

💻 使用例

基本的な使用法

このセクションでは、プロジェクトの基本的な使用方法を説明します。

プロジェクト構造

sql-mcp-server/
├── src/
│   ├── services/       # アプリケーションのサービスモジュール
│   │   └── sql-service.ts
│   ├── tools/          # MCPツールセット
│   │   ├── execute-select-query-tool.ts
│   │   ├── get-database-schema-tool.ts
│   │   └── get-databases-tool.ts
│   └── index.ts        # サービスプログラムのエントリーファイル
├── .env                # 環境変数の設定ファイル
├── package.json
└── tsconfig.json

利用可能なツール

このプロジェクトでは、以下のSQL関連のツールが提供されています。

1. get-databases-tool - SQL Server上で利用可能なデータベースを一覧表示します。
2. get-database-schema-tool - 指定されたデータベースのスキーマ情報を取得します。
3. execute-select-query-tool - パラメータ化されたSELECTクエリを実行します。

SQLサービス

SqlService クラスは、以下のような主要な機能を提供します。

• 環境変数を使用して接続文字列を生成します。
• SQL Serverデータベースに対してクエリを実行します。

高度な使用法

VS Codeとの統合

VS CodeでMCPサーバーを構成するには、以下の手順に従ってください。

1. プロジェクトのルートディレクトリに .vscode/mcp.json ファイルを作成します。
   • .vscode ディレクトリがない場合は、まず作成してください。
   • このディレクトリに mcp.json ファイルを追加し、以下の内容を記述します。

{
  "servers": {
    "sql-mcp-server": {
      "url": "http://localhost:1337/mcp"
    }
  }
}

ビルドとテスト

1. ツールのコードを変更します。
2. npm run build を実行してコンパイルします。
3. サーバーを起動すると、自動的にツールが読み込まれます。

デバッグガイド

mcp-debug ツールを使用してデバッグすることができます。

# 1つのターミナルでサービスを起動
npm start

# 別のターミナルでmcp-debugを実行
npx mcp-debug

mcp-debug ツールは、以下の機能を提供するコマンドラインインターフェースを備えています。

• MCPサーバー上で利用可能なツールを一覧表示します。
• 特定のパラメータを持つツールを実行します。
• サーバーからの完全な結果を表示します。

📚 ドキュメント

学習リソース

• MCPフレームワークの公式ドキュメント
• TypeScript入門ガイド
• Node.js公式チュートリアル