Minio Python MCP

🚀 MinIO 模型上下文協議（MCP）

本項目實現了 MinIO 對象存儲的模型上下文協議 (MCP) 服務器與客戶端，為與 MinIO 進行交互提供了標準化的方法。

✨ 主要特性

服務器

資源

服務器藉助 資源 來提供 MinIO 數據，可訪問並提供以下內容：

• 文本文件（依據文件擴展名自動檢測）
• 二進制文件（按 application/octet-stream 處理）
• 每個存儲桶的內容（每個存儲桶最多展示 1000 個對象）

工具

• 列出存儲桶
  • 返回所有由已認證的發送方擁有併發送請求的存儲桶列表。
  • 可選參數：start_after（用於分頁），max_buckets（限制結果數量）。
• 列出對象
  • 返回某個存儲桶中的部分或全部（最多 1000 個）對象，每次請求返回一定數量的對象。
  • 必需參數：bucket_name。
  • 可選參數：prefix（按前綴過濾），max_keys（限制結果數量）。
• 獲取對象
  • 從 MinIO 獲取對象。
  • 必需參數：bucket_name，object_name。
• 上傳對象
  • 運用 fput 方法將文件上傳至 MinIO 存儲桶。
  • 必需參數：bucket_name，object_name，file_path。

客戶端

本項目涵蓋多個客戶端實現：

1. 基本客戶端：用於與 MinIO MCP 服務器進行直接交互的簡易客戶端。
2. Anthropic 客戶端：與 Anthropic 的 Claude 模型集成，提供由 AI 驅動的 MinIO 交互功能。

📦 安裝指南

1. 克隆倉庫：

git clone https://github.com/yourusername/minio-mcp.git
cd minio-mcp

2. 使用 pip 安裝依賴項：

pip install -r requirements.txt

或者使用 uv：

uv pip install -r requirements.txt

💻 使用示例

運行服務器

若要運行 MCP 服務器，請執行以下命令：

python -m minio_mcp_server.main

基本客戶端

基本客戶端提供以下接口：

# 列出存儲桶
list_buckets()
# 列出對象
list_objects(bucket_name, prefix=None, max_keys=1000)
# 獲取對象
get_object(bucket_name, object_name)
# 上傳對象
put_object(bucket_name, object_name, file_path)

Anthropic 客戶端

若要使用 Anthropic 客戶端，需先安裝 Anthropic 庫：

pip install anthropic

然後配置環境變量 ANTHROPIC_API_KEY，並參考 Anthropic 文檔 使用其功能。

📚 詳細文檔

環境配置

在根目錄下創建一個 .env 文件，包含以下配置：

# MinIO 配置
MINIO_ENDPOINT=play.min.io
MINIO_ACCESS_KEY=your_access_key
MINIO_SECRET_KEY=your_secret_key
MINIO_SECURE=true
MINIO_MAX_BUCKETS=5

# 服務器配置
SERVER_HOST=0.0.0.0
SERVER_PORT=8000

# 對於 Anthropic 客戶端（如果使用）
ANTHROPIC_API_KEY=your_api_key

開發

項目結構

minio_mcp/
├── server/
│   ├── main.py          # MCP 服務器主程序
│   └── utils.py        # 輔助函數和工具
├── client/
│   ├── basic_client.py  # 基本客戶端實現
│   └── anthropic_client.py  # Anthropic 客戶端實現
└── config/             # 配置文件和環境變量處理
    └── settings.py     # 應用設置和配置

運行測試

若要運行 MCP 服務器的測試，請執行以下命令：

python -m pytest tests/

代碼格式化

為保持代碼的一致性和可讀性，我們使用以下工具：

• black 格式化代碼
• isort 排列導入語句
• flake8 檢查代碼風格和錯誤

安裝這些工具：

pip install black isort flake8

運行格式化和檢查：

black .
isort .
flake8

調試

由於 MCP 服務器通過標準輸入/輸出運行，調試可能存在一定難度。為獲得最佳的調試體驗，我們建議使用 MCP 檢查器：

npx @modelcontextprotocol/inspector python path/to/minio-mcp/src/minio_mcp_server/server.py

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

📄 許可證

本項目依據 MIT 許可證發佈 - 請查看 LICENSE 文件以獲取詳細信息。