Dperussina Mssql MCP Server

🚀 MS SQL MCP サーバーの日本語ガイド

MS SQL MCP サーバーは、データベースの操作や管理を容易にするためのサーバーです。このガイドでは、サーバーの設定、使用方法、注意事項などを詳しく説明します。

🚀 クイックスタート

📦 インストール

必要な依存関係をインストールするには、以下のコマンドを実行します。

npm install

🔧 環境変数の設定

プロジェクトのルートディレクトリにある .env ファイルを作成または編集し、以下の内容を実際の環境に合わせて記入します。

# データベース接続設定
DB_USER=あなたのユーザー名           # SQL Server のユーザー名
DB_PASSWORD=あなたのパスワード         # SQL Server のパスワード
DB_SERVER=あなたのサーバー名          # サーバーのホスト名または IP アドレス（例: localhost, 10.0.0.1, myserver.database.windows.net）
DB_DATABASE=あなたのデータベース名    # 接続するデータベース名

# サービス設定
PORT=3333                    # HTTP/SSE サーバーがリッスンするポート
TRANSPORT=stdio              # 接続方式: 'stdio'（Claude Desktop 用）または 'sse'（ネットワーク接続用）
SERVER_URL=http://localhost:3333   # SSE トランスポートを使用する場合のベース URL（PORT 設定と一致する必要があります）

# 高度な設定
DEBUG=false                  # 詳細なログ記録を有効にするには 'true' に設定（デバッグ時に便利）
QUERY_RESULTS_PATH=/path/to/query_results  # クエリ結果を保存するディレクトリのパス（各クエリ結果は JSON ファイルとしてここに保存されます）

🚀 サービスの起動

• stdio トランスポートで起動する場合：

  npm start
  

• sse トランスポートで起動する場合：

  npm run start:sse
  

✨ 主な機能

MS SQL MCP サーバーは、以下の主要な機能を提供します。

1. データベースツール

   • データのクエリ実行
   • テーブル構造の閲覧
   • 管理コマンドの実行

2. 結果のナビゲーション

   • ページングによる閲覧
   • 結果のエクスポート
   • 内容の検索

3. クエリ実行

   • 複数の形式（JSON, CSV）をサポート
   • 大規模な結果セットの処理
   • トランザクションのサポート

4. データベースの探索

   • データベース構造の閲覧
   • テーブル情報の表示
   • ストアドプロシージャのドキュメント取得

💻 使用例

基本的な使用法

基本的なクエリ

SELECT TOP 5 * FROM Customers

ページングクエリ

SELECT * FROM Orders 
ORDER BY OrderID OFFSET 10 ROWS FETCH NEXT 20 ROWS ONLY

高度な使用法

データベース構造の閲覧

# すべてのデータベースをリストする
LIST DATABASES

# 現在のデータベースのテーブルを表示する
DESCRIBE TABLE Customers

📚 ドキュメント

結果のページング閲覧

ページング情報の取得

{
  "tool": "pagination",
  "args": {
    "query": "SELECT * FROM Orders",
    "page_size": 20,
    "current_page": 1
  }
}

ページングクエリの実行

{
  "tool": "paged_query"
}

管理コマンドの実行

EXECUTE SYSTEM COMMAND 'BACKUP DATABASE MyDatabase TO DISK = \'C:\Backups\MyDatabase.bak\''

⚠️ 重要提示

1. セキュリティ

   • データベース接続文字列を共有しないでください。
   • 安全な認証情報を使用してください。
   • 適切なデータアクセス権限を設定してください。

2. パフォーマンスの最適化

   • インデックスを最適化してください。
   • 大規模な結果セットを処理する場合はページングを使用してください。
   • 長時間実行されるクエリを避けてください。

🔧 技術詳細

コアモジュール

1. データベースモジュール (database.mjs)

   • すべてのデータベース接続とやり取りを処理します。
   • トランザクションとセッション状態を管理します。

2. クエリ実行モジュール (query_executor.mjs)

   • SQL 文を解析して実行します。
   • 結果セットを処理します。
   • ストアドプロシージャを実行します。

3. ページングモジュール (pagination.mjs)

   • ページングロジックを実装します。
   • 複数のデータベース方言をサポートします。
   • 効率的なデータナビゲーションを提供します。

環境設定の説明

データベース接続設定

• DB_USER: SQL Server にログインするためのユーザー名。
• DB_PASSWORD: 対応するユーザーのパスワード。
• DB_SERVER: サーバーのネットワークアドレス。
• DB_DATABASE: 接続する具体的なデータベース名。

サービス設定

• PORT: サービスが実行されるポート。デフォルトは 3333 です。
• TRANSPORT: 接続方式。stdio はローカル開発用、sse は本番環境用です。
• SERVER_URL: sse トランスポートを使用する場合、サーバーのベース URL を定義します。

高度な設定

• DEBUG: 詳細なログ情報を取得するためのデバッグモードを有効にします。
• QUERY_RESULTS_PATH: クエリ結果ファイルの保存先パス。

注意

データベース接続文字列には機密情報が含まれています。安全に管理し、漏洩を防いでください。漏洩すると、データベースへの不正アクセスのリスクがあります。

🎉 まとめ

このガイドを参考に、MS SQL MCP サーバーを設定して使用することができます。必要に応じて拡張や最適化を行ってください。