使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 LLM 应用提供访问和管理 AWS S3 云存储服务的工具。通过此服务器,LLM 可以安全、便捷地与 S3 存储桶和对象进行交互,实现文件上传、下载、列表查看和删除等操作。

主要功能点

  • 提供列出 S3 存储桶的功能。
  • 支持列出指定存储桶中的对象。
  • 允许从 S3 存储桶获取对象内容。
  • 支持向 S3 存储桶上传对象。
  • 支持上传本地文件到 S3 存储桶。
  • 支持从 S3 存储桶下载文件到本地。
  • 允许从 S3 存储桶删除对象。

安装步骤

  1. 确保已安装 Python 环境。
  2. 克隆或下载此仓库。
  3. 在项目根目录下,运行 'pip install python-dotenv boto3 mcp-server' 安装依赖。
  4. 设置环境变量:
    • 'AWS_ACCESS_KEY_ID': 您的 AWS 访问密钥 ID。
    • 'AWS_SECRET_ACCESS_KEY': 您的 AWS 秘密访问密钥。
    • 'AWS_REGION' (可选): 您的 AWS 区域,默认为 'us-west-1'。

服务器配置

MCP客户端需要配置以下JSON信息以连接到此MCP服务器:

{
  "serverName": "s3",
  "command": "python",
  "args": ["main.py"],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器名称,这里设置为 "s3"。
  • 'command': 启动服务器的命令,这里使用 'python' 解释器。
  • 'args': 启动命令的参数,这里指定运行 'main.py' 文件。
  • 'transport': 传输协议,这里使用标准输入输出流 'stdio'。

基本使用方法

启动 MCP 客户端后,客户端可以通过 JSON-RPC 协议调用服务器提供的工具,例如 'list_buckets'、'list_bucket'、'get_object' 等,来操作 AWS S3 服务。具体的工具调用方法和参数请参考 MCP 客户端的文档。

信息

分类

数据库与文件