SQL Server MCP Server for Windsurf IDE

SQL Server MCP サーバー

C# で記述されたスタンドアロンの MCP（Model Context Protocol）サーバーで、MCP に準拠したあらゆる IDE またはクライアントに SQL Server 連携機能を提供します。

機能

• SQL Server への接続
• データベーススキーマの調査
• テーブルとビューの確認
• カラムのメタデータの取得
• ストアドプロシージャの一覧表示
• SQL クエリの実行
• ストアドプロシージャの実行
• トラブルシューティング用のデバッグモード
• ログ保存先の設定
• 動的プロジェクト接続リゾルバー：エディターでアクティブなファイルに基づいて、データベース接続文字列を自動的に動的解決して上書きします

前提条件

• .NET 10.0 SDK 以上
• SQL Server インスタンス（ローカルまたはリモート）
• SQL Server クライアントツール

セットアップ

1. プロジェクトをビルドします：

dotnet build

2. アプリケーションを設定します：

   • appsettings.example.json を appsettings.json にコピーします
   • SQL Server の詳細情報を使って、appsettings.json の接続文字列などの設定を更新します

   {
     "ConnectionStrings": {
       "DefaultConnection": "Server=your-server;Database=master;User ID=your-username;Password=your-password;TrustServerCertificate=True"
     },
     "LogPath": "C:\\Path\\To\\Your\\LogDirectory\\",
     "DebugMode": "false"
   }
   

3. IDE／クライアントで MCP サーバーを設定します：

   • IDE の MCP 設定ファイル（例：Windsurf、Claude Desktop の設定、または Cline／Cursor の設定）にサーバー設定を追加します。
   • コマンドの実行先として、ビルドした実行可能ファイルのパスを指定します：

   {
     "mcpServers": {
       "sqlMcpService": {
         "command": "path/to/your/MCPSqlServer.exe",
         "args": [],
         "description": "SQL Server MCP Service"
       }
     }
   }
   

4. GitHub 連携を設定します：

   • プロジェクト用の新しい GitHub リポジトリを作成します
   • git init を使って、プロジェクトディレクトリに新しい Git リポジトリを初期化します
   • git remote add origin <repository-url> を使って、GitHub リポジトリをリモートとして追加します
   • git push -u origin master を使って、変更をリモートリポジトリにプッシュします

設定オプション

appsettings.json ファイルには、次の設定オプションがあります：

• ConnectionStrings:DefaultConnection：SQL Server の接続文字列
• LogPath：ログファイルを保存するディレクトリ
• DebugMode：詳細なデバッグログを有効にするには、"true" に設定します
• AllowWorkspaceOverride：動的なプロジェクト接続の上書きを無効にするには、"false" に設定します（既定値は "true" です）

動的プロジェクト接続リゾルバー

フォルダーやサブプロジェクトごとに異なるデータベースへ接続するマルチプロジェクトのワークスペースでは、メインの設定を常に更新する必要がなくなります：

1. すべてのデータベースツールは、オプションの currentFilePath パラメーターを受け取ります（通常、アクティブなファイルのパスが IDE クライアントによって自動的に設定されます）。
2. サーバーは、ファイルの親フォルダーからディレクトリツリーを上にたどり、最も近い appsettings.json を探します。
3. ファイルが見つかった場合、そのファイルから ConnectionStrings:DefaultConnection を動的に抽出し、クエリの実行に使用します。
4. 設定ファイルが見つからない場合、または AllowWorkspaceOverride が "false" に設定されている場合は、起動時に読み込んだ既定の接続文字列を使用します。

公開

アプリケーションは、自己完結型の実行可能ファイルとして公開できます：

dotnet publish -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true

これにより、すべての依存関係を含む単一の実行可能ファイルが作成されます。

プロトコル

MCP サーバーは、標準の JSON-RPC 2.0 Model Context Protocol を使用し、標準入力／出力を介して通信します。

