Dynamodb MCP Server

🚀 DynamoDB MCP Server Guide

This guide offers a Node.js-based DynamoDB Management Console (MCP) that enables users to perform table management and data operations via commands.

🚀 Quick Start

This guide provides a Node.js-based DynamoDB Management Console (MCP), allowing users to manage tables and manipulate data through commands. Below is a comprehensive list of its features.

✨ Features

• Table Management: Create, list, and describe tables.
• Index Management: Add, remove, and describe Global Secondary Indexes (GSI).
• Capacity Planning: Update read and write capacities and view current capacity information.
• Data Operations: Support basic create, read, update, and delete (CRUD) functions.
• Query and Scan: Retrieve data using conditional filters.
• Tool Support: Equipped with an interactive console and command-line interface.

📚 Documentation

Table Management Commands

1. Create a table

create_table <tableName> <partitionKey> <sortKey> [< gsiDefinitions...>]

2. List all tables

list_tables

3. Describe a specific table

describe_table <tableName>

4. Delete a table

delete_table <tableName>

Index Management Commands

1. Create an index

create_index <tableName> <indexName> <partitionKey> [<sortKeys...>]

2. List all indexes

list_indexes <tableName>

3. Describe a specific index

describe_index <tableName> <indexName>

4. Delete an index

delete_index <tableName> <indexName>

Capacity Planning Commands

1. Update table capacity

update_capacity <tableName> <readCapacity> <writeCapacity>

2. View current capacity

get_capacity <tableName>

3. Get capacity provisioning details

get_throughput <tableName>

Data Operation Commands

1. Insert data

put_item <tableName> <jsonItem>

2. Query a single item

get_item <tableName> <partitionKey> <sortKey>

3. Delete data

delete_item <tableName> <partitionKey> <sortKey>

4. Update data

update_item <tableName> <partitionKey> <sortKey> <expression> <attributeNames...> <attributeValues...>

5. Batch write

batch_write <tableName> <jsonItems...>

6. Batch read

batch_read <tableName> <keys...>

Query and Scan Commands

1. Query a table

query_table <tableName> <partitionKey> [<sortKeys...>]

2. Scan a table

scan_table <tableName> [<filters...>]

Example Questions

Here are some example questions you can ask Claude:

Table Management

• "Create a DynamoDB table named 'Products' with a partition key 'productId' (string) and a sort key 'timestamp' (number)."
• "List all DynamoDB tables in my account."
• "Get the current configuration information for the 'Users' table."
• "Add a Global Secondary Index to the email field on the 'Users' table."

Capacity Planning

• "Update the capacity of the 'Users' table to 20 read units and 15 write units."
• "Increase the capacity of the EmailIndex index on the 'Users' table."
• "Get the current provisioned capacity information for the 'Orders' table."

Data Operations

• "Insert a new user with ID '123', name 'John Doe', and email 'john@example.com'."
• "Get the user with ID '123'."
• "Update the email address of user '123' to 'john.doe@example.com'."
• "Find all orders placed by user '123'."
• "List all users over 21 years old."
• "Query users with the email 'john@example.com' through the EmailIndex index."

Configuration Guide

Setting AWS Credentials

1. Obtain the access key ID, secret access key, and region information from the AWS Management Console.
2. If using temporary credentials (e.g., an IAM role), also obtain the session token.
3. Ensure these credentials have the appropriate permissions to perform DynamoDB operations.

Using Claude Desktop

Add the following content to claude_desktop_config.json:

Docker (Recommended)

{
  "mcpServers": {
    "dynamodb": {
      "command": "docker",
      "image": "amazon/dynamodb-local:latest"
    }
  }
}

Project Addresses

• GitHub: https://github.com/...
• Gitee: https://gitee.com/...

📄 License

This project is licensed under the Apache License 2.0.

⚠️ Important Note

This document is a reference guide for using and understanding the DynamoDB MCP Server.