aws-s3-mcp

🚀 S3 服务器用户指南

本指南详细介绍了如何安装、配置和使用 S3 服务器，同时涵盖了与 Claude 桌面应用程序集成的相关内容，助力用户高效运用 S3 服务器。

🚀 快速开始

安装说明

系统要求

• 操作系统：Linux、macOS、Windows
• 内存：至少 512MB RAM
• 磁盘空间：至少 1GB 可用空间
• 其他：需要 AWS 凭证

安装步骤

1. 克隆代码仓库：

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

2. 安装依赖项：

   npm install
   

配置指南

环境变量配置

编辑 config.json 文件，添加以下内容：

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

启动服务器

npm start

✨ 主要特性

工具列表

列出桶 (list-buckets)

• 功能说明：列出当前用户有权限访问的所有 S3 桶，结果基于 S3_BUCKETS 环境变量。
• 示例输出：

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

列出对象 (list-objects)

• 功能说明：列出指定 S3 桶中的所有对象，支持前缀和最大数量的过滤。
• 参数说明：
  • bucket（必填）：目标 S3 桶名称
  • prefix（可选）：用于筛选对象的前缀
  • maxKeys（可选）：限制返回的对象数量
• 示例输出：

[
  {
    "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)

• 功能说明：从指定 S3 桶中获取单个对象，文本文件返回为纯文本，二进制文件返回基础信息。
• 参数说明：
  • bucket（必填）：目标 S3 桶名称
  • key（必填）：目标对象的键
• 示例输出：
  • 文本文件：

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

• 二进制文件：

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

与 Claude 的集成

在桌面应用程序中，用户可以请求执行以下操作：

• "列出所有我的 S3 桶"
• "总结 my-documents-bucket 中的 PDF 文件"
• "获取 my-documents-bucket 中的 README.txt 文件"

Claude 将使用相应的 MCP 工具完成请求并展示结果。

🔒 安全注意事项

• 服务器仅访问 S3_BUCKETS 环境变量中指定的桶。
• AWS 凭证必须具有适当的权限。
• 建议使用最小特权原则配置 IAM 权限。
• 生产环境中，请考虑使用 IAM 角色限制 S3 访问。

📚 详细文档

通过以上步骤，用户能够顺利配置和使用 S3 服务器，并实现与 Claude 桌面应用的集成。如需进一步帮助，请参考官方文档或联系技术支持。