Aws S3 MCP

🚀 S3 Server User Guide

This guide provides detailed instructions on how to install, configure, and use the S3 server, including its integration with the Claude desktop application.

🚀 Quick Start

📦 Installation

System Requirements

• Operating System: Linux, macOS, Windows
• Memory: At least 512MB RAM
• Disk Space: At least 1GB of available space
• Others: AWS credentials are required

Installation Steps

1. Clone the code repository:

   git clone https://github.com/your-repository.git
   cd s3-server
   

2. Install dependencies:

   npm install
   

⚙️ Configuration

Environment Variable Configuration

Edit the config.json file and add the following content:

{
  "aws": {
    "accessKeyId": "YOUR_ACCESS_KEY_ID",
    "secretAccessKey": "YOUR_SECRET_ACCESS_KEY",
    "region": "your-region"
  },
  "s3": {
    "buckets": ["bucket1", "bucket2"],
    "maxKeys": 100
  }
}

Start the Server

npm start

✨ Features

Tool List

List Buckets (list-buckets)

Function Description: Lists all S3 buckets that the current user has permission to access. The results are based on the S3_BUCKETS environment variable.

Sample Output:

[
  {
    "Name": "my-images-bucket",
    "CreationDate": "2022-03-15T10:30:00.000Z"
  },
  {
    "Name": "my-documents-bucket",
    "CreationDate": "2023-05-20T14:45:00.000Z"
  }
]

List Objects (list-objects)

Function Description: Lists all objects in the specified S3 bucket, supporting filtering by prefix and maximum number.

Parameter Description:

• bucket (Required): The name of the target S3 bucket
• prefix (Optional): The prefix used to filter objects
• maxKeys (Optional): Limits the number of objects returned

Sample Output:

[
  {
    "Key": "sample.pdf",
    "LastModified": "2023-10-10T08:12:15.000Z",
    "Size": 2048576,
    "StorageClass": "STANDARD"
  },
  {
    "Key": "sample.md",
    "LastModified": "2023-10-12T15:30:45.000Z",
    "Size": 1536000,
    "StorageClass": "STANDARD"
  }
]

Get Object (get-object)

Function Description: Retrieves a single object from the specified S3 bucket. Text files are returned as plain text, and binary files are returned with basic information.

Parameter Description:

• bucket (Required): The name of the target S3 bucket
• key (Required): The key of the target object

Sample Output:

Text file:

This is the content of a text file stored in S3.
It could be JSON, TXT, CSV or other text-based formats.

Binary file:

Binary content (image/jpeg): base64 data is /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRof...

🔒 Security Considerations

• The server only accesses the buckets specified in the S3_BUCKETS environment variable.
• AWS credentials must have appropriate permissions.
• It is recommended to configure IAM permissions using the principle of least privilege.
• In a production environment, consider using IAM roles to restrict S3 access.

🔗 Integration with Claude

In the desktop application, users can request to perform the following actions:

• "List all my S3 buckets"
• "Summarize PDF files in my-documents-bucket"
• "Get the README.txt file in my-documents-bucket"

Claude will use the corresponding MCP tools to complete the requests and display the results.

📝 Conclusion

By following the above steps, users can successfully configure and use the S3 server and integrate it with the Claude desktop application. For further assistance, please refer to the official documentation or contact technical support.