Aws Athena MCP

🚀 @lishenxydlgzs/aws-athena-mcp

このモデルは、AWS Athena クエリを実行するためのモデルコンテキストプロトコル（MCP）サーバーです。AI アシスタントが、AWS Athena データベースに対して SQL クエリを実行し、結果を取得できるようになります。

🚀 クイックスタート

📦 インストール

以下のコマンドを使用してインストールします。

npm install --save @lishenxydlgzs/aws-athena-mcp

🔧 設定

環境変数の設定

AWS 認証を有効にするには、以下の環境変数を設定します。

# AWS 認証を有効にする
export AWS_ENABLED=true

# AWS リージョンを設定する
export AWS_REGION=us-east-1  # サンプルリージョン。必要に応じて変更してください

✨ 主な機能

この MCP サーバーは、以下の機能をサポートしています。

• クエリ実行：HTTP リクエストを通じて SQL クエリを実行します。
• 結果保存：クエリ結果を指定された S3 バケットに保存します。
• ステータス確認：実行中または完了したクエリのステータスを確認できます。

💻 使用例

基本的な使用法

例 1: 基本クエリ

リクエストボディ:

{
  "name": "execute_query",
  "arguments": {
    "database": "default",
    "query": "SELECT * FROM my_table LIMIT 5"
  }
}

レスポンスボディ:

{
  "status": "success",
  "data": {
    "queryExecutionId": "1234-5678-90ab-cdef",
    "resultLocation": "s3://my-bucket/results/1234-5678.csv"
  }
}

例 2: ステータス確認

リクエストボディ:

{
  "name": "get_query_status",
  "arguments": {
    "queryExecutionId": "1234-5678-90ab-cdef"
  }
}

レスポンスボディ:

{
  "status": "success",
  "data": {
    "executionStatus": "SUCCEEDED",
    "stateChangeTime": "2023-10-01T00:00:00.000Z"
  }
}

📚 ドキュメント

パラメータの説明

クエリ実行パラメータ

ステータス確認パラメータ

返却結果の形式

すべてのクエリ操作の結果は、JSON 形式で返され、ステータスコード、エラーメッセージ（ある場合）、およびクエリ結果またはステータス詳細が含まれます。

インターフェース設計

この MCP サーバーは、以下の API エンドポイントを提供します。

/api/v1/execute

• メソッド: POST
• 説明: 指定された SQL クエリを実行します。

リクエストボディの例:

{
  "name": "execute_query",
  "arguments": {
    "database": "default",
    "query": "SELECT * FROM users LIMIT 5"
  }
}

レスポンスボディの例:

{
  "status": "success",
  "data": {
    "executionId": "1234-5678-90ab-cdef",
    "message": "Query is being executed."
  }
}

/api/v1/status

• メソッド: GET
• 説明: 指定されたクエリの実行ステータスを確認します。

リクエストパラメータ:

# サンプル curl リクエスト
curl -X GET "http://localhost:3000/api/v1/status?executionId=1234-5678-90ab-cdef"

レスポンスボディの例:

{
  "status": "success",
  "data": {
    "executionStatus": "SUCCEEDED",
    "resultLocation": "s3://my-bucket/results/1234-5678.csv",
    "createTime": "2023-10-01T00:00:00.000Z"
  }
}

⚠️ 重要提示

AWS クレデンシャルには、Athena クエリの実行と S3 バケットへのアクセス権限が必要です。

💡 使用建议

クエリ失敗時に対応するため、適切なエラーハンドリングメカニズムを設定してください。

📄 ライセンス

MIT ライセンス

プロジェクトリポジトリ

GitHub リポジトリ