S3 MCP Server

S3 MCP Server

site icon
2025.03.26 0
TypeScriptS3 存储管理大文件处理文件管理
S3 MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,用于访问 Amazon S3 存储桶。该服务器通过 MCP 提供与 S3 存储的无缝集成,支持高效处理大文件(包括 PDF 文件)的流式传输。
View on GitHub

Overview

基本能力

产品定位

S3 MCP Server 是一个用于访问和管理 Amazon S3 存储桶的工具,特别适合需要高效处理大文件的场景。

核心功能

  • S3 存储桶对象列表:支持通过前缀过滤对象。
  • 大文件流式处理:高效处理大文件,支持流式传输。
  • AWS 凭证管理:提供安全的 AWS 凭证管理功能。
  • TypeScript 支持:完全支持 TypeScript。
  • CLI 接口:提供可自定义选项的命令行接口。

适用场景

  • 需要从 S3 存储桶中高效读取和管理大文件的场景。
  • 需要流式传输大文件(如 PDF 文件)的应用。
  • 需要与 S3 存储桶集成的开发项目。

工具列表

  • listObjects:列出 S3 存储桶中的对象,支持前缀过滤。
  • getObject:从 S3 存储桶中检索对象,支持流式传输。

常见问题解答

  • AWS 凭证管理:必须设置 AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY 环境变量。
  • IAM 权限:需要配置 s3:ListBuckets3:GetObject 权限。

使用教程

使用依赖

  • 安装 Node.js 和 npm。
  • 设置 AWS 凭证环境变量: bash export AWS_ACCESS_KEY_ID="your_access_key" export AWS_SECRET_ACCESS_KEY="your_secret_key"

安装教程

  1. 通过 npm 安装: bash npx -y @geunoh/s3-mcp-server
  2. 可选环境变量: bash export AWS_REGION="ap-northeast-2" export S3_BUCKET_NAME="my-bucket-name"

调试方式

  1. 克隆仓库: bash git clone https://github.com/Geun-Oh/s3-mcp-server.git cd s3-mcp-server
  2. 安装依赖: bash npm install
  3. 构建项目: bash npm run build
  4. 本地运行: bash node dist/cli.js

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。