MCP Server Redshift

🚀 Redshift用MCPサーバー

Amazon Redshift用のモデルコンテキストプロトコル（MCP）サーバーの実装です。AIモデルを通じてRedshiftデータベースとの相互作用を行うための標準インターフェースを提供します。

✨ 主な機能

• 複数のスキーマ内のテーブル、ビュー、およびマテリアライズドビューを一覧表示
• 複数のテーブルの詳細なスキーマ情報を取得
• Redshiftに対する読み取り専用のSQLクエリを実行
• stdioおよびSSE（サーバー送信イベント）によるデータ転送をサポート
• 型安全なTypeScriptによる実装

📦 インストール

前提条件

• Node.js 18以上
• Redshiftデータベースへのアクセス権
• 環境変数の設定（設定のセクションを参照）

インストール手順

1. リポジトリをクローンします：

   git clone https://github.com/yourusername/mcp-server-redshift.git
   cd mcp-server-redshift
   

2. 依存関係をインストールします：

   npm install
   

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

   npm run build
   

📚 ドキュメント

設定

ルートディレクトリに.envファイルを作成し、以下の変数を含めます。

# Redshift接続設定
REDSHIFT_HOST=your-redshift-host
REDSHIFT_PORT=5439
REDSHIFT_DATABASE=your-database
REDSHIFT_USER=your-username
REDSHIFT_PASSWORD=your-password
REDSHIFT_SCHEMAS=public,schema1,schema2  # カンマ区切りのスキーマリスト

# サーバー設定
TRANSPORT_TYPE=stdio  # または 'sse' でサーバー送信イベントを使用
PORT=3000  # TRANSPORT_TYPE=sseの場合のみ使用

使用方法

サーバーの起動

# 開発環境
npm run dev

# 本番環境
npm run build
npm start

利用可能なツール

1. テーブルの一覧表示 (list_tables)
   • 指定したスキーマ内のすべてのテーブル、ビュー、およびマテリアライズドビューを一覧表示します。
   • オプションのschemasパラメータを使用して特定のスキーマでフィルタリングできます。

   {
     "schemas": ["public", "analytics"]
   }
   

2. テーブルスキーマの取得 (get_tables_schema)
   • 複数の異なるスキーマ内のテーブルのスキーマ情報を取得します。

   {
     "tables": [
       { "schema": "public", "table": "users" },
       { "schema": "analytics", "table": "events" }
     ]
   }
   

3. クエリの実行 (query)
   • データベースに対する読み取り専用のSQLクエリを実行します。

   {
     "sql": "SELECT * FROM public.users LIMIT 5"
   }
   

テスト

テストスイートを実行するには、以下のコマンドを実行します。

npm test

アーキテクチャ

プロジェクトは以下の構造で組織されています。

src/
├── config/         # 設定とデータベース設定
├── tools/          # 各ツールの実装
├── server/         # サーバー設定と転送設定
└── index.ts        # エントリーファイル

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

• すべてのクエリは読み取り専用トランザクションで実行されます。
• 環境変数は適切に保護する必要があります。
• SSE転送ではCORSが有効になっています（本番環境では設定が必要）。
• データベースの資格情報は安全に管理する必要があります。

コントリビュートガイド

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

📄 ライセンス

このプロジェクトはMIT Licenseの下で公開されています。

謝辞

このプロジェクトはPostgreSQL MCPサーバーをベースにしています。元の作者に感謝いたします。