リクエスト形式（tools/call）

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tool-name",
    "arguments": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}

レスポンス形式

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "JSON-serialized tool output"
      }
    ]
  }
}

エラーの場合：

{
  "jsonrpc": "2.0",
  "id": 1,
  "error": {
    "code": -32602,
    "message": "Error description"
  }
}

対応ツール

1. データベースの一覧表示（get_databases）

システムデータベース以外の、利用可能な SQL Server データベースをすべて一覧表示します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_databases",
    "arguments": {}
  }
}

2. データベース内のテーブルの一覧表示（get_tables）

指定したデータベース内のテーブルとビューをすべて一覧表示します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_tables",
    "arguments": {
      "database": "AdventureWorks",
      "schema": "dbo"
    }
  }
}

3. テーブルのカラムの取得（get_columns）

指定したテーブルのすべてのカラムとカラムのメタデータを一覧表示します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_columns",
    "arguments": {
      "database": "AdventureWorks",
      "schema": "Person",
      "table": "Person"
    }
  }
}

4. ストアドプロシージャの一覧表示（get_procedures）

指定したデータベース内のストアドプロシージャをすべて一覧表示します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_procedures",
    "arguments": {
      "database": "AdventureWorks",
      "schema": "dbo"
    }
  }
}

5. ストアドプロシージャ定義の取得（get_procedure_definition）

ストアドプロシージャの定義を取得します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_procedure_definition",
    "arguments": {
      "database": "AdventureWorks",
      "schema": "dbo",
      "name": "uspGetEmployeeManagers"
    }
  }
}

6. データベースクエリの実行（execute_database_query）

指定したデータベースのコンテキストで SQL クエリを実行します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_database_query",
    "arguments": {
      "database": "AdventureWorks",
      "query": "SELECT TOP 10 * FROM Person.Person"
    }
  }
}

7. システムクエリの実行（execute_system_query）

サーバーインスタンスレベルで SQL クエリを実行します（データベースコンテキストは不要です）。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_system_query",
    "arguments": {
      "query": "SELECT name FROM sys.databases"
    }
  }
}

8. ストアドプロシージャの実行（execute_procedure）

ストアドプロシージャを実行します。

リクエスト：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_procedure",
    "arguments": {
      "database": "AdventureWorks",
      "schema": "dbo",
      "procedure": "uspGetEmployeeManagers",
      "parameters": {
        "BusinessEntityID": 5
      }
    }
  }
}

IDE / クライアントとの統合

この MCP サーバーは、MCP に準拠する任意の IDE やクライアント（Windsurf、Cursor、Cline、Claude Desktop など）から使用でき、次の操作が可能です。

1. データベーススキーマの参照
2. SQL クエリの実行と結果の表示
3. テーブル名と列名のコード補完
4. ストアドプロシージャの実行
5. SQL コードスニペットの生成
6. データベース構造の分析

コード構成

アプリケーションは次のコンポーネントで構成されています。

• Program.cs：メインエントリーポイントとリクエスト処理
• JsonRpcHandler.cs：JSON-RPC プロトコルを処理し、リクエストをディスパッチします
• 設定は appsettings.json から読み込まれます
• ログは LogPath 設定で指定されたファイルに書き込まれます

コントリビューション

コントリビューションを歓迎します。お気軽にプルリクエストを送信してください。

1. リポジトリをフォークします
2. フィーチャーブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m 'Add some amazing feature'）
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します

ライセンス

このプロジェクトは MIT License のもとでライセンスされています。詳細については LICENSE ファイルを参照してください。

エラー処理

一般的なエラーコード：

• invalid_request：JSON の形式が不正、または必須フィールドがありません
• connection_failed：SQL Server への接続に失敗しました
• missing_parameter：必須パラメーターが指定されていません
• query_execution_error：SQL クエリの実行中にエラーが発生しました
• database_not_found：指定されたデータベースが存在しません
• table_not_found：指定されたテーブルが存在しません