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 倉庫