Sample MCP Server S3

🚀 S3 模型上下文協議服務器示例

這是一個用於從 S3 獲取數據（如 PDF 文件）的 MCP 服務器實現，能夠幫助用戶方便地從 AWS S3 中獲取所需數據並加載到 LLM 上下文中。

🚀 快速開始

本項目是一個用於從 S3 獲取數據（如 PDF 文件）的 MCP 服務器實現，下面將為你介紹其主要功能、配置方式、開發流程等內容。

✨ 主要特性

資源

通過 資源 展現 AWS S3 數據（類似於 GET 端點，用於將信息加載到 LLM 的上下文中）。目前僅支持 PDF 文件，且最多顯示 1000 個對象。

工具

• ListBuckets：返回所有由經過身份驗證的請求發送者擁有的桶的列表。
• ListObjectsV2：返回某個桶中的一些或全部（每個請求最多返回 1000）對象。
• GetObject：從 Amazon S3 檢索一個對象。在 GetObject 請求中，需指定該對象的完整鍵名。支持通用存儲桶，同時支持虛擬主機樣式請求和路徑樣式請求。

📦 安裝指南

設置 AWS 憑證

1. 通過 AWS 管理控制檯獲取 AWS 訪問密鑰 ID、秘密訪問密鑰和區域，使用 默認 配置文件配置憑證文件，如 這裡 所示。
2. 確保這些憑證具有適當的權限以讀取/寫入 S3。

與 Claude Desktop 使用

Windows 和 MacOS

• 在 MacOS 上：~/Library/Application\ 支持/Claude/claude_desktop_config.json
• 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json%

{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/user/generative_ai/model_context_protocol/s3-mcp-server",
        "run",
        "s3-mcp-server"
      ]
    }
  }
}

{
  "mcpServers": {
    "s3-mcp-server": {
      "command": "uvx",
      "args": [
        "s3-mcp-server"
      ]
    }
  }
}

💻 使用示例

基礎用法

以下是構建和發佈項目的基礎命令：

# 同步依賴項並更新鎖定文件
uv sync
# 構建發行版本
uv build
# 發佈到 PyPI
uv publish

高級用法

調試

由於 MCP 服務器通過標準輸入輸出運行，調試可能具有挑戰性。為了獲得最佳的調試體驗，我們強烈推薦使用 MCP 檢查器。 你可以通過 npm 執行以下命令啟動 MCP 檢查器：

npx @modelcontextprotocol/inspector uv --directory /Users/user/generative_ai/model_context_protocol/s3-mcp-server run s3-mcp-server

啟動後，檢查器會顯示一個 URL，你可以在瀏覽器中訪問該 URL 開始調試。

📚 詳細文檔

構建和發佈

為了準備分發包，需要按以下步驟操作：

1. 同步依賴項並更新鎖定文件：

uv sync

2. 構建發行版本：

uv build

這將在 dist/ 目錄中創建源代碼和輪發行。 3. 發佈到 PyPI：

uv publish

注意：你需要通過環境變量或命令行參數設置 PyPI 憑證：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或者用戶名/密碼：--username / UV_PUBLISH_USERNAME 和 --password / UV_PUBLISH_PASSWORD

🔧 技術細節

本項目主要實現了從 AWS S3 獲取數據的功能，通過特定的工具和資源展示數據。在配置方面，需要設置 AWS 憑證以確保能夠正常訪問 S3 服務。在開發過程中，使用特定的命令進行構建、發佈和調試，以保證項目的正常運行。

📄 許可證

MIT License

保留所有權利。請查看完整的許可信息。

🔒 安全說明

有關更多信息，請參閱 CONTRIBUTING