Dynamo Readonly MCP

🚀 DynamoDB 讀取-only 控制檯

DynamoDB 讀取-only 控制檯是一個藉助 DynamoDB 消息協議 (MCP) 實現的服務器。它能讓像 Claude 這樣的大語言模型（LLM）通過自然語言查詢來訪問 DynamoDB 數據。用戶只需發送自然語言請求，就能實現對 DynamoDB 表的只讀訪問。

🚀 快速開始

DynamoDB 讀取-only 控制檯允許大語言模型通過自然語言查詢訪問 DynamoDB 數據。以下是使用前的準備步驟：

項目克隆

使用 Git 克隆倉庫：

git clone https://github.com/yourusername/dynamodb-read-only-console.git

環境依賴安裝

進入項目目錄後，安裝所需依賴：

npm install

配置環境變量

創建並編輯 .env 文件：

DYNAMODB_ENDPOINT=your-endpoint
DYNAMODB_REGION=your-region

服務構建與啟動

構建項目：

npm run build

啟動服務器：

npm start

連接到 Claude Desktop

在 clay.json 文件中添加以下配置，使 Claude 能夠連接到您的 MCP 服務：

{
  "mcp": {
    "servers": [
      {
        "url": "http://localhost:3000",
        "options": {
          "keepalive": true,
          "family": 4
        }
      }
    ]
  }
}

✨ 主要特性

表管理工具

• 列出所有表 (list-tables)：返回所有 DynamoDB 表的信息。
• 描述表 (describe-table)：獲取指定表的詳細信息。
• 表存在性檢查 (table-exists)：驗證指定表是否存在。

數據查詢工具

• 基本查詢 (query-table)：通過鍵條件表達式查詢表數據。
• 高級查詢 (advanced-query)：支持複雜的過濾和排序操作。
• 掃描表 (scan-table)：返回表中的所有項，可按條件篩選。

資源管理

• 表信息資源 (dynamodb-tables-info)：提供所有表的元數據。
• 特定表結構 (dynamodb-table-schema)：返回指定表的 schema 信息。
• 索引詳情 (dynamodb-indexes-info)：列出表中的所有索引及其配置。

提示語支持

• 查詢幫助 (dynamodb-query-help)：提供如何編寫有效 DynamoDB 查詢的指導。
• 最佳實踐提示 (best-practices-tip)：推薦高效的數據訪問策略。
• 錯誤恢復提示 (error-recovery-tip)：在出現錯誤時，提供建議的修復步驟。

💻 使用示例

基礎用法

示例1：獲取所有表信息

用戶發送查詢： "顯示所有的 DynamoDB 表" Claude 調用 list-tables 工具，返回結果如下：

[
  {
    "TableName": "Users",
    "TableStatus": "ACTIVE",
    "CreationDateTime": "2023-10-01T12:00:00Z"
  },
  {
    "TableName": "Orders",
    "TableStatus": "ACTIVE",
    "CreationDateTime": "2023-10-02T14:30:00Z"
  }
]

示例2：描述特定表

用戶發送查詢： "告訴我 Users 表的結構" Claude 調用 describe-table 工具，傳遞參數 {tableName: "Users"}，返回結果如下：

{
  "TableName": "Users",
  "TableStatus": "ACTIVE",
  "KeySchema": [
    { "AttributeName": "Username", "KeyType": "HASH" },
    { "AttributeName": "UserId", "KeyType": " RANGE" }
  ],
  "ProvisionedThroughput": {
    "ReadCapacityUnits": 10,
    "WriteCapacityUnits": 5
  }
}

示例3：掃描表數據

用戶發送查詢： "列出 Users 表中所有用戶的用戶名" Claude 調用 scan-table 工具，傳遞過濾條件 { TableName: "Users", Filter: { Username: {"contains": "admin"} } }，返回結果如下：

[
  { "Username": "admin123" },
  { "Username": "superuser" },
  { "Username": "administrator" }
]

📚 詳細文檔

數據流摘要

1. 用戶向 Claude 發送自然語言查詢。
2. Claude 分析請求並選擇合適的 MCP 工具。
3. 調用相應的 DynamoDB 操作（如 query, scan）。
4. 處理返回結果，生成用戶友好的響應。
5. 將結果以結構化或自然語言形式返回給用戶。

📄 許可證

本項目使用 MIT 許可證。請查看 LICENSE 文件獲取詳細信息。