S3 MCP Server

🚀 S3 MCP サーバ

このサーバは、アマゾン S3 ストレージバケットにアクセスするためのモデルコンテキストプロトコル（MCP）サーバです。MCP を通じて S3 ストレージとのシームレスな統合を提供し、ストリーミング機能により PDF ファイルを含む大きなファイルを効率的に処理することができます。

✨ 主な機能

• プレフィックスフィルタ付きの S3 バケットオブジェクトリスト
• ストリーミングによる大きなファイルの効率的な処理
• AWS クレデンシャルの安全な管理
• TypeScript サポート
• カスタムオプション付きの CLI インターフェイス

📦 インストール

npx -y @geunoh/s3-mcp-server

💻 使用例

コマンドラインオプション

npx -y @geunoh/s3-mcp-server [options]

オプション：

• --port, -p：サーバのポート（デフォルト：3000）
• --region, -r：AWS リージョン（デフォルト：ap-northeast-2）
• --bucket, -b：S3 バケット名（デフォルト：my-dancing-bucket）

環境変数

必要な環境変数：

export AWS_ACCESS_KEY_ID="your_access_key"
export AWS_SECRET_ACCESS_KEY="your_secret_key"

オプションの環境変数：

export AWS_REGION="ap-northeast-2"
export S3_BUCKET_NAME="my-bucket-name"

MCP 統合

mcp.json に以下を追加します：

{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "npx",
      "args": ["-y", "@geunoh/s3-mcp-server"],
      "env": {
        "AWS_ACCESS_KEY_ID": "YOUR_AWS_ACCESS_KEY_ID",
        "AWS_SECRET_ACCESS_KEY": "YOUR_AWS_SECRET_ACCESS_KEY",

        // オプション
        "AWS_REGION": "ap-northeast-2",
        "S3_BUCKET_NAME": "my-bucket-name",
      }
    }
  }
}

利用可能な MCP 関数

listObjects

S3 バケット内のオブジェクトをリストします。 パラメータ：

• prefix（オプション）：プレフィックスでオブジェクトをフィルタリング

getObject

S3 バケットからオブジェクトを取得します。ストリーミングにより大きなファイルの処理が最適化されています。 パラメータ：

• key：取得するオブジェクトのキー

戻り値：

• stream：オブジェクト内容の ReadableStream
• contentType：オブジェクトの MIME タイプ
• contentLength：オブジェクトのサイズ（バイト単位）
• lastModified：最終更新タイムスタンプ
• text：元の PDF の ByteArray テキストバッファ

🔧 技術詳細

AWS IAM 権限

必要な最小限の権限（s3-policy.json を参照）：

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket",
                "s3:GetObject"
            ],
            "Resource": "arn:aws:s3:::my-bucket-name"
        }
    ]
}

開発

1. リポジトリをクローンします：

git clone https://github.com/Geun-Oh/s3-mcp-server.git
cd s3-mcp-server

2. 依存関係をインストールします：

npm install

3. プロジェクトをビルドします：

npm run build

4. ローカルで実行します：

node dist/cli.js

プロジェクト構造

.
├── src/              # TypeScript ソースファイル
├── dist/            # コンパイルされた JavaScript ファイルとランタイム依存関係
├── tsconfig.json    # TypeScript 設定
└── package.json     # プロジェクト設定と依存関係

デプロイ

1. 新しいバージョンタグを作成します：

npm version patch

2. npm レジストリに公開します：

npm publish --access public

GitHub Actions ワークフローは、新しいバージョンタグをプッシュすると自動的にパッケージを公開します。

📄 ライセンス

MIT

貢献

貢献する場合は、プロジェクトリポジトリ内の貢献ガイドを参照してください。