Redshift Js MCP Server

🚀 アマゾン Redshift MCP サーバー（TypeScript）

このプロジェクトは、Amazon Redshift 用に実装された Model Context Protocol (MCP) サーバーで、TypeScript を使用して開発されています。このサーバーは Anthropic の実装パターンに沿っており、Cursor IDE やその他の MCP 互換クライアントに豊富なデータベースコンテキスト情報を提供します。これにより、大規模言語モデル (LLMs) がデータベーススキーマを参照し、読み取り専用のクエリを実行できるようになります。

🚀 クイックスタート

🔌 MCP クライアントとの統合

🔧 プロジェクト固有の設定

プロジェクトディレクトリ内に .cursor/mcp.json ファイルを作成します。

{
  "mcpServers": {
    "redshift-mcp": {
      "command": "node",
      "args": ["src/index.ts"],
      "env": {
        "DATABASE_URL": "redshift://user:password@host:port/database"
      }
    }
  }
}

🌐 グローバル設定

グローバルディレクトリに .cursor/mcp.json を作成します。

{
  "mcpServers": {
    "redshift-mcp": {
      "command": "node",
      "args": ["src/index.ts"],
      "env": {
        "DATABASE_URL": "redshift://user:password@host:port/database"
      }
    }
  }
}

📦 インストールとビルド

以下のコマンドを使用して依存関係をインストールし、プロジェクトをビルドします。

npm install
npm run build

開発環境では、以下のコマンドを使用して TypeScript ファイルを直接実行できます。

npm run dev

✨ 主な機能

⚙️ ツールの実装

1. クエリ実行 (query)：

   • 任意の SQL クエリを実行し、結果を返します。
   • 結合、集計などの複雑なクエリ操作をサポートします。

2. テーブル構造の説明 (describe_table)：

   • 指定されたテーブルの列情報（データ型や制約を含む）を返します。
   • 例：DESCRIBE customers

3. テーブル検索 (find_tables)：

   • キーワードまたはパターンに基づいてテーブルを検索します。
   • 曖昧検索と正規表現をサポートします。

4. サンプルデータ (sample_data)：

   • 指定されたテーブルのサンプルデータ行を返し、ユーザーがデータ内容を理解しやすくします。
   • 自動的にメールアドレスや電話番号などの機密情報を非表示にします。

📋 リソース定義

• スキーマ一覧：データベース内のすべてのスキーマをリストします。
• テーブルスキーマ：特定のテーブルの詳細なスキーマ情報を返します。
• サンプルデータ：指定されたテーブルのサンプルデータ行を提供します。

🔧 技術詳細

📁 プロジェクト構造

• src/index.ts：プロジェクトのメインエントリーファイルで、サーバーの起動とリクエストの処理を担当します。
• tsconfig.json：TypeScript の設定ファイルです。
• package.json：プロジェクトの依存関係とスクリプトの定義が記載されています。

⚠️ セキュリティに関する注意事項

1. 入力サニタイズ：SQL インジェクションやその他の悪意のあるリクエストを防止します。
2. 機密データの非表示：サンプルデータ内のメールアドレスや電話番号などの機密情報を非表示にします。
3. SSL 接続：SSL を使用してデータベースとの通信を安全にします。

💻 使用例

以下は、Cursor でユーザーが投げかけることができるサンプルの質問です。

1. "パブリックスキーマ内のすべてのテーブルを表示してください"
2. "customers テーブルの構造はどうなっていますか？"
3. "顧客情報を含むすべてのテーブルを検索してください"
4. "州ごとに注文数を集計するクエリを作成してください"
5. "products テーブルのサンプルデータを表示してください"

🚀 拡張と開発

⚙️ 機能拡張

1. 新しいリソースタイプの追加：新しいリソースタイプを定義し、その処理ロジックを実装します。
2. カスタムツールの追加：高度なクエリ分析やデータエクスポートなど、より多くの機能を追加します。
3. セキュリティの強化：認証とアクセス制御メカニズムを実装します。

💡 使用提言

• 環境変数を使用して機密情報を管理し、ハードコーディングを避けます。
• ログ記録と監視ツールを使用して、サーバーの状態とリクエストを追跡します。
• 定期的に依存関係をテストして更新し、システムのセキュリティと安定性を確保します。